Creating a template
Create an IDP template from scratch, with a name and a reference document, or import a template exported as JSON, checking the workspace's connections.
Creating a template
To create a template, go to the workspace's Files tab, open the Create menu and choose IDP template — "Extracts data from invoices, forms and PDFs". There are two ways to start: From scratch or Import a file.
Only workspace developers and administrators can create IDP templates. See Roles and permissions.
From scratch
Name the template, upload a sample document and build the pipeline in the editor.
| Field | Required | Description |
|---|---|---|
| Name | Yes | 3 to 80 characters. Shown in the files tree and on every screen of the template. |
| Description | No | Up to 500 characters. Helps your colleagues understand what the template is for. |
| Workspace and Create in | Yes | The workspace and the folder the template is created in. The default folder is the root. |
| Reference document | Recommended | A PDF, PNG or JPG of up to 15 MB. Used for identification and as the playground's base. |
The reference document should be a typical example of the document the template will receive. Without it, identification checks the incoming document only against the type and the criteria you describe. It can be uploaded or replaced later, in the builder's Document stage. See Document and pages.
Click Create template to finish. The template opens in a new editor tab. If the template is created but the document upload fails, upload it from the Document stage.
Importing an exported template
Use this option to bring in a template exported from another workspace, or a copy you kept. The file is the JSON produced by Export JSON in the template's settings. See General.
- File — drop or choose the exported JSON. A file that is not an IDP template export is rejected. The template name comes filled in with the name stored in the file and can be changed (at least 3 characters). Also choose the target workspace and folder.
- Review — before creating anything, Roberty checks whether the connections used in the file exist in this workspace and shows which stages use each one: Default model, Identification, Extraction (LLM OCR) and Post-processing. For each missing connection, pick a connection from this workspace to replace it.
- Click Import.
You can import without resolving everything: connections that don't belong to this workspace are removed and must be chosen later in the editor. If the connections cannot be checked, importing is still available.
The imported template receives the file's configuration: the whole pipeline, the validations and the default model. The sample document is copied if you can access the source template; otherwise, upload one in the Document stage.
The exported file may contain credentials used by API validations. Treat it as sensitive data.
After creating it
A newly created template can already be tested, but it does not answer production calls yet. To get there:
- Build the pipeline — pages, filters, identification, extraction, post-processing and validations. See Builder.
- Test the draft in the Playground and in Simulate API. See Playground and Simulate API.
- Publish a version and make it active. See Versions.
- Call the template through the API, a robot or an agent. See Using templates in automations.