Archives an agent by its ID. To list archived agents, set only_archived to true in List agents.

When to use it

Use it to retire an agent you may want to restore later with Unarchive an agent. To stop an agent's real-time interactions but keep it in place, use Unpublish an agent. To remove it entirely, use Delete an agent.

Required parameters

• agent_id (path): the ID of the agent.

Example request

Archive the agent AGENT_ID:

curl -X POST "https://api.superwise.ai/v1/agents/AGENT_ID/archive" \
  -H "Authorization: Bearer YOUR_TOKEN"

Replace YOUR_TOKEN with a bearer token. Creating a bearer token shows how to get one from the client ID and secret key you create in Generate access token. The agent then appears in List agents only when only_archived is true.

Response

A successful call returns 200 OK. The response body is not documented.

Related: Unarchive an agent, List agents, Delete an agent, Run a bulk action on agents