Endpoints
    POST/desearch/people/tasks/{task_id}/pause

    Pause a People Search task

    A queued search pauses at once; a running one finishes its current batch first (status `pausing`, then `paused`). Profiles found so far stay available. A search paused for more than 7 days is cancelled. Free. Billing metadata: successful billable responses include the `X-Desearch-Cost-Usd`, `X-Desearch-Usage-Count`, `X-Desearch-Service`, and `X-Desearch-Currency` headers. JSON object responses also include optional `cost_usd`, `usage_count`, `service`, and `currency` fields. For example, `usage_count=10` at `$0.015 / 1,000` resolves to `cost_usd=0.00015`. JSON arrays, text, and streaming responses keep their body shape and expose billing metadata only through headers.

    Base URL

    https://api.desearch.ai

    Implementation guidance

    Use Pause a People Search task when your application needs scored public profiles of people and creatorswithout maintaining its own crawler, social-data pipeline, or retrieval infrastructure. The endpoint returns structured data that can be consumed by agents, research tools, dashboards, and retrieval-augmented generation workflows. Keep the request focused on the minimum fields your workflow needs so responses remain fast and easy to validate.

    Send requests to POST /desearch/people/tasks/{task_id}/pause with your Desearch API key in the authorization header. Treat the key as a server-side secret, validate all required parameters before sending the request, and handle non-2xx responses explicitly. Production integrations should use sensible timeouts, retry only transient failures with backoff, and record the response status and request identifier for troubleshooting.

    Test the example request below before integrating it into a larger workflow. Confirm that the returned fields, links, and timestamps meet your freshness requirements, then add schema validation at the application boundary. For agentic systems, preserve source URLs with the generated answer so users can inspect evidence and your application can avoid presenting unsupported claims.

    Path Parameters

    task_idstringrequired

    The task_id returned when the search was created

    Responses

    200Successful Response
    400Bad request: an unknown platform, sort, status, cursor or `has` channel, or a filter the platform does not support
    401Unauthorized
    404Task not found
    409The task is not in a state that allows this action
    422Validation Error
    500Internal Server Error
    Authorization

    Your API key is sent in the Authorization header.

    Request
    curl -X POST "https://api.desearch.ai/desearch/people/tasks/3f1c2b9e-8d4a-4c1e-9b7a-2e5f6a7b8c9d/pause" \
      -H "Authorization: YOUR_API_KEY" \
      -H "Content-Type: application/json"
    ResponseSchema
    {
      "task_id": "Task Id",
      "search_type": "x_profile_search",
      "platform": "x",
      "status": "queued",
      "stage": "planning",
      "query": "Query",
      "count": 0,
      "result_count": 0,
      "interpreted": {},
      "progress": {},
      "errors": [],
      "reserved_cost_usd": 0,
      "final_cost_usd": 0,
      "refunded_usd": 0,
      "created_by": {
        "user_id": "string",
        "api_key_id": "string",
        "via": "string"
      },
      "created_at": "2024-01-15T10:30:00Z",
      "started_at": "2024-01-15T10:30:00Z",
      "paused_at": "2024-01-15T10:30:00Z",
      "finished_at": "2024-01-15T10:30:00Z",
      "results_expire_at": "2024-01-15T10:30:00Z",
      "links": {
        "self": "Self",
        "results": "Results",
        "export": "Export"
      }
    }

    Possible status codes:

    200401422429500