Get the prompt of an agent

Retrieves the current prompt configured for an agent. The agent must belong to the same company as the API key used for authentication.

GET /Agent/{agentId}/prompt

Get the prompt of an agent

cURL

curl --request GET \
  --url https://api.starleads.co/Agent/{agentId}/prompt \
  --header 'X-Api-Key: <api-key>'

200

{
  "agentId": "64a1b2c3d4e5f6a7b8c9d0e1",
  "agentName": "My Sales Agent",
  "prompt": "You are a friendly sales assistant..."
}

Authorizations

X-Api-Key · string · header · required

Headers

X-Api-Key · string · required

Api key to pass as a X-Api-Key request header.

Path Parameters

agentId · string · required

ID of the agent.

Response

200

application/json

Success

agentId · string

ID of the agent

agentName · string

Name of the agent

prompt · string

The current prompt text of the agent