Skip to main content

Processing Configs

Discover the named processing configurations available to your workspace with GET /v1/configs, including credit cost and pipeline steps for each one.

Processing configurations are the named pipelines the POST /v1/process endpoint runs documents through. The GET /v1/configs endpoint lists every configuration available to your organization so you can discover the config_id values to submit against, and GET /v1/configs/:id reads a single configuration to inspect its settings.

Each configuration reports its credit_cost and the pipeline steps it executes (for example extract, structure, reconcile), so you can predict spend and understand what a run will produce before submitting documents.

GET/v1/configs
GET/v1/configs/:id

Path parameters

id*stringThe configuration id.

curl

curl -s https://api.talonic.com/v1/configs \
  -H "Authorization: Bearer tlnc_your_api_key"

Response

Config fields

config_idstringThe identifier you pass to POST /v1/process.
namestringHuman-readable configuration name.
descriptionstringWhat the configuration does.
credit_costintegerCredits charged per run through this configuration.
stepsstring[]Pipeline steps the configuration executes (e.g. extract, structure, reconcile).

Response

{
  "data": [
    {
      "config_id": "cfg_bridgeway_invoice_v1",
      "name": "Bridgeway Invoices",
      "description": "Extract, structure, and reconcile inbound invoices.",
      "credit_cost": 12,
      "steps": ["extract", "structure", "reconcile"]
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundGET /v1/configs/:id only: no configuration with this id exists.

Frequently asked questions

Where do config IDs come from?+
From GET /v1/configs. Each entry has a config_id you pass when submitting a document to POST /v1/process. Configurations are provisioned for your organization, so the list is workspace-specific.
What does credit_cost mean on a config?+
It is the number of credits charged for one run through that configuration. Use it together with your credit balance to predict spend before submitting a batch of documents.
What are the steps in a processing configuration?+
The steps array names the pipeline stages the configuration executes, such as extract, structure, and reconcile. The run status mirrors them (step_extract, step_structure, step_reconcile) while a document is being processed.

Related

Submit for Processing
Get Run