The identity and technical contract details declared by the specification.
BetaManagedAgentsScheduleParams
object
A recurring schedule. Discriminated union — only cron is supported currently.
BetaManagedAgentsDeploymentPausedReason
object
Why a deployment is paused. Non-null exactly when status is paused.
BetaManagedAgentsSessionResourceConfig
object
A configured session resource. Echoes the input minus write-only credentials.
BetaManagedAgentsErrorDeploymentPausedReason
object
A scheduled fire recorded a failed run whose error auto-pauses the deployment.
2 properties
2 required
BetaManagedAgentsDeploymentPausedReasonError
object
The error that triggered an auto-pause. Matches the failed run's error.type.
BetaManagedAgentsAgentReference
object
A resolved agent reference with a concrete version.
3 properties
3 required
BetaManagedAgentsRubric
Rubric for grading the quality of an outcome.
BetaManagedAgentsUserMessageEventParams
object
Parameters for sending a user message to the session.
2 properties
2 required
BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError
object
The deployment's environment was archived.
1 property
1 required
BetaManagedAgentsDocumentBlock
object
Document content, either specified directly as base64 data, as text, or as a reference via a URL.
4 properties
2 required
BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError
object
The deployment configures resources, but its environment is self-hosted and cannot mount them.
1 property
1 required
BetaManagedAgentsURLImageSource
object
Image referenced by URL.
2 properties
2 required
BetaManagedAgentsBudget
object
An enforced spend ceiling on a session. Discriminated on type; limit is the only kind currently supported.
BetaManagedAgentsManualDeploymentPausedReason
object
The caller invoked the pause endpoint on the deployment.
1 property
1 required
BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError
object
A vault referenced by the deployment no longer exists.
1 property
1 required
BetaManagedAgentsAgentArchivedDeploymentPausedReasonError
object
The deployment's agent was archived.
1 property
1 required
BetaManagedAgentsCronSchedule
object
5-field POSIX cron schedule with computed runtime timestamps.
5 properties
3 required
BetaManagedAgentsDeploymentInitialEvent
object
An event sent to a session immediately after it is created. Supports user.message, user.defineoutcome, and system.message.
BetaManagedAgentsFileNotFoundDeploymentPausedReasonError
object
A file resource referenced by the deployment no longer exists.
1 property
1 required
BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError
object
The deployment's organization is disabled.
1 property
1 required
BetaManagedAgentsFileDocumentSource
object
Document referenced by file ID.
2 properties
2 required
BetaManagedAgentsFileRubricParams
object
Rubric referenced by a file uploaded via the Files API.
2 properties
2 required
BetaManagedAgentsCronScheduleParams
object
5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
3 properties
3 required
BetaManagedAgentsUserContentBlock
object
Content block in a user message. Can be text, image, or document.
BetaGatewayTimeoutError
object
2 properties
2 required
BetaManagedAgentsFileResourceConfig
object
A file mounted into each session's container.
3 properties
2 required
BetaManagedAgentsVaultArchivedDeploymentPausedReasonError
object
A vault referenced by the deployment is archived.
1 property
1 required
BetaManagedAgentsDeploymentUserMessageEvent
object
A user message sent to the session.
2 properties
2 required
BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError
object
A memory store referenced by the deployment is archived.
1 property
1 required
BetaManagedAgentsCreateDeploymentParams
object
Request parameters for creating a deployment.
10 properties
4 required
BetaManagedAgentsBranchCheckout
object
2 properties
2 required
BetaManagedAgentsBase64DocumentSource
object
Base64-encoded document data.
3 properties
3 required
BetaManagedAgentsGitHubRepositoryResourceParams
object
Mount a GitHub repository into the session's container.
5 properties
3 required
BetaManagedAgentsDeploymentUserDefineOutcomeEvent
object
An outcome the agent should work toward. The agent begins work on receipt.
4 properties
3 required
BetaManagedAgentsAgentParams
object
Specification for an Agent. Provide a specific version or use the short-form agent="agentid" for the most recent version
3 properties
2 required
BetaManagedAgentsMemoryStoreResourceConfig
object
A memory store attached to each session created from this deployment.
4 properties
2 required
BetaManagedAgentsFileResourceParams
object
Mount a file uploaded via the Files API into the session.
3 properties
2 required
BetaAPIError
object
2 properties
2 required
BetaManagedAgentsDeployment
object
A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events…
17 properties
16 required
BetaManagedAgentsSessionResourceParams
object
Union of resources that can be mounted into a session.
BetaRateLimitError
object
2 properties
2 required
BetaManagedAgentsURLDocumentSource
object
Document referenced by URL.
2 properties
2 required
BetaManagedAgentsSystemMessageEventParams
object
Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a role: "system" turn rather than replacing…
2 properties
2 required
BetaManagedAgentsCommitCheckout
object
2 properties
2 required
BetaManagedAgentsPlainTextDocumentSource
object
Plain text document content.
3 properties
3 required
BetaInvalidRequestError
object
2 properties
2 required
BetaManagedAgentsRubricParams
Rubric for grading the quality of an outcome.
BetaManagedAgentsGitHubRepositoryResourceConfig
object
A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.
4 properties
2 required
BetaManagedAgentsSchedule
object
A recurring schedule with computed runtime timestamps. Discriminated union — only cron is supported currently.
BetaManagedAgentsTextRubricParams
object
Rubric content provided inline as text.
2 properties
2 required
BetaManagedAgentsRedactedBlock
object
Placeholder for content withheld by Anthropic model policy.
1 property
1 required
BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError
object
A skill referenced by the deployment's agent no longer exists.
1 property
1 required
BetaManagedAgentsUserDefineOutcomeEventParams
object
Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.
4 properties
3 required
BetaManagedAgentsBudgetLimit
object
A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches maxlistcost.
2 properties
2 required
BetaManagedAgentsImageBlock
object
Image content specified directly as base64 data or as a reference via a URL.
2 properties
2 required
BetaTimestamp
string
A timestamp in RFC 3339 format
BetaOverloadedError
object
2 properties
2 required
BetaBillingError
object
2 properties
2 required
BetaManagedAgentsUnknownDeploymentPausedReasonError
object
An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose error.type is unknownerror.
1 property
1 required
BetaManagedAgentsListDeploymentsData
object
Paginated list of deployments.
2 properties
1 required
BetaManagedAgentsSystemContentBlock
object
Content block in a mid-conversation system message. Text-only.
BetaManagedAgentsMemoryStoreResourceParam
object
Parameters for attaching a memory store to an agent session.
4 properties
2 required
BetaManagedAgentsRepositoryCheckout
object
BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError
object
The deployment's workspace was archived.
1 property
1 required
BetaManagedAgentsFileRubric
object
Rubric referenced by a file uploaded via the Files API.
2 properties
2 required
BetaAuthenticationError
object
2 properties
2 required
BetaManagedAgentsTextBlock
object
Regular text content.
2 properties
2 required
BetaNotFoundError
object
2 properties
2 required
BetaManagedAgentsDeploymentStatus
string
Lifecycle status of a deployment.
BetaManagedAgentsDeploymentInitialEventParams
object
An event sent to a session immediately after it is created. Supports user.message, user.defineoutcome, and system.message.
BetaPermissionError
object
2 properties
2 required
BetaManagedAgentsTextRubric
object
Rubric content provided inline as text.
2 properties
2 required
BetaMonetaryAmount
object
A monetary amount in a specific currency.
2 properties
2 required
BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError
object
The deployment's environment no longer exists.
1 property
1 required
BetaManagedAgentsAgentUnionParams
BetaManagedAgentsFileImageSource
object
Image referenced by file ID.
2 properties
2 required
BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError
object
A referenced resource no longer exists and its kind was not reported.
1 property
1 required
BetaManagedAgentsMountMode
string
Access mode for an attached memory store.
BetaManagedAgentsImageSource
object
Union type for image source variants.
BetaManagedAgentsMcpEgressBlockedDeploymentPausedReasonError
object
An MCP server host used by the deployment's agent is blocked by the environment's network policy.
1 property
1 required
BetaManagedAgentsDocumentSource
object
Union type for document source variants.
BetaErrorResponse
object
3 properties
3 required
BetaManagedAgentsBase64ImageSource
object
Base64-encoded image data.
3 properties
3 required
BetaManagedAgentsDeploymentSystemMessageEvent
object
Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a role: "system" turn rather than replacing…
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Anthropic publishes across the network.
