API Reference

Pipelines

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Streams

List Streams

GET/accounts/{account_id}/pipelines/v1/streams

Get Stream Details

GET/accounts/{account_id}/pipelines/v1/streams/{stream_id}

Create Stream

POST/accounts/{account_id}/pipelines/v1/streams

Update Stream

PATCH/accounts/{account_id}/pipelines/v1/streams/{stream_id}

Delete Stream

DELETE/accounts/{account_id}/pipelines/v1/streams/{stream_id}

ModelsExpand Collapse

StreamListResponse = object { id, created_at, http, 7 more }

id: string

Indicates a unique identifier for this stream.

created_at: string

formatdate-time

http: object { authentication, enabled, cors }

authentication: boolean

Indicates that authentication is required for the HTTP endpoint.

enabled: boolean

Indicates that the HTTP endpoint is enabled.

cors: optional object { origins }

Specifies the CORS options for the HTTP endpoint.

origins: optional array of string

modified_at: string

formatdate-time

name: string

Indicates the name of the Stream.

maxLength128

minLength1

version: number

Indicates the current version of this stream.

worker_binding: object { enabled }

enabled: boolean

Indicates that the worker binding is enabled.

endpoint: optional string

Indicates the endpoint URL of this stream.

formaturi

format: optional object { type, decimal_encoding, timestamp_format, unstructured } or object { type, compression, row_group_bytes }

One of the following:

