Skip to main content
POST
/
api
/
v1
/
files
/
{file_id}
/
extraction
Create Text Extraction
curl --request POST \
  --url https://api.example.com/api/v1/files/{file_id}/extraction \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "settings": {
    "formats": [
      "markdown"
    ]
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "extracted_files": [
    {
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "format": "markdown"
    }
  ],
  "status": "pending",
  "job_id": "<string>",
  "error_message": "<string>",
  "extraction_metadata": {
    "backend": "<string>",
    "settings": {
      "formats": [
        "markdown"
      ]
    }
  },
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
file_id
string<uuid>
required

Query Parameters

​
context_id
string<uuid> | null

Body

application/json

Request schema for text extraction.

​
settings
TextExtractionSettings · object

Additional options for text extraction

Response

Successful Response

​
id
string<uuid>
required
​
file_id
string<uuid>
required
​
extracted_files
ExtractedFileInfo · object[]
​
status
enum<string>
default:pending
Available options:
pending,
in_progress,
completed,
failed,
cancelled
​
job_id
string | null
​
error_message
string | null
​
extraction_metadata
ExtractionMetadata · object
​
started_at
string<date-time> | null
​
finished_at
string<date-time> | null
​
created_at
string<date-time>