Ga naar inhoud

Prudai Developer API: documenten en werkboeken

Document and workbook artifacts; personal tokens only, with the same source access and editing locks as the app.

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/artifactsList artifactsBinnenkort
GET/v1/artifacts/{id}Read an artifact range or blocksBinnenkort
PUT/v1/artifacts/{id}Write document content or workbook cellsBinnenkort
POST/v1/artifacts/{id}/editEdit one uniquely identified targetBinnenkort
GET/v1/artifacts/{id}/findFind text inside an artifactBinnenkort
GET/v1/artifacts/{id}/historyList artifact versionsBinnenkort
POST/v1/artifacts/{id}/restoreRestore an artifact versionBinnenkort
POST/v1/artifacts/{id}/structureChange document or workbook structureBinnenkort

List artifacts

GET /v1/artifacts

Personal tokens and signed-in user tokens only. The caller’s current organisation, product entitlement, document/conversation access and editing presence are rechecked. Writes use the existing human approval grant and expected_version; stale versions return 409 with the current state. AI document tools remain proposals until the user applies them. No deletion operation is exposed by this family; source deletion retains its soft-delete route.

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

Parameters

  • X-Product-Slug header · string verplicht
    Een van: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • offset query · integer
    standaard: 0 · min. 0
  • limit query · integer
    standaard: 50 · min. 1 · max. 100
  • scope_kind query · string verplicht
    Een van: project, conversation, workflow_run
  • scope_id query · string (uuid) verplicht

Antwoorden

StatusBetekenis
200Requested artifact data or exact change receipt, including completeness and next calls for pagination.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Artifact or historical version not found or inaccessible.
409Stale version or document editing lock; reload the current state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Artifact access cannot currently be verified.
curl
curl -s "https://api.prudai.com/v1/artifacts?scope_kind=project&scope_id=%3Cscope_id%3E" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "X-Product-Slug: leo"
CLI (binnenkort)
prudai leo artifacts list

Read an artifact range or blocks

GET /v1/artifacts/{id}

Personal tokens and signed-in user tokens only. The caller’s current organisation, product entitlement, document/conversation access and editing presence are rechecked. Writes use the existing human approval grant and expected_version; stale versions return 409 with the current state. AI document tools remain proposals until the user applies them. No deletion operation is exposed by this family; source deletion retains its soft-delete route.

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

Parameters

  • X-Product-Slug header · string verplicht
    Een van: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) verplicht
  • offset query · integer
    standaard: 0 · min. 0
  • limit query · integer
    standaard: 12000 · min. 1 · max. 30000
  • range query · string
    max. lengte 100
  • sheet query · string
    max. lengte 200
  • block_ids query · string
    Comma-separated block identifiers.

Antwoorden

StatusBetekenis
200Requested artifact data or exact change receipt, including completeness and next calls for pagination.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Artifact or historical version not found or inaccessible.
409Stale version or document editing lock; reload the current state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Artifact access cannot currently be verified.
curl
curl -s "https://api.prudai.com/v1/artifacts/<id>" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "X-Product-Slug: leo"
CLI (binnenkort)
prudai leo artifacts get

Write document content or workbook cells

PUT /v1/artifacts/{id}

Personal tokens and signed-in user tokens only. The caller’s current organisation, product entitlement, document/conversation access and editing presence are rechecked. Writes use the existing human approval grant and expected_version; stale versions return 409 with the current state. AI document tools remain proposals until the user applies them. No deletion operation is exposed by this family; source deletion retains its soft-delete route.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:artifacts:write
  • Goedkeuring: confirm, de gebruiker bevestigt precies deze aanroep.

Parameters

  • X-Product-Slug header · string verplicht
    Een van: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) verplicht
  • x-prudai-approval header · string
    Grant from the existing human approval route; absent means 202 with an approval request.

Body

