Developers / Agents

Archive an agent

POST https://api.echonova.ai/v1/agents/{agentId}/archive

Archives 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

Authorization string Required

Bearer, a space, then your API key, which starts with ek_. Create keys in the portal under Developers, API Keys.

Path parameters

agentId string Required

The agent id, as GET /v1/agents returned it.

Response

200 application/json Every response uses this envelope.

data object

The result.

success boolean

true for a successful call.

statusCode integer

Repeats the HTTP status.

errorMessage string or null

null on success.

Errors

Same envelope, with success false and data null. All errors

POST /v1/agents/{agentId}/archive

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
}