API Reference / agent-controller

Get one agent

get https://api.intelig.ai/api/v1/intelig/agents/{name}

Auth: Authorization: ApiKey <key> (an API key sent as Bearer is rejected) or Authorization: Bearer <jwt> for a dashboard session. operationId: getAgent

The agent's activation, schedule, configuration document and recent run history. Read this before PATCHing its config — a config write replaces the stored document rather than merging into it. Requires the `agent:read` scope.

Example request

curl -X GET "https://api.intelig.ai/api/v1/intelig/agents/string" \
  -H "Authorization: ApiKey $INTELIG_API_KEY"

Path parameters

NameTypeRequiredDescription
name string yes

Response 200

application/json · ApiResponseAgentDetailResponse

FieldTypeDescription
success boolean
message string
data AgentDetailResponse

Status codes

  • 200 — OK
  • 401 — —
  • 404 — Not Found
  • 429 — —

Every response is wrapped in { success, message, data }. A 4xx means the request is wrong — do not retry it unchanged. A 429 carries Retry-After in seconds.