Execute data operations

Execute CRUD operations on table data.

Operations:

• read: Retrieve records with optional filtering and pagination
• create: Insert new records
• update: Update existing records (use override for full replacement)
• delete: Remove records matching filters

Filtering: Use the filters parameter to filter records by field values. Example: {"document_id": "550e8400-e29b-41d4-a716-446655440000"}

Column Selection: Use the columns parameter to specify which fields to return in the response.

POST /projects/{project_id}/tables/{table_id}/data-operations

Python

read

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tables/{table_id}/data-operations/"

payload = {
    "operation": "read",
    "filters": { "document_id": "550e8400-e29b-41d4-a716-446655440000" },
    "columns": ["id", "content", "document_id"],
    "limit": 50,
    "offset": 0
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

200

{
  "data": [
    {}
  ],
  "count": 123,
  "success": true
}

Authorizations

BearerAuthTokenAuth

Authorization · string · header · required

Use Authorization: Bearer

Path Parameters

project_id · string<uuid> · required

UUID of the project

table_id · string<uuid> · required

UUID of the table

Body

application/json

operation · enum<string> · required

Type of data operation:

• read: Retrieve records with optional filtering
• create: Insert new records
• update: Update existing records
• delete: Remove records

Available options: read, create, update, delete

data · object[]

Array of records for create/update operations

filters · object

Dictionary of field-value pairs to filter records. Example: {"document_id": "550e8400-e29b-41d4-a716-446655440000"}

columns · string[]

List of column names to include in the response

Example:

["id", "content", "document_id"]

override · boolean · default: false

For update operations, whether to fully replace records

table_version_id · string<uuid>

Optional UUID to target a specific table version

limit · integer · default: 100

Maximum number of records to return (for read operations)

offset · integer · default: 0

Number of records to skip for pagination (for read operations)

Response

200

application/json

Operation executed successfully

Response from a data operation

data · object[]

Array of result records (for read operations)

count · integer

Total number of affected/returned records

success · boolean

Whether the operation completed successfully