JSON, verplicht.

  • expected_version integer verplicht
    min. 0
  • markdown string
    max. lengte 1000000
  • sheet string
    max. lengte 200
  • cells array<object>
  • cells[].ref string verplicht
    max. lengte 100
  • cells[].value string or number
  • cells[].formula string
    max. lengte 10000
  • cells[].format string
    Een van: percent, currency, number, integer, date, text

Antwoorden

StatusBetekenis
200Requested artifact data or exact change receipt, including completeness and next calls for pagination.
202Awaiting human approval; no artifact has changed.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Artifact or historical version not found or inaccessible.
409Stale version or document editing lock; reload the current state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Artifact access cannot currently be verified.
curl
curl -s -X PUT "https://api.prudai.com/v1/artifacts/<id>" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "X-Product-Slug: leo" \
-H "Content-Type: application/json" \
-d '"string"'
CLI (binnenkort)
prudai leo artifacts update

Edit one uniquely identified target

POST /v1/artifacts/{id}/edit

Personal tokens and signed-in user tokens only. The caller’s current organisation, product entitlement, document/conversation access and editing presence are rechecked. Writes use the existing human approval grant and expected_version; stale versions return 409 with the current state. AI document tools remain proposals until the user applies them. No deletion operation is exposed by this family; source deletion retains its soft-delete route.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:artifacts:write
  • Goedkeuring: confirm, de gebruiker bevestigt precies deze aanroep.

Parameters

  • X-Product-Slug header · string verplicht
    Een van: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) verplicht
  • x-prudai-approval header · string
    Grant from the existing human approval route; absent means 202 with an approval request.

Body

JSON, verplicht.

  • expected_version integer verplicht
    min. 0
  • original string
    max. lengte 1000000
  • replacement string or number verplicht
  • address string
    max. lengte 100
  • sheet string
    max. lengte 200

Antwoorden

StatusBetekenis
200Requested artifact data or exact change receipt, including completeness and next calls for pagination.
202Awaiting human approval; no artifact has changed.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Artifact or historical version not found or inaccessible.
409Stale version or document editing lock; reload the current state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Artifact access cannot currently be verified.
curl
curl -s -X POST "https://api.prudai.com/v1/artifacts/<id>/edit" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "X-Product-Slug: leo" \
-H "Content-Type: application/json" \
-d '"string"'
CLI (binnenkort)
prudai leo artifacts edit

Find text inside an artifact

GET /v1/artifacts/{id}/find

Personal tokens and signed-in user tokens only. The caller’s current organisation, product entitlement, document/conversation access and editing presence are rechecked. Writes use the existing human approval grant and expected_version; stale versions return 409 with the current state. AI document tools remain proposals until the user applies them. No deletion operation is exposed by this family; source deletion retains its soft-delete route.

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

Parameters

  • X-Product-Slug header · string verplicht
    Een van: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) verplicht
  • offset query · integer
    standaard: 0 · min. 0
  • limit query · integer
    standaard: 50 · min. 1 · max. 100
  • query query · string verplicht
    max. lengte 10000
  • sheet query · string
    max. lengte 200

Antwoorden

StatusBetekenis
200Requested artifact data or exact change receipt, including completeness and next calls for pagination.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Artifact or historical version not found or inaccessible.
409Stale version or document editing lock; reload the current state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Artifact access cannot currently be verified.
curl
curl -s "https://api.prudai.com/v1/artifacts/<id>/find?query=%3Cquery%3E" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "X-Product-Slug: leo"
CLI (binnenkort)
prudai leo artifacts find

List artifact versions

GET /v1/artifacts/{id}/history

Personal tokens and signed-in user tokens only. The caller’s current organisation, product entitlement, document/conversation access and editing presence are rechecked. Writes use the existing human approval grant and expected_version; stale versions return 409 with the current state. AI document tools remain proposals until the user applies them. No deletion operation is exposed by this family; source deletion retains its soft-delete route.

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

Parameters

  • X-Product-Slug header · string verplicht
    Een van: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) verplicht
  • offset query · integer
    standaard: 0 · min. 0
  • limit query · integer
    standaard: 50 · min. 1 · max. 100

