Skip to navigation

Archive an agent

View as Markdown

Archives the agent and stops its published version from starting new runs. It drops out of the directory unless includeArchived=true is passed. Runs already in flight are untouched. Archiving is a durable stop: publishing an archived agent answers 409 agent_archived — POST /agents/:agentRef/unarchive is the way back. Authorization: organization administrators only. A private agent is visible only to its owner; every other caller gets 404. Response: { data: Agent }.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

agentRefstringRequired

Response

The archived agent.
dataobject

Errors

404
Not Found Error