Json = object { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding: optional "number" or "string" or "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format: optional "rfc3339" or "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured: optional boolean

Parquet = object { type, compression, row_group_bytes }

type: "parquet"

compression: optional "uncompressed" or "snappy" or "gzip" or 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes: optional number

formatint64

minimum0

schema: optional object { fields, format, inferred }

fields: optional array of object { type, metadata_key, name, 2 more } or object { type, metadata_key, name, 2 more } or object { type, metadata_key, name, 2 more } or 8 more

One of the following:

Int32 = object { type, metadata_key, name, 2 more }

type: "int32"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Int64 = object { type, metadata_key, name, 2 more }

type: "int64"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Float32 = object { type, metadata_key, name, 2 more }

type: "float32"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Float64 = object { type, metadata_key, name, 2 more }

type: "float64"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Bool = object { type, metadata_key, name, 2 more }

type: "bool"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

String = object { type, metadata_key, name, 2 more }

type: "string"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Binary = object { type, metadata_key, name, 2 more }

type: "binary"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Timestamp = object { type, metadata_key, name, 3 more }

type: "timestamp"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

unit: optional "second" or "millisecond" or "microsecond" or "nanosecond"

One of the following:

"second"

"millisecond"

"microsecond"

"nanosecond"

Json = object { type, metadata_key, name, 2 more }

type: "json"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Struct =

List =

format: optional object { type, decimal_encoding, timestamp_format, unstructured } or object { type, compression, row_group_bytes }

One of the following:

Json = object { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding: optional "number" or "string" or "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format: optional "rfc3339" or "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured: optional boolean

Parquet = object { type, compression, row_group_bytes }

type: "parquet"

compression: optional "uncompressed" or "snappy" or "gzip" or 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes: optional number

formatint64

minimum0

inferred: optional boolean

StreamGetResponse = object { id, created_at, http, 7 more }

id: string

Indicates a unique identifier for this stream.

created_at: string

formatdate-time

http: object { authentication, enabled, cors }

authentication: boolean

Indicates that authentication is required for the HTTP endpoint.

enabled: boolean

Indicates that the HTTP endpoint is enabled.

cors: optional object { origins }

Specifies the CORS options for the HTTP endpoint.

origins: optional array of string

modified_at: string

formatdate-time

name: string

Indicates the name of the Stream.

maxLength128

minLength1

version: number

Indicates the current version of this stream.

worker_binding: object { enabled }

enabled: boolean

Indicates that the worker binding is enabled.

endpoint: optional string

Indicates the endpoint URL of this stream.

formaturi

format: optional object { type, decimal_encoding, timestamp_format, unstructured } or object { type, compression, row_group_bytes }

One of the following:

Json = object { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding: optional "number" or "string" or "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format: optional "rfc3339" or "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured: optional boolean

Parquet = object { type, compression, row_group_bytes }

type: "parquet"

compression: optional "uncompressed" or "snappy" or "gzip" or 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes: optional number

formatint64

minimum0

schema: optional object { fields, format, inferred }

fields: optional array of object { type, metadata_key, name, 2 more } or object { type, metadata_key, name, 2 more } or object { type, metadata_key, name, 2 more } or 8 more

One of the following:

Int32 = object { type, metadata_key, name, 2 more }

type: "int32"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Int64 = object { type, metadata_key, name, 2 more }

type: "int64"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Float32 = object { type, metadata_key, name, 2 more }

type: "float32"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Float64 = object { type, metadata_key, name, 2 more }

type: "float64"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Bool = object { type, metadata_key, name, 2 more }

type: "bool"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

String = object { type, metadata_key, name, 2 more }

type: "string"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Binary = object { type, metadata_key, name, 2 more }

type: "binary"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Timestamp = object { type, metadata_key, name, 3 more }

type: "timestamp"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

unit: optional "second" or "millisecond" or "microsecond" or "nanosecond"

One of the following:

"second"

"millisecond"

"microsecond"

"nanosecond"

Json = object { type, metadata_key, name, 2 more }

type: "json"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Struct =

List =

format: optional object { type, decimal_encoding, timestamp_format, unstructured } or object { type, compression, row_group_bytes }

One of the following:

Json = object { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding: optional "number" or "string" or "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format: optional "rfc3339" or "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured: optional boolean

Parquet = object { type, compression, row_group_bytes }

type: "parquet"

compression: optional "uncompressed" or "snappy" or "gzip" or 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes: optional number

formatint64

minimum0

inferred: optional boolean

StreamCreateResponse = object { id, created_at, http, 7 more }

id: string

Indicates a unique identifier for this stream.

created_at: string

formatdate-time

http: object { authentication, enabled, cors }

authentication: boolean

Indicates that authentication is required for the HTTP endpoint.

enabled: boolean

Indicates that the HTTP endpoint is enabled.

cors: optional object { origins }

Specifies the CORS options for the HTTP endpoint.

origins: optional array of string

modified_at: string

formatdate-time

name: string

Indicates the name of the Stream.

maxLength128

minLength1

version: number

Indicates the current version of this stream.

worker_binding: object { enabled }

enabled: boolean

Indicates that the worker binding is enabled.

endpoint: optional string

Indicates the endpoint URL of this stream.

formaturi

format: optional object { type, decimal_encoding, timestamp_format, unstructured } or object { type, compression, row_group_bytes }

One of the following:

Json = object { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding: optional "number" or "string" or "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format: optional "rfc3339" or "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured: optional boolean

Parquet = object { type, compression, row_group_bytes }

type: "parquet"

compression: optional "uncompressed" or "snappy" or "gzip" or 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes: optional number

formatint64

minimum0

schema: optional object { fields, format, inferred }

fields: optional array of object { type, metadata_key, name, 2 more } or object { type, metadata_key, name, 2 more } or object { type, metadata_key, name, 2 more } or 8 more

One of the following:

Int32 = object { type, metadata_key, name, 2 more }

type: "int32"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Int64 = object { type, metadata_key, name, 2 more }

type: "int64"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Float32 = object { type, metadata_key, name, 2 more }

type: "float32"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Float64 = object { type, metadata_key, name, 2 more }

type: "float64"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Bool = object { type, metadata_key, name, 2 more }

type: "bool"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

String = object { type, metadata_key, name, 2 more }

type: "string"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Binary = object { type, metadata_key, name, 2 more }

type: "binary"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Timestamp = object { type, metadata_key, name, 3 more }

type: "timestamp"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

unit: optional "second" or "millisecond" or "microsecond" or "nanosecond"

One of the following:

"second"

"millisecond"

"microsecond"

"nanosecond"

Json = object { type, metadata_key, name, 2 more }

type: "json"

metadata_key: optional string

name: optional string

required: optional boolean

sql_name: optional string

Struct =

List =

format: optional object { type, decimal_encoding, timestamp_format, unstructured } or object { type, compression, row_group_bytes }

One of the following:

Json = object { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding: optional "number" or "string" or "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format: optional "rfc3339" or "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured: optional boolean

Parquet = object { type, compression, row_group_bytes }

type: "parquet"

compression: optional "uncompressed" or "snappy" or "gzip" or 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes: optional number

formatint64

minimum0

inferred: optional boolean

StreamUpdateResponse = object { id, created_at, http, 6 more }

id: string

Indicates a unique identifier for this stream.

created_at: string

formatdate-time

http: object { authentication, enabled, cors }

authentication: boolean

Indicates that authentication is required for the HTTP endpoint.

enabled: boolean

Indicates that the HTTP endpoint is enabled.

cors: optional object { origins }

Specifies the CORS options for the HTTP endpoint.

origins: optional array of string

modified_at: string

formatdate-time

name: string

Indicates the name of the Stream.

maxLength128

minLength1

version: number

Indicates the current version of this stream.

worker_binding: object { enabled }

enabled: boolean

Indicates that the worker binding is enabled.

endpoint: optional string

Indicates the endpoint URL of this stream.

formaturi

format: optional object { type, decimal_encoding, timestamp_format, unstructured } or object { type, compression, row_group_bytes }

One of the following:

Json = object { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding: optional "number" or "string" or "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format: optional "rfc3339" or "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured: optional boolean

Parquet = object { type, compression, row_group_bytes }

type: "parquet"

compression: optional "uncompressed" or "snappy" or "gzip" or 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes: optional number

formatint64

minimum0