API reference
Tables
A table is a schema: named, typed columns and how strictly to fill them.
The Table objectLink to section
created_atintegerRequiredAt least 0.
deleted_atintegerRequirednullableAt least 0.
updated_atintegerRequiredAt least 0.
idstringRequiredproject_idstringRequirednamestringRequiredslugstringRequiredcolumns_jsonarray of objectsRequired1 to 100 items.
currency_codestringoptionalExactly 3 characters.
defaultanyoptionaldescriptionstringoptionalnullableUp to 256 characters.
idstringRequired1 to 36 characters.
instructionstringoptionalnullableUp to 512 characters.
namestringRequired- Matches
^[\w\s.-]+$
1 to 64 characters.
optionsarray of stringsoptionalUp to 500 items.
requiredbooleanRequired- Default
false
searchablebooleanoptionaltypestringRequired- Allowed values
arraybooleancurrencydateemailenummulti_selectnumberstringtexturl- Default
string
{ "created_at": 1711468800000, "deleted_at": 1711468800000, "updated_at": 1711468800000, "id": "tbl_01h5a3g8k9m2n4p6q8r0t2v4x6", "project_id": "string", "name": "string", "slug": "string", "columns_json": [ { "currency_code": "string", "description": "string", "id": "string", "instruction": "string", "name": "string", "options": [ "string" ], "required": false, "searchable": true, "type": "string" } ], "instruction": "string", "strictness": "strict", "insert_mode": "append", "merge_columns_json": [ "string" ], "default_sort": "string", "row_count": 42, "usage_count": 42, "data_version": 42, "fts_version": 42, "last_used_at": 1711468800000}List tables
GET/v1/projects/{project_id}/tables
Requirestables:read
Path parameters
project_idstringRequired
Query parameters
cursorstringoptionalOpaque cursor for forward pagination. Pass the nextCursor from the previous response with the same order. Takes precedence over page when both are sent.
Up to 8192 characters.
orderstringoptionalSort keys, comma-separated, each
field[.asc|.desc][.nullsfirst|.nullslast]; at most 3. Sortable: created_at, name, row_count, last_used_at, updated_at. Default: created_at.desc. Nulls sort last ascending and first descending unless stated.- Matches
^(?:created_at|name|row_count|last_used_at|updated_at)(?:\.(?:asc|desc))?(?:\.(?:nullsfirst|nullslast))?(?:,(?:created_at|name|row_count|last_used_at|updated_at)(?:\.(?:asc|desc))?(?:\.(?:nullsfirst|nullslast))?){0,2}$
Up to 200 characters.
filterstringoptionalFilter expression
field.op.value;,joins conditions with AND; group withor(...)andand(...). Fields: created_at (number: eq, ne, neq, gt, gte, lt, lte, in, nin, is); id (string: eq, ne, neq, like, ilike, in, nin, is); name (string: eq, ne, neq, like, ilike, in, nin, is); row_count (number: eq, ne, neq, gt, gte, lt, lte, in, nin, is); slug (string: eq, ne, neq, like, ilike, in, nin, is).likeis case-sensitive andilikeignores ASCII case;*is the wildcard.in/nintake(a,b);istakesnullornotnull, andtrueorfalseon a boolean. At most 20 conditions, 3 nested groups, 50 in/nin values per list, 60 values in all, 50 bytes in a like or ilike pattern once escaped, and at most 4608 bytes however a URL or a form encodes it.Up to 2048 characters.
qstringoptionalFree-text search over: name. Whitespace-separated terms must all match; at most 8 terms, and at most 600 bytes however a URL or a form encodes it.
Up to 200 characters.
limitintegeroptionalMaximum number of items per page, in decimal digits. Defaults to 20, capped by the endpoint's maxLimit.
- Default
20
Between 1 and 100.
pageintegeroptional1-based page number for offset pagination, up to the endpoint's maxPage (x-comb); page further by cursor. A page that is no whole number from 1, in decimal digits, is a 400 invalid_page, and one past maxPage a 400 page_too_deep, with or without a cursor. Ignored when cursor is present.
Between 1 and 10000.
Returns
200application/json
countintegerRequirednullableAt least 0.
hasMorebooleanRequiredlimitintegerRequiredAt least 1.
nextCursorstringRequirednullablepageintegerRequirednullableAt least 1.
tablesarray of objectsRequiredcreated_atintegerRequiredAt least 0.
deleted_atintegerRequirednullableAt least 0.
updated_atintegerRequiredAt least 0.
idstringRequiredproject_idstringRequirednamestringRequiredslugstringRequiredcolumns_jsonarray of objectsRequired1 to 100 items.
currency_codestringoptionalExactly 3 characters.
defaultanyoptionaldescriptionstringoptionalnullableUp to 256 characters.
idstringRequired1 to 36 characters.
instructionstringoptionalnullableUp to 512 characters.
namestringRequired- Matches
^[\w\s.-]+$
1 to 64 characters.
optionsarray of stringsoptionalUp to 500 items.
requiredbooleanRequired- Default
false
searchablebooleanoptionaltypestringRequired- Allowed values
arraybooleancurrencydateemailenummulti_selectnumberstringtexturl- Default
string
instructionstringRequirednullablestrictnessstringRequired- Allowed values
strictbalancedflexible
insert_modestringRequired- Allowed values
appenddedupmergereplace
merge_columns_jsonarray of stringsRequirednullableAt least 1 items.
default_sortstringRequirednullablerow_countintegerRequiredusage_countintegerRequireddata_versionintegerRequiredfts_versionintegerRequiredlast_used_atintegerRequirednullable
curl 'https://api.anyrow.ai/v1/projects/{project_id}/tables' \ -H 'Authorization: ApiKey {your_api_key}'{ "count": 0, "hasMore": true, "limit": 1, "nextCursor": "string", "page": 1, "tables": [ { "created_at": 1711468800000, "deleted_at": 1711468800000, "updated_at": 1711468800000, "id": "tbl_01h5a3g8k9m2n4p6q8r0t2v4x6", "project_id": "string", "name": "string", "slug": "string", "columns_json": [ { "currency_code": "string", "description": "string", "id": "string", "instruction": "string", "name": "string", "options": [ "string" ], "required": false, "searchable": true, "type": "string" } ], "instruction": "string", "strictness": "strict", "insert_mode": "append", "merge_columns_json": [ "string" ], "default_sort": "string", "row_count": 42, "usage_count": 42, "data_version": 42, "fts_version": 42, "last_used_at": 1711468800000 } ]}Create table
POST/v1/projects/{project_id}/tables
Requirestables:write
Path parameters
project_idstringRequired
Request body
application/json
columns_jsonarray of objectsRequirednullable1 to 100 items.
currency_codestringoptionalExactly 3 characters.
defaultanyoptionaldescriptionstringoptionalnullableUp to 256 characters.
idstringRequired1 to 36 characters.
instructionstringoptionalnullableUp to 512 characters.
namestringRequired- Matches
^[\w\s.-]+$
1 to 64 characters.
optionsarray of stringsoptionalUp to 500 items.
requiredbooleanoptional- Default
false
searchablebooleanoptionaltypestringoptional- Allowed values
arraybooleancurrencydateemailenummulti_selectnumberstringtexturl- Default
string
insert_modestringoptional- Allowed values
appenddedupmergereplace
instructionstringoptionalnullableUp to 512 characters.
merge_columns_jsonarray of stringsoptionalnullableAt least 1 items.
namestringRequired1 to 128 characters.
strictnessstringoptional- Allowed values
strictbalancedflexible
Returns
201application/json
created_atintegerRequiredAt least 0.
deleted_atintegerRequirednullableAt least 0.
updated_atintegerRequiredAt least 0.
idstringRequiredproject_idstringRequirednamestringRequiredslugstringRequiredcolumns_jsonarray of objectsRequired1 to 100 items.
currency_codestringoptionalExactly 3 characters.
defaultanyoptionaldescriptionstringoptionalnullableUp to 256 characters.
idstringRequired1 to 36 characters.
instructionstringoptionalnullableUp to 512 characters.
namestringRequired- Matches
^[\w\s.-]+$
1 to 64 characters.
optionsarray of stringsoptionalUp to 500 items.
requiredbooleanRequired- Default
false
searchablebooleanoptionaltypestringRequired- Allowed values
arraybooleancurrencydateemailenummulti_selectnumberstringtexturl- Default
string
instructionstringRequirednullablestrictnessstringRequired- Allowed values
strictbalancedflexible
insert_modestringRequired- Allowed values
appenddedupmergereplace
merge_columns_jsonarray of stringsRequirednullableAt least 1 items.
default_sortstringRequirednullablerow_countintegerRequiredusage_countintegerRequireddata_versionintegerRequiredfts_versionintegerRequiredlast_used_atintegerRequirednullable
Errors
- 402
api_request_limit_exceededcolumn_limit_reachedfeature_not_availabletable_plan_limit - 404
not_found - 500
captcha_unavailableinternal_server_errortable_create_failed
curl -X POST 'https://api.anyrow.ai/v1/projects/{project_id}/tables' \ -H 'Authorization: ApiKey {your_api_key}' \ -H 'Content-Type: application/json' \ -d '{ "columns_json": [ { "currency_code": "string", "description": "string", "id": "string", "instruction": "string", "name": "string", "options": [ "string" ], "required": false, "searchable": true, "type": "string" } ], "insert_mode": "append", "instruction": "string", "merge_columns_json": [ "string" ], "name": "string", "strictness": "strict"}'{ "created_at": 1711468800000, "deleted_at": 1711468800000, "updated_at": 1711468800000, "id": "tbl_01h5a3g8k9m2n4p6q8r0t2v4x6", "project_id": "string", "name": "string", "slug": "string", "columns_json": [ { "currency_code": "string", "description": "string", "id": "string", "instruction": "string", "name": "string", "options": [ "string" ], "required": false, "searchable": true, "type": "string" } ], "instruction": "string", "strictness": "strict", "insert_mode": "append", "merge_columns_json": [ "string" ], "default_sort": "string", "row_count": 42, "usage_count": 42, "data_version": 42, "fts_version": 42, "last_used_at": 1711468800000}Get table
GET/v1/projects/{project_id}/tables/{table_id}
Requirestables:read
Path parameters
project_idstringRequiredtable_idstringRequired
Returns
200application/json
created_atintegerRequiredAt least 0.
deleted_atintegerRequirednullableAt least 0.
updated_atintegerRequiredAt least 0.
idstringRequiredproject_idstringRequirednamestringRequiredslugstringRequiredcolumns_jsonarray of objectsRequired1 to 100 items.
currency_codestringoptionalExactly 3 characters.
defaultanyoptionaldescriptionstringoptionalnullableUp to 256 characters.
idstringRequired1 to 36 characters.
instructionstringoptionalnullableUp to 512 characters.
namestringRequired- Matches
^[\w\s.-]+$
1 to 64 characters.
optionsarray of stringsoptionalUp to 500 items.
requiredbooleanRequired- Default
false
searchablebooleanoptionaltypestringRequired- Allowed values
arraybooleancurrencydateemailenummulti_selectnumberstringtexturl- Default
string
instructionstringRequirednullablestrictnessstringRequired- Allowed values
strictbalancedflexible
insert_modestringRequired- Allowed values
appenddedupmergereplace
merge_columns_jsonarray of stringsRequirednullableAt least 1 items.
default_sortstringRequirednullablerow_countintegerRequiredusage_countintegerRequireddata_versionintegerRequiredfts_versionintegerRequiredlast_used_atintegerRequirednullable
Errors
- 404
not_foundtable_not_found - 500
captcha_unavailableinternal_server_error
curl 'https://api.anyrow.ai/v1/projects/{project_id}/tables/{table_id}' \ -H 'Authorization: ApiKey {your_api_key}'{ "created_at": 1711468800000, "deleted_at": 1711468800000, "updated_at": 1711468800000, "id": "tbl_01h5a3g8k9m2n4p6q8r0t2v4x6", "project_id": "string", "name": "string", "slug": "string", "columns_json": [ { "currency_code": "string", "description": "string", "id": "string", "instruction": "string", "name": "string", "options": [ "string" ], "required": false, "searchable": true, "type": "string" } ], "instruction": "string", "strictness": "strict", "insert_mode": "append", "merge_columns_json": [ "string" ], "default_sort": "string", "row_count": 42, "usage_count": 42, "data_version": 42, "fts_version": 42, "last_used_at": 1711468800000}Update table
PATCH/v1/projects/{project_id}/tables/{table_id}
Requirestables:write
Path parameters
project_idstringRequiredtable_idstringRequired
Request body
application/json
default_sortstringoptionalnullableUp to 256 characters.
insert_modestringoptional- Allowed values
appenddedupmergereplace
instructionstringoptionalnullableUp to 512 characters.
merge_columns_jsonarray of stringsoptionalnullableAt least 1 items.
namestringoptional1 to 128 characters.
slugstringoptionalStored lowercased:
Quarterly Reportreads back asquarterly report.1 to 50 characters.
strictnessstringoptional- Allowed values
strictbalancedflexible
Returns
200application/json
created_atintegerRequiredAt least 0.
deleted_atintegerRequirednullableAt least 0.
updated_atintegerRequiredAt least 0.
idstringRequiredproject_idstringRequirednamestringRequiredslugstringRequiredcolumns_jsonarray of objectsRequired1 to 100 items.
currency_codestringoptionalExactly 3 characters.
defaultanyoptionaldescriptionstringoptionalnullableUp to 256 characters.
idstringRequired1 to 36 characters.
instructionstringoptionalnullableUp to 512 characters.
namestringRequired- Matches
^[\w\s.-]+$
1 to 64 characters.
optionsarray of stringsoptionalUp to 500 items.
requiredbooleanRequired- Default
false
searchablebooleanoptionaltypestringRequired- Allowed values
arraybooleancurrencydateemailenummulti_selectnumberstringtexturl- Default
string
instructionstringRequirednullablestrictnessstringRequired- Allowed values
strictbalancedflexible
insert_modestringRequired- Allowed values
appenddedupmergereplace
merge_columns_jsonarray of stringsRequirednullableAt least 1 items.
default_sortstringRequirednullablerow_countintegerRequiredusage_countintegerRequireddata_versionintegerRequiredfts_versionintegerRequiredlast_used_atintegerRequirednullable
Errors
- 404
not_foundtable_not_found - 409
table_project_id_slug_duplicate - 500
captcha_unavailableinternal_server_errortable_update_failed
curl -X PATCH 'https://api.anyrow.ai/v1/projects/{project_id}/tables/{table_id}' \ -H 'Authorization: ApiKey {your_api_key}' \ -H 'Content-Type: application/json' \ -d '{ "default_sort": "string", "insert_mode": "append", "instruction": "string", "merge_columns_json": [ "string" ], "name": "string", "slug": "string", "strictness": "strict"}'{ "created_at": 1711468800000, "deleted_at": 1711468800000, "updated_at": 1711468800000, "id": "tbl_01h5a3g8k9m2n4p6q8r0t2v4x6", "project_id": "string", "name": "string", "slug": "string", "columns_json": [ { "currency_code": "string", "description": "string", "id": "string", "instruction": "string", "name": "string", "options": [ "string" ], "required": false, "searchable": true, "type": "string" } ], "instruction": "string", "strictness": "strict", "insert_mode": "append", "merge_columns_json": [ "string" ], "default_sort": "string", "row_count": 42, "usage_count": 42, "data_version": 42, "fts_version": 42, "last_used_at": 1711468800000}Delete table (soft, 72h grace)
DELETE/v1/projects/{project_id}/tables/{table_id}
Requirestables:delete
Path parameters
project_idstringRequiredtable_idstringRequired
Returns
200application/json
idstringRequired
Errors
- 404
not_foundtable_not_found - 500
captcha_unavailableinternal_server_error
curl -X DELETE 'https://api.anyrow.ai/v1/projects/{project_id}/tables/{table_id}' \ -H 'Authorization: ApiKey {your_api_key}'{ "id": "string"}Duplicate table structure
POST/v1/projects/{project_id}/tables/{table_id}/duplicate
Requirestables:write
Path parameters
project_idstringRequiredtable_idstringRequired
Request body
application/json
namestringRequired1 to 128 characters.
slugstringRequiredStored lowercased:
Quarterly Reportreads back asquarterly report.1 to 50 characters.
Returns
201application/json
created_atintegerRequiredAt least 0.
deleted_atintegerRequirednullableAt least 0.
updated_atintegerRequiredAt least 0.
idstringRequiredproject_idstringRequirednamestringRequiredslugstringRequiredcolumns_jsonarray of objectsRequired1 to 100 items.
currency_codestringoptionalExactly 3 characters.
defaultanyoptionaldescriptionstringoptionalnullableUp to 256 characters.
idstringRequired1 to 36 characters.
instructionstringoptionalnullableUp to 512 characters.
namestringRequired- Matches
^[\w\s.-]+$
1 to 64 characters.
optionsarray of stringsoptionalUp to 500 items.
requiredbooleanRequired- Default
false
searchablebooleanoptionaltypestringRequired- Allowed values
arraybooleancurrencydateemailenummulti_selectnumberstringtexturl- Default
string
instructionstringRequirednullablestrictnessstringRequired- Allowed values
strictbalancedflexible
insert_modestringRequired- Allowed values
appenddedupmergereplace
merge_columns_jsonarray of stringsRequirednullableAt least 1 items.
default_sortstringRequirednullablerow_countintegerRequiredusage_countintegerRequireddata_versionintegerRequiredfts_versionintegerRequiredlast_used_atintegerRequirednullable
Errors
- 404
not_foundtable_not_found - 409
table_project_id_slug_duplicate - 500
captcha_unavailableinternal_server_errortable_duplicate_failed
curl -X POST 'https://api.anyrow.ai/v1/projects/{project_id}/tables/{table_id}/duplicate' \ -H 'Authorization: ApiKey {your_api_key}' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "slug": "string"}'{ "created_at": 1711468800000, "deleted_at": 1711468800000, "updated_at": 1711468800000, "id": "tbl_01h5a3g8k9m2n4p6q8r0t2v4x6", "project_id": "string", "name": "string", "slug": "string", "columns_json": [ { "currency_code": "string", "description": "string", "id": "string", "instruction": "string", "name": "string", "options": [ "string" ], "required": false, "searchable": true, "type": "string" } ], "instruction": "string", "strictness": "strict", "insert_mode": "append", "merge_columns_json": [ "string" ], "default_sort": "string", "row_count": 42, "usage_count": 42, "data_version": 42, "fts_version": 42, "last_used_at": 1711468800000}Restore deleted table
POST/v1/projects/{project_id}/tables/{table_id}/restore
Requirestables:write
Path parameters
project_idstringRequiredtable_idstringRequired
Request body
application/json
slugstringoptionalStored lowercased:
Quarterly Reportreads back asquarterly report.1 to 50 characters.
Returns
200application/json
created_atintegerRequiredAt least 0.
deleted_atintegerRequirednullableAt least 0.
updated_atintegerRequiredAt least 0.
idstringRequiredproject_idstringRequirednamestringRequiredslugstringRequiredcolumns_jsonarray of objectsRequired1 to 100 items.
currency_codestringoptionalExactly 3 characters.
defaultanyoptionaldescriptionstringoptionalnullableUp to 256 characters.
idstringRequired1 to 36 characters.
instructionstringoptionalnullableUp to 512 characters.
namestringRequired- Matches
^[\w\s.-]+$
1 to 64 characters.
optionsarray of stringsoptionalUp to 500 items.
requiredbooleanRequired- Default
false
searchablebooleanoptionaltypestringRequired- Allowed values
arraybooleancurrencydateemailenummulti_selectnumberstringtexturl- Default
string
instructionstringRequirednullablestrictnessstringRequired- Allowed values
strictbalancedflexible
insert_modestringRequired- Allowed values
appenddedupmergereplace
merge_columns_jsonarray of stringsRequirednullableAt least 1 items.
default_sortstringRequirednullablerow_countintegerRequiredusage_countintegerRequireddata_versionintegerRequiredfts_versionintegerRequiredlast_used_atintegerRequirednullable
Errors
- 404
not_foundtable_not_found - 409
table_project_id_slug_duplicate - 410
table_delete_expiredtable_soft_deleted - 500
captcha_unavailableinternal_server_errortable_restore_failed
curl -X POST 'https://api.anyrow.ai/v1/projects/{project_id}/tables/{table_id}/restore' \ -H 'Authorization: ApiKey {your_api_key}' \ -H 'Content-Type: application/json' \ -d '{ "slug": "string"}'{ "created_at": 1711468800000, "deleted_at": 1711468800000, "updated_at": 1711468800000, "id": "tbl_01h5a3g8k9m2n4p6q8r0t2v4x6", "project_id": "string", "name": "string", "slug": "string", "columns_json": [ { "currency_code": "string", "description": "string", "id": "string", "instruction": "string", "name": "string", "options": [ "string" ], "required": false, "searchable": true, "type": "string" } ], "instruction": "string", "strictness": "strict", "insert_mode": "append", "merge_columns_json": [ "string" ], "default_sort": "string", "row_count": 42, "usage_count": 42, "data_version": 42, "fts_version": 42, "last_used_at": 1711468800000}