Create agent

Create a new agent instance. Returns the instance with a plain API token, or OAuth client credentials if `auth.type` is `oauth`.

POST/agent-instances

Create a new agent instance. Returns the instance with a plain API token, or OAuth client credentials if auth.type is oauth.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

One connected client of an agent, registered to the user who authorized it. A policy scoped to the agent applies to every instance; one scoped to an instance applies to that connection alone.

display_name*string

Human-readable name for this connection, shown in the instance list.

Length1 <= length <= 255

agent_slug?string

Which agent this is an instance of, for example claude-code or cursor. May be set on create to label the agent; otherwise the gateway identifies it from the connecting client.

auth?|

How a created agent instance authenticates to the gateway; tagged by type.

Response Body

`application/json`

curl -X POST "https://example.com/agent-instances" \  -H "Content-Type: application/json" \  -d '{    "display_name": "string"  }'

{  "id": null,  "user_id": null,  "user_display_name": "string",  "display_name": "string",  "metadata": {    "client_name": "string",    "client_version": "string",    "protocol_version": "string",    "user_agent": "string",    "ip_address": "string"  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "last_used_at": "2019-08-24T14:15:22Z",  "revoked_at": "2019-08-24T14:15:22Z",  "agent_slug": "string",  "external_id": "string",  "token_endpoint_auth_method": "string",  "is_dcr_managed": true,  "credentials": {    "type": "api_key",    "token": "string"  }}

Create agent

Request Body

Response Body

201application/json

defaultapplication/json

`application/json`

`application/json`