Skip to main content
GET
/
ocr
/
v1
/
{id}
curl -X GET "https://api.case.dev/ocr/v1/%3Cstring%3E" \ -H "Authorization: Bearer $CASEDEV_API_KEY"
{
  "id": "ocr_abc123",
  "status": "completed",
  "page_count": 15,
  "text": "EMPLOYMENT AGREEMENT\n\nThis Employment Agreement is entered into between...",
  "metadata": {
    "confidence": 0.95,
    "language": "en"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "completed_at": "2024-01-15T10:32:15Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.case.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key starting with sk_case_

Path Parameters

id
string
required

The OCR job ID returned from the create OCR endpoint

Query Parameters

include_text
enum<string>

Include full OCR text in completed responses (default: true)

Available options:
true,
false

Response

OCR job status and results

id
string
required

OCR job ID

status
enum<string>
required

Current job status

Available options:
pending,
processing,
completed,
failed
created_at
string<date-time>
required

Job creation timestamp

page_count
integer

Number of pages processed

text
string

Extracted text content (when completed)

metadata
object

Additional processing metadata

completed_at
string<date-time>

Job completion timestamp