Prudai Developer API: artifacts
The operations of this part (Artifacts).
Base URL https://api.prudai.com/v1. Logging in is in Login, scopes in Scopes and permissions, errors in Errors. Overview.
| Method | Path | What it does | State |
|---|---|---|---|
GET | /v1/artifacts | List artifacts | Coming soon |
GET | /v1/artifacts/{id} | Read an artifact range or blocks | Coming soon |
PUT | /v1/artifacts/{id} | Write document content or workbook cells | Coming soon |
POST | /v1/artifacts/{id}/edit | Edit one uniquely identified target | Coming soon |
GET | /v1/artifacts/{id}/find | Find text inside an artifact | Coming soon |
GET | /v1/artifacts/{id}/history | List artifact versions | Coming soon |
POST | /v1/artifacts/{id}/restore | Restore an artifact version | Coming soon |
POST | /v1/artifacts/{id}/structure | Change document or workbook structure | Coming soon |
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.
- State: coming soon, not in production yet.
- Scope:
prudai:artifacts:read - Approval:
none, no extra step.
Parameters
X-Product-Slugrequired
One of:leo,leo-fiscaal,zia,vera,bever,irma,maiaoffset
default:0· min 0limit
default:50· min 1 · max 100scope_kindrequired
One of:project,conversation,workflow_runscope_idrequired
Responses
| Status | Meaning |
|---|---|
200 | Requested artifact data or exact change receipt, including completeness and next calls for pagination. |
400 | Malformed request or unsupported parameter (for example client-sent tools). |
401 | Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment. |
403 | Authenticated, 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). |
404 | Artifact or historical version not found or inaccessible. |
409 | Stale version or document editing lock; reload the current state. |
422 | Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body). |
429 | Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded. |
503 | Artifact access cannot currently be verified. |
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"prudai leo artifacts listRead 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.
- State: coming soon, not in production yet.
- Scope:
prudai:artifacts:read - Approval:
none, no extra step.
Parameters
X-Product-Slugrequired
One of:leo,leo-fiscaal,zia,vera,bever,irma,maiaidrequiredoffset
default:0· min 0limit
default:12000· min 1 · max 30000range
max length 100sheet
max length 200block_ids
Comma-separated block identifiers.
Responses
| Status | Meaning |
|---|---|
200 | Requested artifact data or exact change receipt, including completeness and next calls for pagination. |
400 | Malformed request or unsupported parameter (for example client-sent tools). |
401 | Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment. |
403 | Authenticated, 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). |
404 | Artifact or historical version not found or inaccessible. |
409 | Stale version or document editing lock; reload the current state. |
422 | Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body). |
429 | Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded. |
503 | Artifact access cannot currently be verified. |
curl -s "https://api.prudai.com/v1/artifacts/<id>" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo"prudai leo artifacts getWrite 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.
- State: coming soon, not in production yet.
- Scope:
prudai:artifacts:write - Approval:
confirm, the user confirms exactly this call.
Parameters
X-Product-Slugrequired
One of:leo,leo-fiscaal,zia,vera,bever,irma,maiaidrequiredx-prudai-approval
Grant from the existing human approval route; absent means 202 with an approval request.
Body
JSON, required.
expected_versionrequired
min 0markdown
max length 1000000sheet
max length 200cellscells[].refrequired
max length 100cells[].valuecells[].formula
max length 10000cells[].format
One of:percent,currency,number,integer,date,text
Responses
| Status | Meaning |
|---|---|
200 | Requested artifact data or exact change receipt, including completeness and next calls for pagination. |
202 | Awaiting human approval; no artifact has changed. |
400 | Malformed request or unsupported parameter (for example client-sent tools). |
401 | Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment. |
403 | Authenticated, 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). |
404 | Artifact or historical version not found or inaccessible. |
409 | Stale version or document editing lock; reload the current state. |
422 | Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body). |
429 | Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded. |
503 | Artifact access cannot currently be verified. |
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"'prudai leo artifacts updateEdit 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.
- State: coming soon, not in production yet.
- Scope:
prudai:artifacts:write - Approval:
confirm, the user confirms exactly this call.
Parameters
X-Product-Slugrequired
One of:leo,leo-fiscaal,zia,vera,bever,irma,maiaidrequiredx-prudai-approval
Grant from the existing human approval route; absent means 202 with an approval request.
Body
JSON, required.
expected_versionrequired
min 0original
max length 1000000replacementrequiredaddress
max length 100sheet
max length 200
Responses
| Status | Meaning |
|---|---|
200 | Requested artifact data or exact change receipt, including completeness and next calls for pagination. |
202 | Awaiting human approval; no artifact has changed. |
400 | Malformed request or unsupported parameter (for example client-sent tools). |
401 | Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment. |
403 | Authenticated, 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). |
404 | Artifact or historical version not found or inaccessible. |
409 | Stale version or document editing lock; reload the current state. |
422 | Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body). |
429 | Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded. |
503 | Artifact access cannot currently be verified. |
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"'prudai leo artifacts editFind 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.
- State: coming soon, not in production yet.
- Scope:
prudai:artifacts:read - Approval:
none, no extra step.
Parameters
X-Product-Slugrequired
One of:leo,leo-fiscaal,zia,vera,bever,irma,maiaidrequiredoffset
default:0· min 0limit
default:50· min 1 · max 100queryrequired
max length 10000sheet
max length 200
Responses
| Status | Meaning |
|---|---|
200 | Requested artifact data or exact change receipt, including completeness and next calls for pagination. |
400 | Malformed request or unsupported parameter (for example client-sent tools). |
401 | Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment. |
403 | Authenticated, 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). |
404 | Artifact or historical version not found or inaccessible. |
409 | Stale version or document editing lock; reload the current state. |
422 | Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body). |
429 | Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded. |
503 | Artifact access cannot currently be verified. |
curl -s "https://api.prudai.com/v1/artifacts/<id>/find?query=%3Cquery%3E" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo"prudai leo artifacts findList 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.
- State: coming soon, not in production yet.
- Scope:
prudai:artifacts:read - Approval:
none, no extra step.
Parameters
X-Product-Slugrequired
One of:leo,leo-fiscaal,zia,vera,bever,irma,maiaidrequiredoffset
default:0· min 0limit
default:50· min 1 · max 100
Responses
| Status | Meaning |
|---|---|
200 | Requested artifact data or exact change receipt, including completeness and next calls for pagination. |
400 | Malformed request or unsupported parameter (for example client-sent tools). |
401 | Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment. |
403 | Authenticated, 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). |
404 | Artifact or historical version not found or inaccessible. |
409 | Stale version or document editing lock; reload the current state. |
422 | Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body). |
429 | Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded. |
503 | Artifact access cannot currently be verified. |
curl -s "https://api.prudai.com/v1/artifacts/<id>/history" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo"prudai leo artifacts historyRestore 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.
- State: coming soon, not in production yet.
- Scope:
prudai:artifacts:write - Approval:
confirm, the user confirms exactly this call.
Parameters
X-Product-Slugrequired
One of:leo,leo-fiscaal,zia,vera,bever,irma,maiaidrequiredx-prudai-approval
Grant from the existing human approval route; absent means 202 with an approval request.
Body
JSON, required.
expected_versionrequired
min 0versionrequired
min 0
Responses
| Status | Meaning |
|---|---|
200 | Requested artifact data or exact change receipt, including completeness and next calls for pagination. |
202 | Awaiting human approval; no artifact has changed. |
400 | Malformed request or unsupported parameter (for example client-sent tools). |
401 | Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment. |
403 | Authenticated, 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). |
404 | Artifact or historical version not found or inaccessible. |
409 | Stale version or document editing lock; reload the current state. |
422 | Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body). |
429 | Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded. |
503 | Artifact access cannot currently be verified. |
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 }'prudai leo artifacts restoreChange 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.
- State: coming soon, not in production yet.
- Scope:
prudai:artifacts:write - Approval:
confirm, the user confirms exactly this call.
Parameters
X-Product-Slugrequired
One of:leo,leo-fiscaal,zia,vera,bever,irma,maiaidrequiredx-prudai-approval
Grant from the existing human approval route; absent means 202 with an approval request.
Body
JSON, required.
expected_versionrequired
min 0oprequired
One of: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_sectionsheet
max length 200params
Responses
| Status | Meaning |
|---|---|
200 | Requested artifact data or exact change receipt, including completeness and next calls for pagination. |
202 | Awaiting human approval; no artifact has changed. |
400 | Malformed request or unsupported parameter (for example client-sent tools). |
401 | Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment. |
403 | Authenticated, 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). |
404 | Artifact or historical version not found or inaccessible. |
409 | Stale version or document editing lock; reload the current state. |
422 | Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body). |
429 | Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded. |
503 | Artifact access cannot currently be verified. |
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": {} }'prudai leo artifacts structure