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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

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

PHP Build Version
Package Version
Requires php Version >=8.2
ext-curl Version *
ext-fileinfo Version *
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package robo-meister/flow-scribe-api contains the following files

Loading the files please wait ...