Path Parameters
Parameter | Type | Description |
---|---|---|
job_id | string | Unique job identifier |
Example Request
Response (200 OK)
Response Fields
Field | Type | Description |
---|---|---|
job_id | string | Job identifier |
status | string | Job status (should be completed ) |
message | string | Summary message with document count |
documents | array | Array of extracted document objects |
metadata | object | Job metadata and original parameters |
total_documents_found | number | Total documents discovered |
total_documents_downloaded | number | Successfully downloaded documents |
total_pages_crawled | number | Pages processed during scraping |
success_rate | number | Success rate (0.0-1.0) |
cost | number | Total cost in USD for this job |
total_runtime_seconds | number | Job execution time in seconds |
runtime_minutes | number | Job execution time in minutes |
has_errors | boolean | Whether any errors occurred |
errors | array | List of error objects (if any) |
warnings | array | List of warning messages (if any) |
Document Object Fields
Field | Type | Description |
---|---|---|
name | string | Human-readable document name |
url | string | Direct URL to the document file |
source_page | string | Web page where document was found |
document_type | string | File type (pdf, doc, docx, txt, etc.) |
confidence_score | number | AI confidence score (0.0-1.0) |
file_size_mb | number | File size in megabytes |
extracted_at | string | ISO 8601 extraction timestamp |
Error Responses
Status | Description |
---|---|
404 | Job not found or access denied |
500 | Internal server error |
Example Usage
Authorizations
API key in format 'sk-xxxxxxxxxxxxx' or 'sk_xxxxxxxxxxxxx'
Path Parameters
Unique job identifier
Response
Job results with extracted documents
Job identifier
Current status of the job
Available options:
pending
, in_progress
, completed
, failed
, cancelled
Summary message with document count
Array of extracted document objects
Total documents discovered
Successfully downloaded documents
Pages processed during scraping
Success rate (0.0-1.0)
Required range:
0 <= x <= 1
Total cost in USD for this job
Job execution time in seconds
Job execution time in minutes
Whether any errors occurred
List of error objects (if any)
List of warning messages (if any)