Ga naar inhoud

Prudai Developer API: registers

De operaties van dit onderdeel (Registers).

Basis-URL https://api.prudai.com/v1. Inloggen staat in Inloggen, scopes in Scopes en rechten, fouten in Fouten. Overzicht.

MethodePadWat het doetStand
GET/v1/tablesList organisation register tablesBinnenkort
POST/v1/tablesCreate a typed register table (Owner or Admin)Binnenkort
GET/v1/tables/{id}Read one register tableBinnenkort
PATCH/v1/tables/{id}Change table fields with a lossless conversion report (Owner or Admin)Binnenkort
DELETE/v1/tables/{id}Soft-delete a register table (Owner or Admin)Binnenkort
GET/v1/tables/{id}/exportExport records as CSV, XLSX or JSON in an envelopeBinnenkort
POST/v1/tables/{id}/importPreview or import CSV/XLSX with column mappingBinnenkort
POST/v1/tables/{id}/queryFilter, sort, aggregate and group register records in SQLBinnenkort
GET/v1/tables/{id}/recordsFilter, sort and paginate register recordsBinnenkort
POST/v1/tables/{id}/recordsCreate one register recordBinnenkort
GET/v1/tables/{id}/records/{rid}Read one register recordBinnenkort
PATCH/v1/tables/{id}/records/{rid}Merge record values with optimistic concurrencyBinnenkort
DELETE/v1/tables/{id}/records/{rid}Soft-delete a register recordBinnenkort
POST/v1/tables/{id}/records/{rid}/restoreRestore a register recordBinnenkort
POST/v1/tables/{id}/records/bulkCreate register records in one approved batchBinnenkort
POST/v1/tables/{id}/restoreRestore a register table (Owner or Admin)Binnenkort

List organisation register tables

GET /v1/tables

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:read
  • Goedkeuring: none, geen extra stap.

Parameters

  • include_deleted query · string
    Een van: true, false
  • limit query · integer
    min. 1 · max. 1000
  • cursor query · string
    max. lengte 10000
  • knowledge_base_id query · string
    max. lengte 100

Antwoorden

StatusBetekenis
200Result or read-only preview.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s "https://api.prudai.com/v1/tables" \
-H "Authorization: Bearer $PRUDAI_TOKEN"
CLI (binnenkort)
prudai leo tables list

Create a typed register table (Owner or Admin)

POST /v1/tables

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator. dryRun=true returns a preview without persisting records, schema or indexes. Mutations of existing rows require If-Match or version; stale versions return 409. Execution requires Idempotency-Key; exact request/grant retries return the stored result without running the write again.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:write
  • Goedkeuring: confirm, de gebruiker bevestigt precies deze aanroep.
  • Dry run: ?dryRun=true laat zien wat er zou gebeuren en slaat niets op.
  • Idempotentie: stuur Idempotency-Key mee; dezelfde sleutel met dezelfde body voert de actie niet twee keer uit.

Parameters

  • dryRun query · string
    Validate and preview with no persistent changes. Een van: true, false
  • Idempotency-Key header · string verplicht
    Required for execution; exact retries replay the stored result. Reusing the key for changed arguments is refused before approval. A preview needs no key. max. lengte 255

Body

JSON, verplicht.

  • name string verplicht
    max. lengte 200
  • description string
    max. lengte 10000
  • knowledge_base_id string
    max. lengte 100 · kan null zijn
  • schema array<TableField> verplicht
  • schema[].key string verplicht
    patroon ^[a-zA-Z][a-zA-Z0-9_]{0,62}$
  • schema[].label string verplicht
    max. lengte 200
  • schema[].type string verplicht
    Een van: text, number, amount, percentage, date, boolean, choice, multichoice, party, link
  • schema[].options array<string>
  • schema[].required boolean

Antwoorden

StatusBetekenis
200Result or read-only preview.
201Created.
202Waiting for the existing central human approval; repeat the exact request with x-prudai-approval after approval.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s -X POST "https://api.prudai.com/v1/tables" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"description": "string",
"knowledge_base_id": "string",
"schema": [
{
"key": "string",
"label": "string",
"type": "text",
"options": [
"string"
],
"required": false
}
]
}'
CLI (binnenkort)
prudai leo tables create

