Permissions
Which API-key role each operation requires.
An API key carries one role. Roles are flat — admin does not implicitly satisfy an editor-only route — and an operation that needs a role your key does not have answers 403 with the code FORBIDDEN.
Operations not listed accept any valid key.
| Operation | Roles |
|---|---|
POST /extractions | admin, editor |
PATCH /extractions/{id} | admin, editor |
DELETE /extractions/{id} | admin |
POST /extractions/{id}/documents | admin, editor |
POST /extractions/{id}/promote | admin, editor |
PATCH /extractions/{id}/validation/data-points | admin, editor |
PATCH /extractions/{id}/validation/data-points/{dataPointId} | admin, editor |
POST /documents | admin, editor |
PATCH /documents/{id} | admin, editor |
PATCH /documents/metadata | admin, editor |
DELETE /documents/{id} | admin |
POST /documents/process | admin, editor |
POST /extraction-sessions | admin, editor |
PUT /data-groups/{id}/schema | admin, editor |
POST /jobs/{jobId}/cancel | admin, editor |
GET /api-keys | admin |
POST /api-keys | admin |
PATCH /api-keys/{id} | admin |
DELETE /api-keys/{id} | admin |
POST /api-keys/{id}/rotate | admin |
GET /webhook-endpoints | admin |
POST /webhook-endpoints | admin |
GET /webhook-endpoints/{id} | admin |
PATCH /webhook-endpoints/{id} | admin |
DELETE /webhook-endpoints/{id} | admin |
POST /webhook-endpoints/{id}/rotate | admin |
POST /webhook-endpoints/{id}/test | admin |
GET /webhook-endpoints/{id}/deliveries | admin, editor |
POST /webhook-endpoints/{id}/deliveries/{deliveryId}/redeliver | admin |