Antwoorden

StatusBetekenis
200Requested artifact data or exact change receipt, including completeness and next calls for pagination.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Artifact or historical version not found or inaccessible.
409Stale version or document editing lock; reload the current state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Artifact access cannot currently be verified.
curl
curl -s "https://api.prudai.com/v1/artifacts/<id>/history" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "X-Product-Slug: leo"
CLI (binnenkort)
prudai leo artifacts history

Restore an artifact version

POST /v1/artifacts/{id}/restore

Personal tokens and signed-in user tokens only. The caller’s current organisation, product entitlement, document/conversation access and editing presence are rechecked. Writes use the existing human approval grant and expected_version; stale versions return 409 with the current state. AI document tools remain proposals until the user applies them. No deletion operation is exposed by this family; source deletion retains its soft-delete route.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:artifacts:write
  • Goedkeuring: confirm, de gebruiker bevestigt precies deze aanroep.

Parameters

  • X-Product-Slug header · string verplicht
    Een van: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) verplicht
  • x-prudai-approval header · string
    Grant from the existing human approval route; absent means 202 with an approval request.

Body

JSON, verplicht.

  • expected_version integer verplicht
    min. 0
  • version integer verplicht
    min. 0

Antwoorden

StatusBetekenis
200Requested artifact data or exact change receipt, including completeness and next calls for pagination.
202Awaiting human approval; no artifact has changed.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Artifact or historical version not found or inaccessible.
409Stale version or document editing lock; reload the current state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Artifact access cannot currently be verified.
curl
curl -s -X POST "https://api.prudai.com/v1/artifacts/<id>/restore" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "X-Product-Slug: leo" \
-H "Content-Type: application/json" \
-d '{
"expected_version": 1,
"version": 1
}'
CLI (binnenkort)
prudai leo artifacts restore

Change document or workbook structure

POST /v1/artifacts/{id}/structure

Personal tokens and signed-in user tokens only. The caller’s current organisation, product entitlement, document/conversation access and editing presence are rechecked. Writes use the existing human approval grant and expected_version; stale versions return 409 with the current state. AI document tools remain proposals until the user applies them. No deletion operation is exposed by this family; source deletion retains its soft-delete route.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:artifacts:write
  • Goedkeuring: confirm, de gebruiker bevestigt precies deze aanroep.

Parameters

  • X-Product-Slug header · string verplicht
    Een van: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) verplicht
  • x-prudai-approval header · string
    Grant from the existing human approval route; absent means 202 with an approval request.

Body

JSON, verplicht.

  • expected_version integer verplicht
    min. 0
  • op string verplicht
    Een van: insert_rows, delete_rows, insert_columns, delete_columns, hide_rows, unhide_rows, hide_columns, unhide_columns, row_height, column_width, add_sheet, rename_sheet, delete_sheet, copy_sheet, move_sheet, hide_sheet, unhide_sheet, tab_color, sort, merge, unmerge, freeze, format, set_name, delete_name, set_filter, clear_filter, set_validation, clear_validation, add_conditional_format, clear_conditional_formats, set_note, delete_note, set_hyperlink, remove_hyperlink, set_heading, insert_section, delete_section
  • sheet string
    max. lengte 200
  • params object

Antwoorden

StatusBetekenis
200Requested artifact data or exact change receipt, including completeness and next calls for pagination.
202Awaiting human approval; no artifact has changed.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Artifact or historical version not found or inaccessible.
409Stale version or document editing lock; reload the current state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Artifact access cannot currently be verified.
curl
curl -s -X POST "https://api.prudai.com/v1/artifacts/<id>/structure" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "X-Product-Slug: leo" \
-H "Content-Type: application/json" \
-d '{
"expected_version": 1,
"op": "insert_rows",
"sheet": "string",
"params": {}
}'
CLI (binnenkort)
prudai leo artifacts structure