Read one register table

GET /v1/tables/{id}

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:read
  • Goedkeuring: none, geen extra stap.

Parameters

  • id path · string (uuid) verplicht
  • include_deleted query · string
    Een van: true, false

Antwoorden

StatusBetekenis
200Result or read-only preview.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s "https://api.prudai.com/v1/tables/<id>" \
-H "Authorization: Bearer $PRUDAI_TOKEN"
CLI (binnenkort)
prudai leo tables get

Change table fields with a lossless conversion report (Owner or Admin)

PATCH /v1/tables/{id}

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator. dryRun=true returns a preview without persisting records, schema or indexes. Mutations of existing rows require If-Match or version; stale versions return 409. A failed field conversion returns 409 with per-field failed counts and preserves all data.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:write
  • Goedkeuring: confirm, de gebruiker bevestigt precies deze aanroep.
  • Dry run: ?dryRun=true laat zien wat er zou gebeuren en slaat niets op.
  • Gelijktijdig wijzigen: stuur If-Match mee met de versie die je las.

Parameters

  • id path · string (uuid) verplicht
  • dryRun query · string
    Validate and preview with no persistent changes. Een van: true, false
  • If-Match header · string
    Current positive version, bare or double-quoted. Required unless body.version is provided.

Body

JSON, verplicht.

  • name string
    max. lengte 200
  • description string
    max. lengte 10000
  • knowledge_base_id string
    max. lengte 100 · kan null zijn
  • schema array<TableField>
  • schema[].key string verplicht
    patroon ^[a-zA-Z][a-zA-Z0-9_]{0,62}$
  • schema[].label string verplicht
    max. lengte 200
  • schema[].type string verplicht
    Een van: text, number, amount, percentage, date, boolean, choice, multichoice, party, link
  • schema[].options array<string>
  • schema[].required boolean
  • version integer
    min. 1

Antwoorden

StatusBetekenis
200Result or read-only preview.
202Waiting for the existing central human approval; repeat the exact request with x-prudai-approval after approval.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s -X PATCH "https://api.prudai.com/v1/tables/<id>" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"description": "string",
"knowledge_base_id": "string",
"schema": [
{
"key": "string",
"label": "string",
"type": "text",
"options": [
"string"
],
"required": false
}
],
"version": 1
}'
CLI (binnenkort)
prudai leo tables update

Soft-delete a register table (Owner or Admin)

DELETE /v1/tables/{id}

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator. dryRun=true returns a preview without persisting records, schema or indexes. Mutations of existing rows require If-Match or version; stale versions return 409.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:delete
  • Goedkeuring: review, een tweede persoon of rol keurt goed.
  • Dry run: ?dryRun=true laat zien wat er zou gebeuren en slaat niets op.
  • Gelijktijdig wijzigen: stuur If-Match mee met de versie die je las.
  • Verwijderen is zacht; zie Conventies.

Parameters

  • id path · string (uuid) verplicht
  • dryRun query · string
    Validate and preview with no persistent changes. Een van: true, false
  • If-Match header · string
    Current positive version, bare or double-quoted. Required unless body.version is provided.

Body

JSON, optioneel.

  • version integer
    min. 1

Antwoorden

StatusBetekenis
200Result or read-only preview.
202Waiting for the existing central human approval; repeat the exact request with x-prudai-approval after approval.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s -X DELETE "https://api.prudai.com/v1/tables/<id>" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"version": 1
}'
CLI (binnenkort)
prudai leo tables delete

Export records as CSV, XLSX or JSON in an envelope

GET /v1/tables/{id}/export

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator. data contains format, content, encoding (utf8 or base64) and count; exports the full filtered result up to 100,000 records. Cursor and limit are not supported and are rejected.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:read
  • Goedkeuring: none, geen extra stap.

Parameters

  • id path · string (uuid) verplicht
  • include_deleted query · string
    Een van: true, false
  • filters query · string
    JSON array of TableFilter objects. max. lengte 20000
  • sort query · string
    JSON array of TableSort objects. max. lengte 20000
  • format query · string
    Een van: csv, xlsx, json · standaard: "csv"

Antwoorden

