Skip to main content
The Parse API handles the conversion of raw files into structured knowledge.

Submit Parse Task

Submit a file for processing through the multimodal pipeline.

Endpoint

POST /api/parse

Request Body

document_id
string
required
The ID assigned to the document in your database.
file_url
string
required
The URL of the source file (PDF, Docx, etc.) to be parsed.
parser_type
string
default:"mineru"
The parser implementation to use.
options
object
Optional configuration for the parser.

Response

{
  "task_id": "task_abc_123",
  "status": "pending",
  "result": null,
  "error": null
}

Get Parse Status

Check the current status and retrieve results once completed.

Endpoint

GET /api/parse/{task_id}

Response

{
  "task_id": "task_abc_123",
  "status": "completed",
  "result": {
    "content": "# Parsed Markdown Content...",
    "json_content": { ... }
  },
  "error": null
}