I-i-am-bee
files

Create Text Extraction

Create or return text extraction for a file.

  • If extraction is completed, returns existing result
  • If extraction failed, retries the extraction
  • If extraction is pending/in-progress, returns current status
  • If no extraction exists, creates a new one
post/api/v1/files/{file_id}/extraction

Request

  • The document declares no server URL.
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

file_idstring uuid required

Query parameters

context_idstring uuid nullable

Request body

Response

Successful Response

idstring uuid required
file_idstring uuid required
status'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled'
job_idstring nullable
error_messagestring nullable
started_atstring date-time nullable
finished_atstring date-time nullable
created_atstring date-time

Changes

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