StatusBetekenis
200Result or read-only preview.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s "https://api.prudai.com/v1/tables/<id>/export" \
-H "Authorization: Bearer $PRUDAI_TOKEN"
CLI (binnenkort)
prudai leo tables export

Preview or import CSV/XLSX with column mapping

POST /v1/tables/{id}/import

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator. dryRun=true returns a preview without persisting records, schema or indexes. Mutations of existing rows require If-Match or version; stale versions return 409. dryRun=true returns count, sample and row errors; apply waits for the central approval grant. Execution requires Idempotency-Key; exact request/grant retries return the stored result without running the write again.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:write
  • Goedkeuring: confirm, de gebruiker bevestigt precies deze aanroep.
  • Dry run: ?dryRun=true laat zien wat er zou gebeuren en slaat niets op.
  • Idempotentie: stuur Idempotency-Key mee; dezelfde sleutel met dezelfde body voert de actie niet twee keer uit.

Parameters

  • id path · string (uuid) verplicht
  • dryRun query · string
    Validate and preview with no persistent changes. Een van: true, false
  • Idempotency-Key header · string verplicht
    Required for execution; exact retries replay the stored result. Reusing the key for changed arguments is refused before approval. A preview needs no key. max. lengte 255

Body

JSON, verplicht.

  • format string verplicht
    Een van: csv, xlsx
  • content string verplicht
    CSV text or base64-encoded XLSX workbook. max. lengte 10000000
  • mapping object

Antwoorden

StatusBetekenis
200Result or read-only preview.
202Waiting for the existing central human approval; repeat the exact request with x-prudai-approval after approval.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s -X POST "https://api.prudai.com/v1/tables/<id>/import" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"format": "csv",
"content": "string",
"mapping": {}
}'
CLI (binnenkort)
prudai leo tables import

Filter, sort, aggregate and group register records in SQL

POST /v1/tables/{id}/query

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator. The result identifies the applied filters and matching count; next_cursor continues the same query.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:read
  • Goedkeuring: none, geen extra stap.

Parameters

  • id path · string (uuid) verplicht

Body

JSON, verplicht.

  • filters array<TableFilter>
  • filters[].field string verplicht
    max. lengte 100
  • filters[].op string verplicht
    Een van: eq, neq, lt, lte, gt, gte, between, in, contains, is_empty
  • filters[].value any
  • sort array<TableSort>
  • sort[].field string verplicht
    max. lengte 100
  • sort[].direction string
    Een van: asc, desc
  • limit integer
    min. 1 · max. 1000
  • cursor string
    max. lengte 10000
  • include_deleted boolean
  • group_by array<string>
  • aggregates array<object>
  • aggregates[].op string verplicht
    Een van: count, sum, avg, min, max, median
  • aggregates[].field string
    max. lengte 100
  • aggregates[].as string
    max. lengte 100

Antwoorden

StatusBetekenis
200Result or read-only preview.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s -X POST "https://api.prudai.com/v1/tables/<id>/query" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"filters": [
{
"field": "string",
"op": "eq",
"value": "string"
}
],
"sort": [
{
"field": "string",
"direction": "asc"
}
],
"limit": 1,
"cursor": "string",
"include_deleted": false,
"group_by": [
"string"
],
"aggregates": [
{
"op": "count",
"field": "string",
"as": "string"
}
]
}'
CLI (binnenkort)
prudai leo tables query

Filter, sort and paginate register records

GET /v1/tables/{id}/records

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator. The result identifies the applied filters and matching count; next_cursor continues the same query.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:read
  • Goedkeuring: none, geen extra stap.

Parameters

  • id path · string (uuid) verplicht
  • include_deleted query · string
    Een van: true, false
  • limit query · integer
    min. 1 · max. 1000
  • cursor query · string
    max. lengte 10000
  • filters query · string
    JSON array of TableFilter objects. max. lengte 20000
  • sort query · string
    JSON array of TableSort objects. max. lengte 20000

Antwoorden

StatusBetekenis
200Result or read-only preview.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s "https://api.prudai.com/v1/tables/<id>/records" \
-H "Authorization: Bearer $PRUDAI_TOKEN"
CLI (binnenkort)
prudai leo tables-records list

