Get Agent

Gets a specific agent by its ID for the specified location with all its versions. Returns complete agent metadata and all non-deleted versions (draft, staging, production). locationId is required parameter. The agent must have active status.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:agent-studio.readonly

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Path Parameters

agentIdstringrequired

Agent ID to retrieve (returns metadata and all non-deleted versions)

Example:p1q2r3s4t5u6v7w8x9y0z1a2

Query Parameters

locationIdstringrequired

Location (sub-account) ID that owns the agent

Example:C2QujeCh8ZnC7al2InWR

sourcestring

Origin channel attributed to this read for auditing (e.g. public_api, internal)

Example:api

Response

200

application/json

Agent retrieved successfully

successbooleanrequired

Success status

Example:true

messagestringrequired

Response message

Example:Agent retrieved successfully

agentobjectrequired

Agent metadata with all active versions

traceIdstring

Request trace ID for debugging

Example:22dbda99-13d3-4b4d-a30e-c468334e2178