Get Results

Retrieve the converted document once a conversion task has completed successfully.

Endpoint

GET /v1/result/{task_id}

Authentication

All requests require authentication using the X-Api-Key header with your API key.

Path Parameters

Parameter	Type	Required	Description
`task_id`	string	Yes	The task ID returned from a conversion request

Request Headers

Header	Required	Description
`X-Api-Key`	Yes	Your API key for authentication

Response

Success Response (200 OK)

Returns the converted document with metadata:

{
  "document": {
    "filename": "2311.18481",
    "md_content": "# Document Title\n\nDocument content in Markdown format...",
    "json_content": null,
    "html_content": null,
    "text_content": null,
    "doctags_content": null
  },
  "status": "success",
  "errors": [],
  "processing_time": 2.2357177734375,
  "timings": {}
}

Field	Type	Description
`document`	object	The converted document (see Document Object)
`status`	string	Always `"success"` when results are available
`errors`	array	List of non-fatal errors encountered during conversion
`processing_time`	number	Total processing time in seconds
`timings`	object	Detailed timing breakdown

Document Object

The document object contains the converted content in various formats:

Field	Type	Description
`filename`	string	Original filename or derived name
`md_content`	string	Document content in Markdown format (if requested)
`json_content`	object	Document content in structured JSON format (if requested)
`html_content`	string	Document content in HTML format (if requested)
`text_content`	string	Plain text content (if requested)
`doctags_content`	object	Document tags and metadata (if requested)

Only the requested output format will be populated. Other format fields will be null. The default format is Markdown (md_content).

Error Responses

To be added.

Examples

Find examples of using the Results endpoint in the Examples section.

Output Format Details

Markdown Format

When output_format is set to "markdown", the md_content field contains:

Document structure (headings, paragraphs)
Tables in Markdown table format
Lists (ordered and unordered)
Code blocks
Images (embedded or referenced based on image_ref_mode)
Mathematical formulas in LaTeX format

Example:

# Document Title

## Section 1

This is a paragraph with **bold** and *italic* text.

| Column 1 | Column 2 |
|----------|----------|
| Data 1   | Data 2   |

$$E = mc^2$$

JSON Format

To be added.

HTML Format

When output_format is set to "html", the html_content field contains:

Semantic HTML5 markup
Styled tables
Preserved document structure
Embedded or referenced images

Result Retention

To be added.

Common Issues

To be added.

Best Practices

Check status first - Always verify task status is "success" before retrieving results
Handle errors gracefully - Check the errors array for warnings even on successful conversions
Store results promptly - Download and save results within 24 hours
Use appropriate format - Choose the output format that best suits your use case
Monitor processing time - Use the processing_time field to track performance

Rate Limits

To be added.

Convert Source - Convert documents from URLs
Convert File - Upload and convert local files
Poll Status - Check conversion progress

Get Results

On this page