NaceDocs
DashboardGet an API key
DocumentationAPI ReferenceSDKsCLI

Workspaces

Query the metadata catalog

Other errors (500, 502, 503, 504) are on Errors.

POST
/v1/workspaces/{id}/tools/catalog

Other errors (500, 502, 503, 504) are on Errors.

Authorization

bearerAuth
AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer nace_sk_...

  • Where: the dashboard's API Keys page. It is shown once, when you create it.
  • Format: nace_sk_ followed by 43 URL-safe characters (A-Z, a-z, 0-9, _ and -).
  • Limit: an account can hold at most 3 active keys.
  • Wrong or missing key: returns 401 authentication_error.

In: header

Path Parameters

idstringrequired

The workspace's workspace_id.

Header Parameters

Idempotency-Keystring

Up to 200 characters, unique per account. A call that timed out keeps running: send it again with the same key and body to get its answer instead of running it twice.

Lengthlength <= 200

Request Body

application/json

sqlstring | null

One read-only SELECT (or WITH ... SELECT, DuckDB dialect) over the catalog tables; omit it to list the tables.

Length1 <= length
Show variants

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/workspaces/string/tools/catalog" \  -H "Content-Type: application/json" \  -d '{    "sql": "SELECT source_path, page_start, total_amount FROM invoice WHERE total_amount > 50000 ORDER BY total_amount DESC"  }'
{  "tables": [    {}  ],  "empty_tables": [    {}  ],  "columns": [    "string"  ],  "rows": [    {}  ],  "row_count": 0,  "truncated": true}

Describe a folder POST

Describes one folder of the workspace without reading its files: how many files it holds (or its whole subtree, recursive), their counts per category and ingestion status, its subfolders, and one page of its files' paths.

List domains GET

The domains this key's account sees: the platform's and its own, every version.