For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Scout DocsAccess Scout
API & SDK
API & SDK
  • Endpoints
      • GETList all tables in a collection.
      • POSTCreate a table in a collection.
      • GETGet a table by ID.
      • PUTUpdate a table by ID.
      • DELDelete a table by ID.
      • GETGet a tables schema by ID.
      • POSTSync a table with a list of documents.
LogoLogo
Scout DocsAccess Scout
EndpointsTables

Create a table in a collection.

Beta
POST
https://api.scoutos.com/v2/collections/:collection_id/tables
POST
/v2/collections/:collection_id/tables
$curl -X POST https://api.scoutos.com/v2/collections/collection_id/tables \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "data": {
3    "table_config": {
4      "table_display_name": "Customer Orders",
5      "table_img_url": "https://example.com/images/customer_orders.png",
6      "table_description": "Table containing customer order details including status and fulfillment.",
7      "schema": [
8        {
9          "column_id": "order_status",
10          "column_display_name": "Order Status",
11          "column_type": "checkbox",
12          "data_type": "boolean",
13          "hidden": false,
14          "automation_config": {
15            "mode": "typescript",
16            "button_text": "Update Status",
17            "executing_text": "Updating...",
18            "function": "updateOrderStatus"
19          },
20          "default": false
21        }
22      ],
23      "icon_emoji": "📦",
24      "icon_asset_url": "https://example.com/icons/package_icon.svg",
25      "icon_fill": "#4A90E2",
26      "plural_name": "Customer Orders"
27    },
28    "created_by": {
29      "type": "user",
30      "details": {
31        "api_key": {}
32      }
33    },
34    "last_updated_by": {
35      "type": "user",
36      "details": {
37        "api_key": {}
38      }
39    },
40    "revision_id": "rev-20240115-001",
41    "table_id": "tbl-9f8b7c6d",
42    "index_id": "idx-3a2b1c4d",
43    "created_at": "2024-01-15T09:30:00Z",
44    "last_updated_at": "2024-01-15T09:30:00Z",
45    "collection_id": "col-7e6f5d4c",
46    "documents_uploading": false,
47    "migrated": false,
48    "agent_table_id": "agent-tbl-12345"
49  }
50}
Was this page helpful?
Previous

Get a table by ID.

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

collection_idstringRequired

Request

This endpoint expects an object.
table_display_namestringOptionalDefaults to Untitled
table_img_urlstring or nullOptional
table_descriptionstring or nullOptional
schemalist of objects or nullOptional
icon_emojistring or nullOptional
icon_asset_urlstring or nullOptional
icon_fillstring or nullOptional
plural_namestring or nullOptional
table_idstring or nullOptional

Optional user-provided table ID. Must be a lowercase slug (a-z, 0-9, hyphens, underscores) between 3 and 63 characters. If omitted, an ID is auto-generated.

Response

Successful Response
dataobject or null

Errors

422
Unprocessable Entity Error