Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Headers

AiQL-Workspace
string
required

ID of the workspace the request operates on.

Body

url
string
required

URL of the file to ingest.

metadata
object

Optional free-form JSON metadata.

schema
object

Optional strict extraction schema. When provided, schema extraction and refinement are skipped and this schema is used for knowledge extraction. Same shape as POST /extract.

Response

Successful Response

id
string
required
url
string
required
status
string
required
created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
processing
ProcessingState · object
required
name
string | null
filename
string | null
size
integer | null
mime_type
string | null
metadata
Metadata · object | null
schema
Schema · object | null
upload
UploadTarget · object | null