Create one register record

POST /v1/tables/{id}/records

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator. dryRun=true returns a preview without persisting records, schema or indexes. Mutations of existing rows require If-Match or version; stale versions return 409. Execution requires Idempotency-Key; exact request/grant retries return the stored result without running the write again.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:write
  • Goedkeuring: confirm, de gebruiker bevestigt precies deze aanroep.
  • Dry run: ?dryRun=true laat zien wat er zou gebeuren en slaat niets op.
  • Idempotentie: stuur Idempotency-Key mee; dezelfde sleutel met dezelfde body voert de actie niet twee keer uit.

Parameters

  • id path · string (uuid) verplicht
  • dryRun query · string
    Validate and preview with no persistent changes. Een van: true, false
  • Idempotency-Key header · string verplicht
    Required for execution; exact retries replay the stored result. Reusing the key for changed arguments is refused before approval. A preview needs no key. max. lengte 255

Body

JSON, verplicht.

  • data object verplicht
  • provenance object

Antwoorden

StatusBetekenis
200Result or read-only preview.
201Created.
202Waiting for the existing central human approval; repeat the exact request with x-prudai-approval after approval.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s -X POST "https://api.prudai.com/v1/tables/<id>/records" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"data": {},
"provenance": {}
}'
CLI (binnenkort)
prudai leo tables-records create

Read one register record

GET /v1/tables/{id}/records/{rid}

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:read
  • Goedkeuring: none, geen extra stap.

Parameters

  • id path · string (uuid) verplicht
  • rid path · string (uuid) verplicht
  • include_deleted query · string
    Een van: true, false

Antwoorden

StatusBetekenis
200Result or read-only preview.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s "https://api.prudai.com/v1/tables/<id>/records/<rid>" \
-H "Authorization: Bearer $PRUDAI_TOKEN"
CLI (binnenkort)
prudai leo tables-records get

Merge record values with optimistic concurrency

PATCH /v1/tables/{id}/records/{rid}

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator. dryRun=true returns a preview without persisting records, schema or indexes. Mutations of existing rows require If-Match or version; stale versions return 409.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:write
  • Goedkeuring: confirm, de gebruiker bevestigt precies deze aanroep.
  • Dry run: ?dryRun=true laat zien wat er zou gebeuren en slaat niets op.
  • Gelijktijdig wijzigen: stuur If-Match mee met de versie die je las.

Parameters

  • id path · string (uuid) verplicht
  • rid path · string (uuid) verplicht
  • dryRun query · string
    Validate and preview with no persistent changes. Een van: true, false
  • If-Match header · string
    Current positive version, bare or double-quoted. Required unless body.version is provided.

Body

JSON, verplicht.

  • data object verplicht
  • provenance object
  • version integer
    min. 1

Antwoorden

StatusBetekenis
200Result or read-only preview.
202Waiting for the existing central human approval; repeat the exact request with x-prudai-approval after approval.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s -X PATCH "https://api.prudai.com/v1/tables/<id>/records/<rid>" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"data": {},
"provenance": {},
"version": 1
}'
CLI (binnenkort)
prudai leo tables-records update

Soft-delete a register record

DELETE /v1/tables/{id}/records/{rid}

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator. dryRun=true returns a preview without persisting records, schema or indexes. Mutations of existing rows require If-Match or version; stale versions return 409.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:delete
  • Goedkeuring: review, een tweede persoon of rol keurt goed.
  • Dry run: ?dryRun=true laat zien wat er zou gebeuren en slaat niets op.
  • Gelijktijdig wijzigen: stuur If-Match mee met de versie die je las.
  • Verwijderen is zacht; zie Conventies.

Parameters

  • id path · string (uuid) verplicht
  • rid path · string (uuid) verplicht
  • dryRun query · string
    Validate and preview with no persistent changes. Een van: true, false
  • If-Match header · string
    Current positive version, bare or double-quoted. Required unless body.version is provided.

Body

JSON, optioneel.

  • version integer
    min. 1

Antwoorden

StatusBetekenis
200Result or read-only preview.
202Waiting for the existing central human approval; repeat the exact request with x-prudai-approval after approval.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s -X DELETE "https://api.prudai.com/v1/tables/<id>/records/<rid>" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"version": 1
}'
CLI (binnenkort)
prudai leo tables-records delete

