attacca
Agents

Get an agent

GET
/v1/agents/{agent_id}

Authorization

api_key agents:read
AuthorizationBearer <token>

An atk_-prefixed API key, created under Settings → API keys.

In: header

Scope: agents:read

Path Parameters

agent_id*string

Agent id

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "can_manage_agents": true,  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "model": "string",  "name": "string",  "owner_user_id": "65139110-7c3c-4777-b692-80c218be3b9d",  "prompt_ids": [    "string"  ],  "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",  "supports_image": true,  "temperature": 0,  "tool_plugin_ids": [    "string"  ],  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

Create an agent POST

`provider_id` names the endpoint the model is served from. There is no public providers endpoint — providers hold BYOK credentials and are managed only from the web app — so copy the `provider_id` off any agent from `GET /v1/agents`. A provider the account cannot see is rejected, which is what stops an agent from being pointed at another account's credentials.

Update an agent PATCH

Only agents this account owns can be edited; a globally shared agent is read-only here.