Skip to main content
POST
Create Ingest Job

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
file
file
required
collection
string
parse_method
enum<string> | null

Available parsing methods

Available options:
default,
pypdf,
pdfplumber,
unstructured,
pymupdf,
deepdoc
chunk_strategy
enum<string> | null

Available chunk strategies

Available options:
recursive,
fixed_size,
markdown
chunk_size
integer | null
Required range: x > 0
chunk_overlap
integer | null
Required range: x >= 0
separators
string | null
embedding_model_id
string
default:text-embedding-v4
embedding_batch_size
integer | null
Required range: x > 0
max_retries
integer | null
Required range: x >= 0
retry_delay
number | null
Required range: x >= 0

Response

Successful Response

id
string
required
user_id
integer
required
job_type
string
required
queue
string
required
status
string
required
attempts
integer
required
max_attempts
integer
required
progress
Progress · object | null
result
Result · object | null
error_message
string | null
celery_task_id
string | null
started_at
string<date-time> | null
finished_at
string<date-time> | null
created_at
string<date-time> | null
updated_at
string<date-time> | null