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>"
}
]
}
'import requests
url = "https://api.withsplendor.com/v1/export"
payload = {
"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>"
}
]
}
headers = {
"x-splendor-tenant-id": "<x-splendor-tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-splendor-tenant-id': '<x-splendor-tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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>'}]
})
};
fetch('https://api.withsplendor.com/v1/export', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withsplendor.com/v1/export",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-splendor-tenant-id: <x-splendor-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.withsplendor.com/v1/export"
payload := strings.NewReader("{\n \"aggregations\": [\n {\n \"field\": \"<string>\",\n \"name\": \"<string>\",\n \"interval\": \"<string>\",\n \"percents\": [\n 123\n ],\n \"size\": 10\n }\n ],\n \"content_filter\": \"text\",\n \"cursor\": \"<string>\",\n \"dataset_scope\": \"selected\",\n \"datasets\": [\n \"<string>\"\n ],\n \"format\": \"ndjson\",\n \"limit\": 20,\n \"max_expansion_terms\": 10,\n \"max_rows\": 1000000,\n \"q\": \"<string>\",\n \"semantic\": false,\n \"semantic_min_score\": 123,\n \"text\": \"<string>\",\n \"time\": {\n \"gt\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"where\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-splendor-tenant-id", "<x-splendor-tenant-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.withsplendor.com/v1/export")
.header("x-splendor-tenant-id", "<x-splendor-tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"aggregations\": [\n {\n \"field\": \"<string>\",\n \"name\": \"<string>\",\n \"interval\": \"<string>\",\n \"percents\": [\n 123\n ],\n \"size\": 10\n }\n ],\n \"content_filter\": \"text\",\n \"cursor\": \"<string>\",\n \"dataset_scope\": \"selected\",\n \"datasets\": [\n \"<string>\"\n ],\n \"format\": \"ndjson\",\n \"limit\": 20,\n \"max_expansion_terms\": 10,\n \"max_rows\": 1000000,\n \"q\": \"<string>\",\n \"semantic\": false,\n \"semantic_min_score\": 123,\n \"text\": \"<string>\",\n \"time\": {\n \"gt\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"where\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withsplendor.com/v1/export")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-splendor-tenant-id"] = '<x-splendor-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"aggregations\": [\n {\n \"field\": \"<string>\",\n \"name\": \"<string>\",\n \"interval\": \"<string>\",\n \"percents\": [\n 123\n ],\n \"size\": 10\n }\n ],\n \"content_filter\": \"text\",\n \"cursor\": \"<string>\",\n \"dataset_scope\": \"selected\",\n \"datasets\": [\n \"<string>\"\n ],\n \"format\": \"ndjson\",\n \"limit\": 20,\n \"max_expansion_terms\": 10,\n \"max_rows\": 1000000,\n \"q\": \"<string>\",\n \"semantic\": false,\n \"semantic_min_score\": 123,\n \"text\": \"<string>\",\n \"time\": {\n \"gt\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"where\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"export_id": "exp_01H8Z3",
"status": "pending"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Exports
Create an export
Starts an asynchronous export of a search’s full result set. Returns the export job; poll it for status and the download location when complete. Use exports for exhaustive traversal of large result sets.
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>"
}
]
}
'import requests
url = "https://api.withsplendor.com/v1/export"
payload = {
"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>"
}
]
}
headers = {
"x-splendor-tenant-id": "<x-splendor-tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-splendor-tenant-id': '<x-splendor-tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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>'}]
})
};
fetch('https://api.withsplendor.com/v1/export', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withsplendor.com/v1/export",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-splendor-tenant-id: <x-splendor-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.withsplendor.com/v1/export"
payload := strings.NewReader("{\n \"aggregations\": [\n {\n \"field\": \"<string>\",\n \"name\": \"<string>\",\n \"interval\": \"<string>\",\n \"percents\": [\n 123\n ],\n \"size\": 10\n }\n ],\n \"content_filter\": \"text\",\n \"cursor\": \"<string>\",\n \"dataset_scope\": \"selected\",\n \"datasets\": [\n \"<string>\"\n ],\n \"format\": \"ndjson\",\n \"limit\": 20,\n \"max_expansion_terms\": 10,\n \"max_rows\": 1000000,\n \"q\": \"<string>\",\n \"semantic\": false,\n \"semantic_min_score\": 123,\n \"text\": \"<string>\",\n \"time\": {\n \"gt\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"where\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-splendor-tenant-id", "<x-splendor-tenant-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.withsplendor.com/v1/export")
.header("x-splendor-tenant-id", "<x-splendor-tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"aggregations\": [\n {\n \"field\": \"<string>\",\n \"name\": \"<string>\",\n \"interval\": \"<string>\",\n \"percents\": [\n 123\n ],\n \"size\": 10\n }\n ],\n \"content_filter\": \"text\",\n \"cursor\": \"<string>\",\n \"dataset_scope\": \"selected\",\n \"datasets\": [\n \"<string>\"\n ],\n \"format\": \"ndjson\",\n \"limit\": 20,\n \"max_expansion_terms\": 10,\n \"max_rows\": 1000000,\n \"q\": \"<string>\",\n \"semantic\": false,\n \"semantic_min_score\": 123,\n \"text\": \"<string>\",\n \"time\": {\n \"gt\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"where\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withsplendor.com/v1/export")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-splendor-tenant-id"] = '<x-splendor-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"aggregations\": [\n {\n \"field\": \"<string>\",\n \"name\": \"<string>\",\n \"interval\": \"<string>\",\n \"percents\": [\n 123\n ],\n \"size\": 10\n }\n ],\n \"content_filter\": \"text\",\n \"cursor\": \"<string>\",\n \"dataset_scope\": \"selected\",\n \"datasets\": [\n \"<string>\"\n ],\n \"format\": \"ndjson\",\n \"limit\": 20,\n \"max_expansion_terms\": 10,\n \"max_rows\": 1000000,\n \"q\": \"<string>\",\n \"semantic\": false,\n \"semantic_min_score\": 123,\n \"text\": \"<string>\",\n \"time\": {\n \"gt\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"where\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"export_id": "exp_01H8Z3",
"status": "pending"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
API token issued from the Splendor console.
Headers
Selects the tenant (workspace) the request acts within.
Body
application/json
Show child attributes
Show child attributes
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 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 Minimum string length:
1Available options:
selected, all Available options:
ndjson, csv Required range:
0 <= x <= 1000Required range:
1 <= x <= 50Required range:
x >= 1Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I