Documentation menu
Agents

Get agent content

GET /api/v1/agents/{coordinator}

Get agent content by canonical key. Public reads use the current published revision; authenticated execution reads use the revision captured when execution started.

Path Format

  • /api/v1/agents/:coordinator — coordinator agent

Access

Project Agent reads require an exact Agent and Environment coordinate in the authenticated organization. System Agent reads resolve the active publication by slug and require no Environment selector.

Parameters

path

NameTypeRequiredDescription
coordinatorstringrequiredIdentifies the coordinator agent by its canonical name. Applies to Get agent content.

query

NameTypeRequiredDescription
agentIdstringoptionalSelects the Project Agent by its stable identifier. Applies to Get agent content.
environmentIdstringoptionalSelects the active Project environment coordinate. Applies to Get agent content.
organizationIdstringoptionalSelects the authorization organization for a legacy System Agent. Required for sessions without Project Agent coordinates. Omit when addressing a Project Agent.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)