Developers / Agents
Archive an agent
https://api.echonova.ai/v1/agents/{agentId}/archiveArchives the agent: GET /v1/agents leaves it out unless you filter by status=archived, its website widget and playground test calls stop, and it cannot be changed until it is restored. Phone numbers and messaging channels stay connected and keep answering; disconnect them in the portal. Nothing is deleted. Archiving an archived agent answers 200 and changes nothing. Free. Needs the agents:write scope on the key.
Headers
Bearer, a space, then your API key, which starts with ek_. Create keys in the portal under Developers, API Keys.
Path parameters
The agent id, as GET /v1/agents returned it.
Response
200 application/json Every response uses this envelope.
The result.
The agent id.
The agent name.
What the agent is for, or null.
active, or archived once deleted in the portal.
The agent's default voice, or null if it has none.
The voice id, as GET /v1/text-to-speech/voices shows it.
The voice name in English, or null if the voice is gone.
The default voice's dialect, or null.
The language model the agent thinks with.
Who serves the language model.
The model id. Pass it as model to GET /v1/llm/estimate for its price.
How many channels the agent is connected to.
How many conversations the agent has had.
When the agent last changed, as an ISO 8601 date-time.
What the agent says first, or null if none is set and the agent writes its own opening line.
The agent's instructions.
Call settings.
Whether voice calls are recorded.
Whether numbers, dates and amounts are spoken the way the dialect says them.
How many knowledge folders and sources the agent uses.
How many workspace tools are attached to the agent.
When the agent was created, as an ISO 8601 date-time.
true for a successful call.
Repeats the HTTP status.
null on success.
Errors
Same envelope, with success false and data null. All errors
When. agentId or sessionId is not a 24-character hexadecimal id.
Fix. Use the id exactly as GET /v1/agents or the conversations list returned it.
When. The Authorization header is missing or is not Bearer ek_..., no key matches the token, or the key is deleted, disabled, expired or its account is closed.
Fix. Send Authorization: Bearer ek_... with an enabled key from this environment.
When. The workspace that owns the key has no subscription.
Fix. Check the workspace's plan in the portal.
When. The subscription is in a state other than active or trial.
Fix. Renew the subscription.
When. The key does not have the agents:write scope.
Fix. Edit the key and give it the agents:write scope, or use another key.
When. The member who created the key has left the workspace, or no longer has both the Manage agents and Manage developer API permissions. It is checked on every call.
Fix. Give that member both permissions again, or create a key as a member who has them.
When. The agent id is unknown, or the agent belongs to another workspace.
Fix. Use an id from GET /v1/agents with a key of the agent's workspace.
When. The key made more than 100 requests to one endpoint in 60 seconds, or one IP address made more than 100 requests to one endpoint in 60 seconds (the IP limit is counted before the key is checked, so it can answer with no key at all); a Retry-After header carries the seconds to wait.
Fix. Wait Retry-After seconds, then retry.
When. An error the API did not classify.
Fix. Check the request, then retry after a short wait; contact support if it persists.
When. A transient outage inside the API.
Fix. Retry after a short wait.
When. A transient timeout inside the API.
Fix. Retry after a short wait.
curl -X POST "https://api.echonova.ai/v1/agents/{agentId}/archive" \
-H "Authorization: Bearer YOUR_API_KEY"{
"data": {
"id": "6650a1b2c3d4e5f6a7b8c9d0",
"name": "Sales assistant",
"description": "Answers questions about plans and prices.",
"status": "active",
"voice": {
"id": "6640a1b2c3d4e5f6a7b8c9d0",
"name": "Huda"
},
"dialect": "emirati",
"llm": {
"provider": "openai",
"model": "gpt-4o"
},
"channelsCount": 2,
"sessionsCount": 128,
"updatedAt": "2026-11-01T10:00:00.000Z",
"firstMessage": "Hello, how can I help you today?",
"systemPrompt": "You are a friendly sales assistant for EchoNova.",
"settings": {
"recordCalls": true,
"normalizeNumbers": true
},
"knowledgeCount": 3,
"toolsCount": 2,
"createdAt": "2026-10-01T10:00:00.000Z"
},
"success": true,
"statusCode": 200,
"errorMessage": null
}