Deploy Agent
Deploy an AI agent to make it active and available for task execution
Path Parameters
Response
Returns HTTP 200 with the complete agent object (same structure as Create Agent). Key response fields:id: Agent identifiername: Agent display namestatus: Updated status (ACTIVEorINACTIVE)deployment_type: Deployment infrastructuremodel_provider: AI model providermodel_name: Specific model versionframework: Agent framework usedorganization_id: UUID of the organization that owns this agentdescription: Auto-generated from instructions if not previously sethas_pending_changes: Indicates whether there are unpublished changesversion: Current version number of the agent
Example Request
Example Response
Notes
- Agent must have valid instructions and configuration before deployment
- Deployment validates all configurations and dependencies
- Previously deployed version remains active until new deployment succeeds
- Deployment typically completes within seconds
- After deploy,
descriptionis auto-generated from instructions if not previously set has_pending_changesreturns tofalseafter successful deployment- Check agent status using List Agents endpoint
- An
ACTIVEstatus indicates the agent is ready to handle tasks
Authorizations
API Key for authentication
Path Parameters
Response
Successful Response
Runtime environment (image and environment spec) assigned to the agent, if any.
serverless, container - AIAgentConnectivityDetailsA2A
- AIAgentConnectivityDetailsCurl
- Connectivity Details
How the agent runs: 'external-harness' (default; a coding CLI chosen by harness_settings.default_cli) or 'agno' (the built-in loop). Legacy 'claude-code' / 'codex' values read as 'external-harness' with that CLI.
Icon shown next to the agent name: the platform icon id (default 'xpi:workflow:dusk') or a single emoji.
personal, organizational Skills enabled for the agent (name, description, version), resolved at read time. Attached skills only; built-in runtime capabilities are not listed.
Flattened environment spec resolved at read time; not persisted.
Vault secrets bound to the agent as resolved for its runtime; null means none.
Workspace commands that need approval before they run: {match, unless?, note?, approvers?, channels?} items where match is literal text. null means no gates; empty approvers asks the agent owner.
Enumeration of possible agent statuses.
Attributes: DRAFT: Agent is in a draft state. ACTIVE: Agent is active and operational. INACTIVE: Agent is inactive and not operational.
DRAFT, ACTIVE, INACTIVE Organization user to run as when a non-UI invocation has no resolved user.
Enumeration of the agent types.
Attributes: Manager: marks the agent as a Managing agent. Regular: marks the agent as a regular agent. A2A: marks the agent as an external agent used via A2A protocol. Curl: marks the agent as an external agent used via a CURL. Orchestration: marks the agent as an Orchestration object.
manager, regular, a2a, curl, orchestration openai, nim, amazon_bedrock, azure_ai_foundary, huggingFace, friendlyAI, anthropic, gemini, fireworks, google_ai_studio, helicone, bytedance, tzafon_lightcone, cerebras, open_router, nebius, cloudflare_ai_gw, z_ai low, medium, high, xhigh text, markdown, json, voice xpander, custom Runtime settings for an agent whose framework is 'external-harness'; null for 'agno' agents.
Configuration for event-based notifications.
Attributes: on_success: Notifications to send when an operation succeeds. Maps notification types to a list of notification configurations. on_error: Notifications to send when an operation fails. Maps notification types to a list of notification configurations. on_budget: Notifications to send on budget threshold crossings. A dedicated category — budget alerts are not errors.
Configuration object for task-level execution strategies.
This model groups optional strategy configurations that control how a task is executed and managed over time, including retries, iterative execution, stopping conditions, and daily run limits.
Attributes: retry_strategy: Optional retry policy configuration that defines how the task should behave when execution fails (e.g., max attempts, backoff rules).
1 <= x <= 1000Whether the agent may share the live surfaces it builds.

