Contents

Poll async content extraction job status

Check the status and retrieve results of an async content extraction job.

get/v1/contents/jobs/{job_id}

Request

  • Base URL: https://api.valyu.ai
  • URL: https://api.valyu.ai/v1/contents/jobs/{job_id}
  • Auth: API key in header X-API-Key

Path parameters

job_idstring required

The job ID returned by the async contents request.

Response

Job status and results (when complete).

successboolean required

Whether the request succeeded.

job_idstring required

Unique identifier for the async job.

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' required

Current job status.

  • pending - Job created, not yet started
  • processing - URLs are being processed
  • completed - All URLs processed successfully
  • partial - Processing finished with some failures
  • failed - All URLs failed
urls_totalinteger required

Total number of URLs to process.

urls_processedinteger required

Number of URLs successfully processed so far.

urls_failedinteger required

Number of URLs that failed processing.

created_atinteger

Job creation time as Unix timestamp in milliseconds.

updated_atinteger

Last update time as Unix timestamp in milliseconds.

current_batchinteger

Current batch being processed. Only present when status is "processing".

total_batchesinteger

Total number of batches. Only present when status is "processing".

actual_cost_dollarsnumber

Total cost in USD. Only present when processing is complete.

errorstring

Error message. Only present when status is "failed" or "partial".

Example response

{
  "success": true,
  "job_id": "cj_a1b2c3d4e5f6g7h8",
  "status": "completed",
  "urls_total": 25,
  "urls_processed": 23,
  "urls_failed": 2,
  "created_at": 1707000000000,
  "updated_at": 1707000060000,
  "current_batch": 3,
  "total_batches": 5,
  "results": [
    {
      "url": "https://en.wikipedia.org/wiki/Quantum_computing",
      "status": "success",
      "title": "Quantum computing - Wikipedia",
      "description": "Quantum computing is a type of computation that harnesses quantum mechanical phenomena.",
      "source": "web",
      "price": 0.001,
      "length": 24500,
      "data_type": "unstructured",
      "source_type": "website",
      "publication_date": "2024-03-15",
      "id": "https://en.wikipedia.org/wiki/Quantum_computing",
      "image_url": {
        "0": "https://upload.wikimedia.org/wikipedia/commons/quantum.png"
      },
      "error": "Could not extract content from this URL. The page may be unavailable, require sign-in, or block automated access.",
      "doi": "10.26434/chemrxiv-2025-chn4j",
      "citation_count": 5
    }
  ],
  "actual_cost_dollars": 0.023
}

Changes

No recorded changes to this operation across all 1 revision of this API.