API reference
Run, fetch, version.
The API is REST with JSON. The paths below are relative to the API address given in your account; authentication is the environment's key, in a header.
Authentication
One key per environment
- X-API-Key
- The key generated in the console. Each key is either test or production and has an expiry date.
- Test
- Unlimited, never bills and can't see production data.
- Idempotency-Key
- Optional on execution. The same key within 24 hours returns the same decision; the same key with a different input answers 409.
Run
Run the pipeline or just the policy
- POST /decision-platform/api/v1/execute
- Runs the published pipeline: fetches the sources, executes the policy and returns the outcome with its trace. Synchronous, in a single call.
- GET /decision-platform/api/v1/executions/:id
- The stored execution: inputs, output, timings and version.
- GET /decision-platform/api/v1/executions
- The list of executions, for reconciliation and audit.
- POST /decision-engine/api/v1/decisions/:id/execute
- Just the policy, no pipeline: you send the complete input and get the decision from the latest published version.
Policies and versions
The lifecycle, through the API
- POST /decision-engine/api/v1/decisions/:id/versions
- Creates a version from the DMN XML. The engine validates it before saving.
- GET /decision-engine/api/v1/versions/:id
- The version with the full DMN XML — this is how the policy leaves.
- POST /decision-engine/api/v1/versions/:id/publish
- Puts the version live. The next execution already uses it.
- POST /decision-engine/api/v1/versions/:id/archive
- Takes the version down; the previous published one takes effect again.
- GET /decision-engine/api/v1/execution-logs
- The record of each policy execution, with its trace.
Errors
Stable codes, readable messages
- 402 QUOTA_EXCEEDED
- The month's allowance is used up (the month follows the São Paulo calendar). The response says how much was used.
- 403 SUBACCOUNT_SUSPENDED
- The subaccount that called is suspended.
- 409
- The same Idempotency-Key was used with a different input.