APIAgents

Get agent

Get an agent instance by ID.

GET
/agent-instances/{agent_instance_id}

Get an agent instance by ID.

Authorization

ApiKeyAuth
headerAuthorizationBearer <token>

Bearer token authentication. Send an API key (a saai_api_-prefixed token) as Authorization: Bearer <token>.

Required permission

view_agent_instances

Path Parameters

agent_instance_id*string
Formatuuid

Response Body

The request has succeeded.

application/json
  1. response

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.

id*string
Formatuuid
user_id?string
Formatuuid
user_display_name*string

Display name of the owning user.

display_name*string

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

Length1 <= length <= 255
metadata?

Connection details reported by the client the last time it connected.

created_at*string

When the instance was first registered.

Formatdate-time
updated_at*string
Formatdate-time
last_used_at?string

When the instance last connected to the gateway; absent if it never has.

Formatdate-time
revoked_at?string

When this instance's access was revoked; absent while it remains active.

Formatdate-time
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.

external_id?string

Identifier assigned by the client's own system, when it supplies one.

token_endpoint_auth_method?string
is_dcr_managed?boolean
curl -X GET "https://example.com/agent-instances/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "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}