GET

/v1/organizations/{organizationId}/projects/{projectId}/agent-definitions/{agentDefinitionId}

Read one Agent Definition

Return one Agent Definition from the Project scope named in the path.

Authentication

Send an API key as a Bearer token in the Authorization header.

Name	Location	Required	Description
`organizationId`	path	Yes	The Organization to address. `string`A Cantora Organization identifier, prefixed with `org_`. maximum length `64` pattern `^org_[\s\S]+$`
`projectId`	path	Yes	The Project to address. `string`A Cantora Project identifier, prefixed with `proj_`. maximum length `64` pattern `^proj_[\s\S]+$`
`agentDefinitionId`	path	Yes	The Agent Definition to address. `string`A Cantora Agent Definition identifier, prefixed with `agentdef_`. maximum length `64` pattern `^agentdef_[\s\S]+$`

200AgentDefinition

application/json

400The request path, headers, query, or JSON body did not satisfy the published schema

401Unauthorized

application/json

403Forbidden

application/json

404NotFound

application/json

object

agentDefinitionIdrequired: stringThe Agent Definition identifier.
maximum length 64
pattern ^agentdef_[\s\S]+$
organizationIdrequired: stringThe Organization identifier.
maximum length 64
pattern ^org_[\s\S]+$
projectIdrequired: stringThe Project identifier.
maximum length 64
pattern ^proj_[\s\S]+$
keyrequired: stringThe stable, human-authored Agent Definition key.
displayNamerequired: stringThe human-readable resource name.
statusrequired: AgentDefinitionStatusThe current lifecycle status.
createdAtrequired: stringWhen the resource was created, in UTC.
format date-time

object

_tagrequired: stringThe stable machine-readable error type.
allowed values "Unauthorized"
reasonrequired: stringA safe explanation of why the credential was rejected.

object

_tagrequired: stringThe stable machine-readable error type.
allowed values "Forbidden"
permissionrequired: stringThe permission required by the refused operation.

object

_tagrequired: stringThe stable machine-readable error type.
allowed values "NotFound"
resourcerequired: stringThe resource type relevant to the error.
idrequired: stringThe identifier supplied for the resource that was not found.

string