Try Bifrost Enterprise free for 14 days. Explore now
A valid request URL is required to generate request examples{
"model": "<string>",
"pages": [
{
"index": 1,
"markdown": "<string>",
"images": [
{
"id": "<string>",
"top_left_x": 123,
"top_left_y": 123,
"bottom_right_x": 123,
"bottom_right_y": 123,
"image_base64": "<string>"
}
],
"dimensions": {
"dpi": 123,
"height": 123,
"width": 123
},
"tables": [
{}
],
"header": "<string>",
"footer": "<string>",
"confidence_scores": {
"average_page_confidence_score": 123,
"minimum_page_confidence_score": 123,
"word_confidence_scores": [
123
]
}
}
],
"usage_info": {
"pages_processed": 123,
"doc_size_bytes": 123
},
"document_annotation": "<string>",
"extra_fields": {
"request_type": "<string>",
"provider": "openai",
"model_requested": "<string>",
"model_deployment": "<string>",
"latency": 123,
"chunk_index": 123,
"raw_request": {},
"raw_response": {},
"cache_debug": {
"cache_hit": true,
"cache_id": "<string>",
"hit_type": "<string>",
"requested_provider": "<string>",
"requested_model": "<string>",
"provider_used": "<string>",
"model_used": "<string>",
"input_tokens": 123,
"threshold": 123,
"similarity": 123
}
}
}Extracts text and content from documents or images using optical character recognition. Supports PDF URLs, base64-encoded documents, and image URLs.
A valid request URL is required to generate request examples{
"model": "<string>",
"pages": [
{
"index": 1,
"markdown": "<string>",
"images": [
{
"id": "<string>",
"top_left_x": 123,
"top_left_y": 123,
"bottom_right_x": 123,
"bottom_right_y": 123,
"image_base64": "<string>"
}
],
"dimensions": {
"dpi": 123,
"height": 123,
"width": 123
},
"tables": [
{}
],
"header": "<string>",
"footer": "<string>",
"confidence_scores": {
"average_page_confidence_score": 123,
"minimum_page_confidence_score": 123,
"word_confidence_scores": [
123
]
}
}
],
"usage_info": {
"pages_processed": 123,
"doc_size_bytes": 123
},
"document_annotation": "<string>",
"extra_fields": {
"request_type": "<string>",
"provider": "openai",
"model_requested": "<string>",
"model_deployment": "<string>",
"latency": 123,
"chunk_index": 123,
"raw_request": {},
"raw_response": {},
"cache_debug": {
"cache_hit": true,
"cache_id": "<string>",
"hit_type": "<string>",
"requested_provider": "<string>",
"requested_model": "<string>",
"provider_used": "<string>",
"model_used": "<string>",
"input_tokens": 123,
"threshold": 123,
"similarity": 123
}
}
}Documentation Index
Fetch the complete documentation index at: https://docs.getbifrost.ai/llms.txt
Use this file to discover all available pages before exploring further.
Bearer token authentication. Use your provider API key or Bifrost authentication token.
Virtual keys (prefixed with sk-bf-) can also be passed here.
Model in provider/model format
"mistral/mistral-ocr-latest"
Show child attributes
Optional unique identifier for the request
Fallback models in provider/model format
Whether to include base64-encoded images in the response
Specific page indices to process (0-based)
x >= 0Maximum number of images to extract per page
x >= 1Minimum image size in pixels to extract
x >= 1Format for extracted tables (e.g., "markdown", "html")
Whether to extract page headers
Whether to extract page footers
Granularity of confidence scores to include in the response
page, block, word, document Format for bounding box annotations. Supports text, json_object, and json_schema modes.
Show child attributes
Format for document-level annotations. Supports text, json_object, and json_schema modes.
Show child attributes
Custom prompt for document annotation
Successful response
Model used to perform OCR
Processed pages with extracted content
Show child attributes
Show child attributes
Document-level annotation if requested
Additional fields included in responses
Show child attributes
Was this page helpful?