Claix Retrieve

Agent Actions

Create, edit, and pause or resume Retrieve agents via API.

Agents · Pause / resume

Pause or resume an agent

Endpoint

POSThttps://claix.dev/agents/pause/{agent_id}

Toggles an agent between paused and active. A paused agent rejects calls to /retrieve/{slug}.

This call is free.

1. Authentication

x-api-key: <YOUR_API_KEY>

2. Request format

Method: POST · Content-Type: application/json

FieldTypeRequiredDescription
agent_id (URL)uuidYesIn /agents/pause/{agent_id}. Also accepted in JSON.
statusstringYes"paused" to pause, "active" to resume.
{ "status": "paused" }

3. Examples

The right panel has tabs for pause and resume.

4. Successful response

200 OK

{
  "success": true,
  "action": "paused",
  "agent": {
    "agent_id": "9d8e7f6a-5b4c-3d2e-1f0a-9b8c7d6e5f4a",
    "name": "Asistente de agenda",
    "slug": "agenda",
    "status": "paused",
    "retrieve_url": "https://claix.dev/retrieve/agenda"
  }
}

5. Errors

HTTPWhen
401Invalid API key.
404Agent not found.
400Missing status or agent_id, or invalid value.
500Internal error.
{
  "error": "Descripción legible del problema.",
  "detalle": "Información técnica adicional (solo presente en algunos casos).",
  "log_id": "7c2e1a90-4b3d-4f8a-9e21-6d5c8b0a1f34"
}

Request examples

curl -X POST "https://claix.dev/agents/pause/9d8e7f6a-5b4c-3d2e-1f0a-9b8c7d6e5f4a" \
  -H "x-api-key: <TU_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"status":"paused"}'