Base URLs
The following table lists the base URLs for document processing. Replace{baseURL} with your installation’s API gateway URL, https://api.<runtime>.<installation>.gcservices.io.
Both APIs require a subscription key in the
api-key header. You can also pass the key as the api-key query parameter.
Supported operations
The OCR API supports the following operations.Convert a file to markdown
POST{baseURL}/ocr/v0/convert
Converts a PDF or image to markdown. MCP tool: convert_file_to_markdown.
The following table describes the request body fields.
The following table describes the response body fields.
Fetch text content
POST{baseURL}/ocr/v0/text
Returns the content of a text file without OCR. MCP tool: fetch_text_content.
The request body uses the same fields as Convert a file to markdown. The service ignores mode.
The following table describes the response body fields.
Check service health
GET{baseURL}/ocr/v0/health
Returns the status of the OCR service. This operation isn’t available as an MCP tool.
The following table describes the response body fields.
MCP tools
The following table lists the tools that the Document Retrieval MCP server exposes. Each tool takes the same arguments as the matching REST request body and returns the same JSON as the REST response, as text content.Supported file formats
The following table lists the file formats that each operation accepts. Extensions are case-insensitive.
For HTTPS URLs without a file extension, the service treats the file as a PDF when the URL path contains a
pdf segment, for example https://arxiv.org/pdf/1706.03762.
Document sources
The following table shows how the service downloads files, based on the URL.OCR modes and models
The following table lists the OCR modes and the models behind them.
If the selected mode fails or returns no text, the service retries the document with the other mode. The
metadata.mode and metadata.model fields show which mode and model produced the result. The request fails only when both modes fail.
Limits
The following table lists the service limits.Error codes
The following table lists the HTTP status codes that the APIs return.
MCP clients surface these failures as tool errors.
Service configuration
Backbase manages the service configuration. To change a setting, for example to allow another Azure Blob Storage container, contact your Backbase support team. The following table lists the settings that affect how the OCR service behaves.
The Document Retrieval MCP server has one setting,
DOCUMENT_RETRIEVAL_API_URL, which points to the OCR service. The server loads the OpenAPI specification for the OCR API from this URL at startup.