Restore a register record

POST /v1/tables/{id}/records/{rid}/restore

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator. dryRun=true returns a preview without persisting records, schema or indexes. Mutations of existing rows require If-Match or version; stale versions return 409.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:write
  • Goedkeuring: confirm, de gebruiker bevestigt precies deze aanroep.
  • Dry run: ?dryRun=true laat zien wat er zou gebeuren en slaat niets op.
  • Gelijktijdig wijzigen: stuur If-Match mee met de versie die je las.

Parameters

  • id path · string (uuid) verplicht
  • rid path · string (uuid) verplicht
  • dryRun query · string
    Validate and preview with no persistent changes. Een van: true, false
  • If-Match header · string
    Current positive version, bare or double-quoted. Required unless body.version is provided.

Body

JSON, optioneel.

  • version integer
    min. 1

Antwoorden

StatusBetekenis
200Result or read-only preview.
202Waiting for the existing central human approval; repeat the exact request with x-prudai-approval after approval.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s -X POST "https://api.prudai.com/v1/tables/<id>/records/<rid>/restore" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"version": 1
}'
CLI (binnenkort)
prudai leo tables-records restore

Create register records in one approved batch

POST /v1/tables/{id}/records/bulk

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator. dryRun=true returns a preview without persisting records, schema or indexes. Mutations of existing rows require If-Match or version; stale versions return 409. Execution requires Idempotency-Key; exact request/grant retries return the stored result without running the write again.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:write
  • Goedkeuring: confirm, de gebruiker bevestigt precies deze aanroep.
  • Dry run: ?dryRun=true laat zien wat er zou gebeuren en slaat niets op.
  • Idempotentie: stuur Idempotency-Key mee; dezelfde sleutel met dezelfde body voert de actie niet twee keer uit.

Parameters

  • id path · string (uuid) verplicht
  • dryRun query · string
    Validate and preview with no persistent changes. Een van: true, false
  • Idempotency-Key header · string verplicht
    Required for execution; exact retries replay the stored result. Reusing the key for changed arguments is refused before approval. A preview needs no key. max. lengte 255

Body

JSON, verplicht.

  • records array<TableRecordInput> verplicht
  • records[].data object verplicht
  • records[].provenance object

Antwoorden

StatusBetekenis
200Result or read-only preview.
201Created.
202Waiting for the existing central human approval; repeat the exact request with x-prudai-approval after approval.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s -X POST "https://api.prudai.com/v1/tables/<id>/records/bulk" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"records": [
{
"data": {},
"provenance": {}
}
]
}'
CLI (binnenkort)
prudai leo tables-records bulk

Restore a register table (Owner or Admin)

POST /v1/tables/{id}/restore

Same organisation only; another organisation’s id returns 404. Every response uses the standard six-key envelope. Record writes require a writing role; schema changes and table restore require Owner or Admin. Service keys require an active, person-bound creator. dryRun=true returns a preview without persisting records, schema or indexes. Mutations of existing rows require If-Match or version; stale versions return 409.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:tables:write
  • Goedkeuring: confirm, de gebruiker bevestigt precies deze aanroep.
  • Dry run: ?dryRun=true laat zien wat er zou gebeuren en slaat niets op.
  • Gelijktijdig wijzigen: stuur If-Match mee met de versie die je las.

Parameters

  • id path · string (uuid) verplicht
  • dryRun query · string
    Validate and preview with no persistent changes. Een van: true, false
  • If-Match header · string
    Current positive version, bare or double-quoted. Required unless body.version is provided.

Body

JSON, optioneel.

  • version integer
    min. 1

Antwoorden

StatusBetekenis
200Result or read-only preview.
202Waiting for the existing central human approval; repeat the exact request with x-prudai-approval after approval.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution).
404Register or record does not exist in this organisation.
409Stale version or unconvertible field values; existing data is preserved.
422Invalid schema, query, mapping or missing version.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
curl
curl -s -X POST "https://api.prudai.com/v1/tables/<id>/restore" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"version": 1
}'
CLI (binnenkort)
prudai leo tables restore