PerfectParser Docs

Get Extraction Status

Reference for the GET /v1/extractions/:extraction_id endpoint.

GET /v1/extractions/:extraction_id

Retrieves the current extraction status and metadata for a specific job.

Path Parameters

ParameterTypeRequiredDescription
extraction_idstringThe unique ID of the extraction job.
curl https://api.perfectparser.com/v1/extractions/ext_123 \
  -H "X-API-Key: pp_live_your_secret_key"

Response 200 OK

{
  "extraction": {
    "extraction_id": "ext_123",
    "parser_id": "prs_999",
    "parser_name": "Invoice Parser",
    "status": "completed",
    "file_count": 2,
    "page_count": 7,
    "credits_used": 7,
    "created_at": "2026-06-20T10:00:00.000Z",
    "updated_at": "2026-06-20T10:00:45.000Z",
    "completed_at": "2026-06-20T10:00:45.000Z",
    "documents": [
      {
        "document_id": "doc_1",
        "filename": "invoice-1.pdf",
        "status": "completed",
        "page_count": 3,
        "credits_used": 3,
        "error_message": null,
        "created_at": "2026-06-20T10:00:00.000Z",
        "updated_at": "2026-06-20T10:00:42.000Z"
      },
      {
        "document_id": "doc_2",
        "filename": "invoice-2.pdf",
        "status": "completed",
        "page_count": 4,
        "credits_used": 4,
        "error_message": null,
        "created_at": "2026-06-20T10:00:00.000Z",
        "updated_at": "2026-06-20T10:00:45.000Z"
      }
    ]
  }
}

Common Error Responses

HTTP StatusError CodeDescription
401UNAUTHORIZEDInvalid or missing API key.
404RESOURCE_NOT_FOUNDThe requested extraction job does not exist or belongs to another account.

On this page