Skip to content
CantoraAPI documentation
GET
/v1/organizations/{organizationId}/projects/{projectId}/agent-definitions/{agentDefinitionId}/versions/{agentVersionId}

Read one immutable Agent Version

Return one immutable Agent Version, including its manifest, digest, revision, and source provenance.

Authentication

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

Parameters

NameLocationRequiredDescription
organizationIdpathYes
The Organization to address.
string
All of
  • maximum length 64
A Cantora Organization identifier, prefixed with `org_`.
  • pattern ^org_[\s\S]+$
projectIdpathYes
The Project to address.
string
All of
  • maximum length 64
A Cantora Project identifier, prefixed with `proj_`.
  • pattern ^proj_[\s\S]+$
agentDefinitionIdpathYes
The Agent Definition to address.
string
All of
  • maximum length 64
A Cantora Agent Definition identifier, prefixed with `agentdef_`.
  • pattern ^agentdef_[\s\S]+$
agentVersionIdpathYes
The immutable Agent Version to address.
string
All of
  • maximum length 64
A Cantora Agent Version identifier, prefixed with `agent_version_`.
  • pattern ^agent_version_[\s\S]+$

Responses

200AgentVersion
application/json
AgentVersionJsonEncoding
400The request path, headers, query, or JSON body did not satisfy the published schema
401Unauthorized
application/json
UnauthorizedJsonEncoding
403Forbidden
application/json
ForbiddenJsonEncoding
404NotFound
application/json
NotFoundJsonEncoding

Reusable schemas

AgentVersionJsonEncoding

object
  • unknown properties allowed false
agentVersionIdrequired
stringThe immutable Agent Version identifier.
All of
  • maximum length 64
A Cantora Agent Version identifier, prefixed with `agent_version_`.
  • pattern ^agent_version_[\s\S]+$
organizationIdrequired
stringThe Organization identifier.
All of
  • maximum length 64
A Cantora Organization identifier, prefixed with `org_`.
  • pattern ^org_[\s\S]+$
projectIdrequired
stringThe Project identifier.
All of
  • maximum length 64
A Cantora Project identifier, prefixed with `proj_`.
  • pattern ^proj_[\s\S]+$
agentDefinitionIdrequired
stringThe Agent Definition identifier.
All of
  • maximum length 64
A Cantora Agent Definition identifier, prefixed with `agentdef_`.
  • pattern ^agentdef_[\s\S]+$
revisionrequired
integerThe monotonically increasing revision within the Agent Definition.
All of
  • greater than 0
manifestrequired
AgentVersionManifestThe complete immutable Agent behavior and execution-budget declaration.
manifestDigestrequired
stringThe lowercase SHA-256 digest of the normalized manifest.
  • maximum length 64
  • minimum length 64
  • pattern ^[0-9a-f]{64}$
createdByPrincipalIdrequired
stringThe Principal that created this immutable record.
All of
  • maximum length 64
A Cantora Principal identifier, prefixed with `principal_`.
  • pattern ^principal_[\s\S]+$
sourcerequired
AgentVersionSourceThe source revision and automation provenance.
createdAtrequired
stringWhen the resource was created, in UTC.
  • format date-time

UnauthorizedJsonEncoding

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Unauthorized"
reasonrequired
stringA safe explanation of why the credential was rejected.

ForbiddenJsonEncoding

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Forbidden"
permissionrequired
stringThe permission required by the refused operation.

NotFoundJsonEncoding

object
  • unknown properties allowed false
_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.

AgentVersionManifest

object
  • unknown properties allowed false
schemaVersionrequired
stringThe Agent Version manifest schema identifier.
  • allowed values "config.cantora.ai/agent-version/v1alpha2"
instructionsrequired
stringThe complete natural-language instructions for the Agent Version.
All of
  • maximum length 262144
modelrequired
AgentVersionModelThe exact provider model and behavior settings pinned by the Agent Version.
toolsrequired
AgentVersionDependenciesThe tool keys the Agent Version may call.
requiredBindingsrequired
AgentVersionDependenciesThe configuration bindings the Agent Version requires at runtime.
budgetsrequired
AgentVersionBudgetsThe finite execution limits enforced for the Agent Version.

AgentVersionSource

object
  • unknown properties allowed false
repositoryrequired
stringThe source repository identifier.
All of
  • minimum length 1
  • maximum length 500
commitrequired
stringThe immutable source revision.
All of
  • minimum length 1
  • maximum length 500
pathrequired
stringThe path within the source repository.
All of
  • minimum length 1
  • maximum length 500
workflowrequired
stringThe source automation workflow identifier.
All of
  • minimum length 1
  • maximum length 500
runrequired
stringThe source automation run identifier.
All of
  • minimum length 1
  • maximum length 500

AgentVersionModel

Any of
object
  • unknown properties allowed false
providerrequired
stringThe model or Surface provider key.
  • allowed values "googleVertex"
modelrequired
stringThe exact provider model and behavior settings pinned by the Agent Version.
All of
  • minimum length 1
  • maximum length 256
settingsrequired
GoogleVertexModelSettingsThe provider-native settings that change model behavior.
object
  • unknown properties allowed false
providerrequired
stringThe model or Surface provider key.
  • allowed values "openai"
modelrequired
stringThe exact provider model and behavior settings pinned by the Agent Version.
All of
  • minimum length 1
  • maximum length 256
settingsrequired
OpenAiModelSettingsThe provider-native settings that change model behavior.

AgentVersionDependencies

array
Items
string
All of
  • minimum length 1
  • maximum length 100
  • pattern ^[a-z][a-z0-9_]*$
All of
  • at most items 100
  • unique items true

AgentVersionBudgets

object
  • unknown properties allowed false
maxModelStepsrequired
integerThe maximum number of model calls in one Run.
All of
  • maximum 100
  • minimum 1
maxToolCallsrequired
integerThe maximum number of tool calls in one Run.
All of
  • maximum 100
  • minimum 0
totalWallTimeMsrequired
integerThe maximum total Run duration in milliseconds.
All of
  • maximum 300000
  • minimum 1000
modelStepTimeMsrequired
integerThe maximum duration of one model step in milliseconds.
All of
  • maximum 300000
  • minimum 1000
streamStallTimeMsrequired
integerThe maximum duration without stream progress in milliseconds.
All of
  • maximum 300000
  • minimum 1000
maxInputTokensrequired
integerThe maximum number of model input tokens.
All of
  • maximum 10000000
  • minimum 1
maxOutputTokensrequired
integerThe maximum number of model output tokens.
All of
  • maximum 1000000
  • minimum 1
maxReasoningTokensrequired
integerThe maximum number of model reasoning tokens.
All of
  • maximum 1000000
  • minimum 0
maxTotalTokensrequired
integerThe maximum total model tokens in one Run.
All of
  • maximum 10000000
  • minimum 1
maxToolResultBytesrequired
integerThe maximum aggregate tool-result size in bytes.
All of
  • maximum 10000000
  • minimum 1
maxEstimatedCostMicrosrequired
integerThe maximum estimated model cost in millionths of the billing currency.
All of
  • maximum 1000000000
  • minimum 1

GoogleVertexModelSettings

object
  • unknown properties allowed false
thinkingLevelrequired
stringThe Google Vertex-native thinking level.
  • allowed values "minimal", "low", "medium", "high"

OpenAiModelSettings

object
  • unknown properties allowed false
reasoningEffortrequired
stringThe OpenAI-native reasoning effort.
  • allowed values "none", "low", "medium", "high", "xhigh", "max"
reasoningModerequired
stringThe OpenAI-native reasoning mode.
  • allowed values "standard", "pro"