AI agents for websites that sell, convert and handle support

GET /api/v1/agents/{agentId}

Get agent

Returns an agent configured for a company. Instructions are never included in responses.

Parameters

Name	In	Type	Description
`agentId` *	path	integer	Internal agent id.

Responses

Status	Schema	Description
`200`	PublicAgent \| null	Agent configured for the company
`401`	AgentError	Missing or invalid auth
`403`	AgentError	Caller cannot access this agent

Example 200 response

{
    "id": 1,
    "identifier": "string",
    "name": "string"
}

Example 401 response

{
    "error": "string",
    "message": "string",
    "issues": [
        {
            "path": [
                "string"
            ],
            "message": "string",
            "code": "string"
        }
    ]
}

Example 403 response

{
    "error": "string",
    "message": "string",
    "issues": [
        {
            "path": [
                "string"
            ],
            "message": "string",
            "code": "string"
        }
    ]
}