Skip to main content
POST
/
v1
/
export
Create an export
curl --request POST \
  --url https://api.withsplendor.com/v1/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-splendor-tenant-id: <x-splendor-tenant-id>' \
  --data '
{
  "aggregations": [
    {
      "field": "<string>",
      "name": "<string>",
      "interval": "<string>",
      "percents": [
        123
      ],
      "size": 10
    }
  ],
  "content_filter": "text",
  "cursor": "<string>",
  "dataset_scope": "selected",
  "datasets": [
    "<string>"
  ],
  "format": "ndjson",
  "limit": 20,
  "max_expansion_terms": 10,
  "max_rows": 1000000,
  "q": "<string>",
  "semantic": false,
  "semantic_min_score": 123,
  "text": "<string>",
  "time": {
    "gt": "2023-11-07T05:31:56Z",
    "gte": "2023-11-07T05:31:56Z",
    "lt": "2023-11-07T05:31:56Z",
    "lte": "2023-11-07T05:31:56Z"
  },
  "where": [
    {
      "field": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "export_id": "exp_01H8Z3",
  "status": "pending"
}

Authorizations

​
Authorization
string
header
required

API token issued from the Splendor console.

Headers

​
x-splendor-tenant-id
string
required

Selects the tenant (workspace) the request acts within.

Body

application/json
​
aggregations
AggregationRequest · object[]
​
collapse
enum<string> | null

Override how lexical hits map to results. 'document' returns the best-ranked record per document (use to force a document listing from a filter-only browse); 'record' returns every matching record (use with a document filter to enumerate each instance of a term within one document). Defaults to document collapse for ranked text and record semantics for filter-only browses. Not valid with semantic search, which always returns document-level results.

Available options:
document,
record
​
content_filter
enum<string>
default:text

For semantic search, which modalities to retrieve: 'text' (default) searches text/document embeddings; 'images' searches image embeddings via SigLIP; 'all' searches both and merges the results.

Available options:
all,
text,
images
​
cursor
string | null
Minimum string length: 1
​
dataset_scope
enum<string>
default:selected
Available options:
selected,
all
​
datasets
string[]
​
format
enum<string>
default:ndjson
Available options:
ndjson,
csv
​
limit
integer
default:20
Required range: 0 <= x <= 1000
​
max_expansion_terms
integer
default:10
Required range: 1 <= x <= 50
​
max_rows
integer
default:1000000
Required range: x >= 1
​
q
string | null
​
semantic
boolean
default:false
​
semantic_min_score
number | null
​
text
string | null
​
time
TimeRange · object
​
where
StructuredFilter · object[]

Response

Successful Response

​
export_id
string
required
​
status
string
required