Skip to content

Prudai Developer API: registers

The operations of this part (Registers).

Base URL https://api.prudai.com/v1. Logging in is in Login, scopes in Scopes and permissions, errors in Errors. Overview.

MethodPathWhat it doesState
GET/v1/tablesList organisation register tablesComing soon
POST/v1/tablesCreate a typed register table (Owner or Admin)Coming soon
GET/v1/tables/{id}Read one register tableComing soon
PATCH/v1/tables/{id}Change table fields with a lossless conversion report (Owner or Admin)Coming soon
DELETE/v1/tables/{id}Soft-delete a register table (Owner or Admin)Coming soon
GET/v1/tables/{id}/exportExport records as CSV, XLSX or JSON in an envelopeComing soon
POST/v1/tables/{id}/importPreview or import CSV/XLSX with column mappingComing soon
POST/v1/tables/{id}/queryFilter, sort, aggregate and group register records in SQLComing soon
GET/v1/tables/{id}/recordsFilter, sort and paginate register recordsComing soon
POST/v1/tables/{id}/recordsCreate one register recordComing soon
GET/v1/tables/{id}/records/{rid}Read one register recordComing soon
PATCH/v1/tables/{id}/records/{rid}Merge record values with optimistic concurrencyComing soon
DELETE/v1/tables/{id}/records/{rid}Soft-delete a register recordComing soon
POST/v1/tables/{id}/records/{rid}/restoreRestore a register recordComing soon
POST/v1/tables/{id}/records/bulkCreate register records in one approved batchComing soon
POST/v1/tables/{id}/restoreRestore a register table (Owner or Admin)Coming soon

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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:read
  • Approval: none, no extra step.

Parameters

  • include_deleted query · string
    One of: true, false
  • limit query · integer
    min 1 · max 1000
  • cursor query · string
    max length 10000
  • knowledge_base_id query · string
    max length 100

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:write
  • Approval: confirm, the user confirms exactly this call.
  • Dry run: ?dryRun=true shows what would happen and stores nothing.
  • Idempotency: send Idempotency-Key; the same key with the same body does not run the action twice.

Parameters

  • dryRun query · string
    Validate and preview with no persistent changes. One of: true, false
  • Idempotency-Key header · string required
    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 length 255

Body

JSON, required.

  • name string required
    max length 200
  • description string
    max length 10000
  • knowledge_base_id string
    max length 100 · may be null
  • schema array<TableField> required
  • schema[].key string required
    pattern ^[a-zA-Z][a-zA-Z0-9_]{0,62}$
  • schema[].label string required
    max length 200
  • schema[].type string required
    One of: text, number, amount, percentage, date, boolean, choice, multichoice, party, link
  • schema[].options array<string>
  • schema[].required boolean

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:read
  • Approval: none, no extra step.

Parameters

  • id path · string (uuid) required
  • include_deleted query · string
    One of: true, false

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:write
  • Approval: confirm, the user confirms exactly this call.
  • Dry run: ?dryRun=true shows what would happen and stores nothing.
  • Concurrent changes: send If-Match with the version you read.

Parameters

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

Body

JSON, required.

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

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:delete
  • Approval: review, a second person or role approves.
  • Dry run: ?dryRun=true shows what would happen and stores nothing.
  • Concurrent changes: send If-Match with the version you read.
  • Deleting is soft; see Conventions.

Parameters

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

Body

JSON, optional.

  • version integer
    min 1

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:read
  • Approval: none, no extra step.

Parameters

  • id path · string (uuid) required
  • include_deleted query · string
    One of: true, false
  • filters query · string
    JSON array of TableFilter objects. max length 20000
  • sort query · string
    JSON array of TableSort objects. max length 20000
  • format query · string
    One of: csv, xlsx, json · default: "csv"

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:write
  • Approval: confirm, the user confirms exactly this call.
  • Dry run: ?dryRun=true shows what would happen and stores nothing.
  • Idempotency: send Idempotency-Key; the same key with the same body does not run the action twice.

Parameters

  • id path · string (uuid) required
  • dryRun query · string
    Validate and preview with no persistent changes. One of: true, false
  • Idempotency-Key header · string required
    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 length 255

Body

JSON, required.

  • format string required
    One of: csv, xlsx
  • content string required
    CSV text or base64-encoded XLSX workbook. max length 10000000
  • mapping object

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:read
  • Approval: none, no extra step.

Parameters

  • id path · string (uuid) required

Body

JSON, required.

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

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:read
  • Approval: none, no extra step.

Parameters

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

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:write
  • Approval: confirm, the user confirms exactly this call.
  • Dry run: ?dryRun=true shows what would happen and stores nothing.
  • Idempotency: send Idempotency-Key; the same key with the same body does not run the action twice.

Parameters

  • id path · string (uuid) required
  • dryRun query · string
    Validate and preview with no persistent changes. One of: true, false
  • Idempotency-Key header · string required
    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 length 255

Body

JSON, required.

  • data object required
  • provenance object

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:read
  • Approval: none, no extra step.

Parameters

  • id path · string (uuid) required
  • rid path · string (uuid) required
  • include_deleted query · string
    One of: true, false

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:write
  • Approval: confirm, the user confirms exactly this call.
  • Dry run: ?dryRun=true shows what would happen and stores nothing.
  • Concurrent changes: send If-Match with the version you read.

Parameters

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

Body

JSON, required.

  • data object required
  • provenance object
  • version integer
    min 1

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:delete
  • Approval: review, a second person or role approves.
  • Dry run: ?dryRun=true shows what would happen and stores nothing.
  • Concurrent changes: send If-Match with the version you read.
  • Deleting is soft; see Conventions.

Parameters

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

Body

JSON, optional.

  • version integer
    min 1

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:write
  • Approval: confirm, the user confirms exactly this call.
  • Dry run: ?dryRun=true shows what would happen and stores nothing.
  • Concurrent changes: send If-Match with the version you read.

Parameters

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

Body

JSON, optional.

  • version integer
    min 1

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:write
  • Approval: confirm, the user confirms exactly this call.
  • Dry run: ?dryRun=true shows what would happen and stores nothing.
  • Idempotency: send Idempotency-Key; the same key with the same body does not run the action twice.

Parameters

  • id path · string (uuid) required
  • dryRun query · string
    Validate and preview with no persistent changes. One of: true, false
  • Idempotency-Key header · string required
    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 length 255

Body

JSON, required.

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

Responses

StatusMeaning
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 (coming soon)
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.

  • State: coming soon, not in production yet.
  • Scope: prudai:tables:write
  • Approval: confirm, the user confirms exactly this call.
  • Dry run: ?dryRun=true shows what would happen and stores nothing.
  • Concurrent changes: send If-Match with the version you read.

Parameters

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

Body

JSON, optional.

  • version integer
    min 1

Responses

StatusMeaning
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 (coming soon)
prudai leo tables restore