Skip to main content
PATCH
/
api
/
v1
/
bulk-exports
/
{bulk_export_id}
Error
A valid request URL is required to generate request examples
{
  "bulk_export_destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_time": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "filter": "<string>",
  "format": "Parquet",
  "format_version": "v1",
  "compression": "gzip",
  "interval_hours": 123,
  "export_fields": [
    "<string>"
  ],
  "source_bulk_export_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.langchain.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
bulk_export_id
string<uuid>
required

Body

application/json
​
status
enum<string>
default:Cancelled
Available options:
Cancelled

Response

Successful Response

​
bulk_export_destination_id
string<uuid>
required
​
session_id
string<uuid>
required
​
start_time
string<date-time>
required
​
id
string<uuid>
required
​
tenant_id
string<uuid>
required
​
status
enum<string>
required
Available options:
Cancelled,
Completed,
Created,
IntervalScheduled,
Failed,
TimedOut,
Running
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
finished_at
string<date-time> | null
required
​
end_time
string<date-time> | null
​
filter
string | null
​
format
enum<string>
default:Parquet
Available options:
Parquet
​
format_version
enum<string>
default:v1

Enum for bulk export format versions.

Available options:
v1,
v2_beta
​
compression
enum<string>
default:gzip
Available options:
none,
gzip,
snappy,
zstandard
​
interval_hours
integer | null
​
export_fields
string[] | null
​
source_bulk_export_id
string<uuid> | null