SnozeDevelopers
API referenceData sources

Import a spreadsheet into a new database

Parses an uploaded or provider-hosted spreadsheet once and creates a database with the mapped fields and rows, returning the created database with its field, record, and skipped-row counts. Requires `databases:write`, plus `files:read` when importing an uploaded file. Malformed or oversized workbooks are rejected as validation errors; passing a `clientMutationId` makes the import replay-safe, and reusing one while its import is still running, or with different input, is reported as an in-progress or conflicting-mutation error. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.

POST
/v1/workspaces/{workspaceId}/data-sources/import-spreadsheet

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Path Parameters

workspaceId*string

Request Body

application/json
  1. body
parentItemId?string|null
label*string
kind*string
Value in"file""provider"
file?|null
provider?|null
fields*array<>
titleFieldKey?string|null
clientMutationId?string|null

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.snoze.dev/v1/workspaces/string/data-sources/import-spreadsheet' \  -H 'Content-Type: application/json' \  -d '{  "label": "string",  "kind": "file",  "fields": [    {      "sourcePath": "string",      "fieldKey": "string",      "label": "string",      "kind": "text"    }  ]}'
Example Response
{  "data": {    "databaseId": "string",    "itemId": "string",    "label": "string",    "fieldCount": 0,    "recordCount": 0,    "skippedRowCount": 0,    "sheetNameUsed": "string"  }}

Preview the rows a data source config would return

Fetches the source described by the request without persisting anything and returns a sample of rows with inferred columns, the JSON path or sheet that was used, and a warning when the source is empty. Requires `data_sources:write` rather than read, because a preview exercises stored connection secrets against a caller-supplied URL; HTTP sources are restricted to public addresses, and fetch failures come back as validation errors with secret values redacted. Sample size is capped at 50 rows (default 20).

Get a data source

Returns one data source with its configuration, schedule, latest status, and target database. Requires `data_sources:read` and view access to the data source's workspace item. Returns a not-found error when the workspace has no data source with that id.