Get Parse Result

​

Overview

​

Parameters

​

Response

curl -X 'GET' \
  'https://prod.visionapi.unsiloed.ai/parse/04a7a6d8-5ef7-465a-b22a-8a98e7104dd9' \
  -H 'accept: application/json' \
  -H 'api-key: your-api-key'

{
  "job_id": "04a7a6d8-5ef7-465a-b22a-8a98e7104dd9",
  "status": "Starting",
  "created_at": "2025-10-22T06:51:16.870302Z",
  "metadata": {}
}

​

Job Status Values

​

Polling Strategy

import requests
import time

def poll_parse_job(job_id, api_key, max_wait_time=300, poll_interval=5):
    """Poll a parsing job until completion or timeout"""
    
    start_time = time.time()
    headers = {"api-key": api_key}
    
    while time.time() - start_time < max_wait_time:
        response = requests.get(
            f"https://prod.visionapi.unsiloed.ai/parse/{job_id}",
            headers=headers
        )
        
        if response.status_code == 200:
            job = response.json()
            
            if job['status'] == 'Succeeded':
                return job
            elif job['status'] == 'Failed':
                raise Exception(f"Job failed: {job.get('message', 'Unknown error')}")
            elif job['status'] in ['Starting', 'Processing']:
                print(f"Job status: {job['status']} - waiting...")
                time.sleep(poll_interval)
            else:
                print(f"Unknown status: {job['status']}")
                time.sleep(poll_interval)
        else:
            print(f"Error checking status: {response.status_code}")
            time.sleep(poll_interval)
    
    raise Exception("Job polling timed out")

# Usage
try:
    result = poll_parse_job("04a7a6d8-5ef7-465a-b22a-8a98e7104dd9", "your-api-key")
    print("Job completed successfully!")
    print(f"Total chunks: {result['total_chunks']}")
except Exception as e:
    print(f"Error: {e}")

​

Segment Types

​

Title

​

SectionHeader

​

Text

​

ListItem

​

Table

​

Picture

​

Caption

​

Formula

​

Footnote

​

PageHeader

​

PageFooter

​

Page

• segment_type: Type of content detected
• content: Extracted text content
• image: URL to extracted image (if applicable)
• page_number: Page where the segment appears
• confidence: Confidence score for the extraction
• bbox: Precise coordinates of the segment
• html: HTML-formatted content
• markdown: Markdown-formatted content
• ocr: Detailed OCR data with individual text elements
• chart_data: Structured chart data (chart type, series, labels, legend) for Picture segments identified as charts, when chart extraction is enabled
• cell_references: Spreadsheet cell-range references ({sheet, address, ref}) for Excel segments
• references: Research-paper citations attached to the segment, when xml_citation is enabled
• merged_page_bboxes: Per-page bounding boxes for tables merged across page breaks, when merge_tables is enabled

​

Error Handling

​

Common Error Scenarios

1. Job Not Found: Invalid or expired job ID returns a 404 response.
2. Unauthorized: Missing or invalid API key returns a 401 response.
3. Forbidden: Valid API key but no permission to access this task returns a 403 response.
4. Rate Limiting: This GET endpoint is not rate limited by the application; only the submit endpoints are. Poll responsibly regardless.
5. Client-Side Polling Timeout: The job did not complete within the time your polling logic allows. This is not a server-returned error; implement a reasonable client-side timeout and handle it gracefully.
6. Server Error: Internal processing error returns a 500 response.

​

Best Practices

• Polling Frequency: Check status every 5-10 seconds for long-running jobs
• Timeout Handling: Implement reasonable timeouts to prevent infinite polling
• Error Recovery: Handle failed jobs gracefully with retry logic
• API Key Security: Keep your API key secure and never expose it in client-side code

​

Rate Limits

• Concurrent Jobs: Limited number of active parsing jobs per API key
• Request Frequency: Avoid excessive polling (recommended: 5-10 second intervals)