Using templates in automations
Call an IDP template through the public API, from an RPA robot or from an AI agent, and see the limits of each option.
Using templates in automations
A published IDP template can be called in three ways: through the public API, from an RPA robot or from an AI agent. All three always run the active version — never the draft —, record the run in the Production environment, in Runs, and count toward the workspace's IDP requests usage.
Without an active version, all three fail with the NO_ACTIVE_VERSION error. When identification rejects the document, the call does not fail: the result reports the rejection.
Comparison
| Public API | Robot action | AI agent action | |
|---|---|---|---|
| Who calls | Any external system | An RPA robot in the workspace | An AI agent in the workspace |
| Authentication | A workspace API key with the IDP templates scope | None: the robot uses the device's identity | None: the agent runs inside the workspace |
| Where the file comes from | Uploaded by the system to a signed URL | A path on the device running the robot | A chat attachment, a file from the API run, or a file downloaded from Google Drive or OneDrive |
| Formats | PDF, PNG, JPG, JPEG, WEBP, TIFF, TIF and BMP | PDF, PNG, JPG, JPEG, WEBP, TIFF, TIF and BMP | PDF and images (PNG, JPG, JPEG, WEBP, TIFF and BMP) up to 15 MB |
| Pages and parameters | page and params fields | Pages to work on and Parameters advanced options | Not sent |
| Waiting for the result | The system polls the status until the end | Timeout: 10 minutes by default; 0 waits indefinitely | Timeout: 5 minutes by default, 14 minutes at most |
Sending pages, through the API or the robot action, is only accepted when the template lets the API override the pages. See Document and pages.
Public API
For integrating systems that don't run on Roberty. The call takes three steps: request the run, upload the document to the signed URL returned, valid for 15 minutes, and fetch the result by its requestId.
See API and webhook.
Robot action
The Run IDP template action sends a file from the device running the robot, waits for processing and returns the requestId and the template's full result. Use it when the document is already in a local folder, for example after it was downloaded from a portal or an e-mail.
- The robot checks progress every 2 seconds until the end or until the Timeout runs out.
- The action fails with
FILE_NOT_FOUNDif the file does not exist on the device, withTIMEOUTif the timeout runs out, withEXPIREDif the run expires, and with the template's error message if processing fails.
See Run IDP template.
AI agent action
The Run an IDP template action lets the agent process a document with a template and answer based on the result. Each action uses a single template, chosen in its configuration: the agent never picks the template.
- Files up to 15 MB.
- If the timeout runs out, processing continues in the template and can be checked in Runs.
See Run an IDP template.
Calling templates through the API and the robot action depends on the workspace plan including IDP requests and webhooks. If a call is refused because the feature is missing, contact your account manager.