Download the PHP package robo-meister/flow-scribe-api without Composer
On this page you can find all versions of the php package robo-meister/flow-scribe-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download robo-meister/flow-scribe-api
More information about robo-meister/flow-scribe-api
Files in robo-meister/flow-scribe-api
Package flow-scribe-api
Short Description FlowScribe OCR PHP SDK for connecting to the Robo-Meister OCR API
License proprietary
Informations about the package flow-scribe-api
FlowScribe OCR SDK (PHP)
PHP client for connecting to the Robo-Meister FlowScribe OCR API and Robo Connector / Universal Dropzone OCR flows.
Install
For local development from this repository, add the package as a path repository:
Basic OCR
Robo Connector and Universal Dropzone options
processDocument(), ingestFlowScribe(), and ingestRcInvoice() accept the same metadata options so OCR results can be linked back to Robo Connector documents:
rc_callback_url is the Robo Connector base URL, not the final callback endpoint; FlowScribe appends /api/integration/document/ocr-completed when it calls back.
When these options are present, the SDK sends the important values as multipart form fields. It also mirrors routing/correlation values to headers: X-Workspace-Id, X-Org-Id, X-Source-Document-Id, X-Correlation-Id, Idempotency-Key, and X-RC-Callback-Url.
auto document type behavior
Use 'document_type' => 'auto' when you want the API to classify the dictionary. By default, the PHP SDK does not send a document_type=auto multipart field; omitting the override lets FlowScribe use server-side auto-classification. If you are integrating with an API deployment that explicitly requires the literal string auto, pass 'send_auto_document_type' => true.
Universal Dropzone integration
Authenticated integration routes require an access token generated by the Robo Connector link flow. The SDK sends the token as a bearer token.
processDocumentForReview(), ingestUniversalDropzoneDocument(), and ingestRcDocument() set review-friendly defaults: document_type=auto, mode=fuse, return_review_payload=true, include_storage=true, and include_preview=true.
For the legacy RC invoice OCR bridge, ingestRcInvoice() and rcInvoiceStatus() remain available. For non-invoice Robo Connector documents, prefer ingestRcDocument():
Handling review payloads
Diagnostics
diagnostics() first calls /api/integration/flowscribe/diagnostics with optional org/workspace headers. If that endpoint is not available, it falls back to /health and /metadata.
Custom dictionary config
Pass either a JSON file path:
Or pass an array that the SDK serializes as config.json for the multipart upload. Temporary config files are deleted after each request.
Errors
HTTP and transport failures throw FlowScribeOcrException. HTTP errors preserve the status code, decoded response body, raw response body, response correlation ID, and machine-readable error code when available.
All versions of flow-scribe-api with dependencies
ext-curl Version *
ext-fileinfo Version *
ext-json Version *