agentIdstringrequired
Example:agt_8f2c1a
Retrieve an agent deployment
get
Path Parameters
Response
application/json
Response
application/json
Agent deployment
Agent
categorystringrequired
Allowed values:copilotautonomous-agentworkflow-agentrag-assistantvoice-agent
Example:copilot
deployment_tierstring
Allowed values:sandboxpilotproduction
Example:pilot
titlestringrequired
<= 120 characters
Example:Internal Support Triage Copilot
descriptionstring
Example:Triages inbound support tickets and drafts first-response replies for human review.
owning_teamobjectrequired
Show Child Parameters
integration_countinteger
Example:6
tool_countinteger
Example:4
model_providerstring
Example:Anthropic Claude
model_release_datestring(date)
Example:2026-02-01
cost_per_1k_tokens_usdnumber(float)
Example:0.015
monthly_budget_usdinteger
Example:4000
support_budget_usdinteger
Example:500
available_fromstring(date)
Example:2026-11-01
compliance_certificationobject
Figures needed to publish a catalog entry.
Show Child Parameters
chargebackobject
Show Child Parameters
idstring
Example:agt_8f2c1a
statusstring
Allowed values:draftactivepauseddeprecatedretiredarchived
Example:active
artifact_countinteger
Example:14
created_atstring(date-time)
Example:2026-08-14T08:12:44Z
updated_atstring(date-time)
Example:2026-08-20T09:38:02Z
get/agents/{agentId}
Authentication
Path Parameters
application/json
Update an agent deployment
Updates individual fields. Catalog entries already generated remain unchanged.
patch
Path Parameters
agentIdstringrequired
Example:agt_8f2c1a
Body
application/json
Body
application/json
AgentInput
categorystringrequired
Allowed values:copilotautonomous-agentworkflow-agentrag-assistantvoice-agent
Example:copilot
deployment_tierstring
Allowed values:sandboxpilotproduction
Example:pilot
titlestringrequired
<= 120 characters
Example:Internal Support Triage Copilot
descriptionstring
Example:Triages inbound support tickets and drafts first-response replies for human review.
owning_teamobjectrequired
Show Child Parameters
integration_countinteger
Example:6
tool_countinteger
Example:4
model_providerstring
Example:Anthropic Claude
model_release_datestring(date)
Example:2026-02-01
cost_per_1k_tokens_usdnumber(float)
Example:0.015
monthly_budget_usdinteger
Example:4000
support_budget_usdinteger
Example:500
available_fromstring(date)
Example:2026-11-01
compliance_certificationobject
Figures needed to publish a catalog entry.
Show Child Parameters
chargebackobject
Show Child Parameters
Response
application/json
Response
application/json
Updated
Agent
categorystringrequired
Allowed values:copilotautonomous-agentworkflow-agentrag-assistantvoice-agent
Example:copilot
deployment_tierstring
Allowed values:sandboxpilotproduction
Example:pilot
titlestringrequired
<= 120 characters
Example:Internal Support Triage Copilot
descriptionstring
Example:Triages inbound support tickets and drafts first-response replies for human review.
owning_teamobjectrequired
Show Child Parameters
integration_countinteger
Example:6
tool_countinteger
Example:4
model_providerstring
Example:Anthropic Claude
model_release_datestring(date)
Example:2026-02-01
cost_per_1k_tokens_usdnumber(float)
Example:0.015
monthly_budget_usdinteger
Example:4000
support_budget_usdinteger
Example:500
available_fromstring(date)
Example:2026-11-01
compliance_certificationobject
Figures needed to publish a catalog entry.
Show Child Parameters
chargebackobject
Show Child Parameters
idstring
Example:agt_8f2c1a
statusstring
Allowed values:draftactivepauseddeprecatedretiredarchived
Example:active
artifact_countinteger
Example:14
created_atstring(date-time)
Example:2026-08-14T08:12:44Z
updated_atstring(date-time)
Example:2026-08-20T09:38:02Z
patch/agents/{agentId}
Authentication
Path Parameters
Body
{
"deployment_tier": "production"
}
application/json
Retire an agent deployment
Takes the agent out of active service. The record remains readable.
delete
Path Parameters
agentIdstringrequired
Example:agt_8f2c1a
Response
Response
Retired
delete/agents/{agentId}
Authentication
Path Parameters
Artifacts
List an agent's artifacts
get
Path Parameters
agentIdstringrequired
Example:agt_8f2c1a
Response
200 application/json
Response
200 application/json
Artifact list
dataarray[object]
Show Child Parameters
get/agents/{agentId}/artifacts
Authentication
Path Parameters
200 application/json