API Reference

Pipelines

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Streams

List Streams

client.pipelines.streams.list(StreamListParams { account_id, page, per_page, pipeline_id } params, RequestOptionsoptions?): V4PagePaginationArray<StreamListResponse { id, created_at, http, 7 more } >

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

Get Stream Details

client.pipelines.streams.get(stringstreamId, StreamGetParams { account_id } params, RequestOptionsoptions?): StreamGetResponse { id, created_at, http, 7 more }

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

Create Stream

client.pipelines.streams.create(StreamCreateParams { account_id, name, format, 3 more } params, RequestOptionsoptions?): StreamCreateResponse { id, created_at, http, 7 more }

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

Update Stream

client.pipelines.streams.update(stringstreamId, StreamUpdateParams { account_id, http, worker_binding } params, RequestOptionsoptions?): StreamUpdateResponse { id, created_at, http, 6 more }

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

Delete Stream

client.pipelines.streams.delete(stringstreamId, StreamDeleteParams { account_id, force } params, RequestOptionsoptions?): void

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

ModelsExpand Collapse

StreamListResponse { id, created_at, http, 7 more }

id: string

Indicates a unique identifier for this stream.

created_at: string

formatdate-time

http: HTTP { authentication, enabled, cors }

authentication: boolean

Indicates that authentication is required for the HTTP endpoint.

enabled: boolean

Indicates that the HTTP endpoint is enabled.

cors?: CORS { origins }

Specifies the CORS options for the HTTP endpoint.

origins?: Array<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: WorkerBinding { enabled }

enabled: boolean

Indicates that the worker binding is enabled.

endpoint?: string

Indicates the endpoint URL of this stream.

formaturi

format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes }

One of the following:

Json { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding?: "number" | "string" | "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format?: "rfc3339" | "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured?: boolean

Parquet { type, compression, row_group_bytes }

type: "parquet"

compression?: "uncompressed" | "snappy" | "gzip" | 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes?: number | null

formatint64

minimum0

schema?: Schema { fields, format, inferred }

fields?: Array<Int32 { type, metadata_key, name, 2 more } | Int64 { type, metadata_key, name, 2 more } | Float32 { type, metadata_key, name, 2 more } | 8 more>

One of the following:

Int32 { type, metadata_key, name, 2 more }

type: "int32"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Int64 { type, metadata_key, name, 2 more }

type: "int64"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Float32 { type, metadata_key, name, 2 more }

type: "float32"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Float64 { type, metadata_key, name, 2 more }

type: "float64"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Bool { type, metadata_key, name, 2 more }

type: "bool"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

String { type, metadata_key, name, 2 more }

type: "string"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Binary { type, metadata_key, name, 2 more }

type: "binary"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Timestamp { type, metadata_key, name, 3 more }

type: "timestamp"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

unit?: "second" | "millisecond" | "microsecond" | "nanosecond"

One of the following:

"second"

"millisecond"

"microsecond"

"nanosecond"

Json { type, metadata_key, name, 2 more }

type: "json"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Struct

List

format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes }

One of the following:

Json { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding?: "number" | "string" | "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format?: "rfc3339" | "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured?: boolean

Parquet { type, compression, row_group_bytes }

type: "parquet"

compression?: "uncompressed" | "snappy" | "gzip" | 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes?: number | null

formatint64

minimum0

inferred?: boolean | null

StreamGetResponse { id, created_at, http, 7 more }

id: string

Indicates a unique identifier for this stream.

created_at: string

formatdate-time

http: HTTP { authentication, enabled, cors }

authentication: boolean

Indicates that authentication is required for the HTTP endpoint.

enabled: boolean

Indicates that the HTTP endpoint is enabled.

cors?: CORS { origins }

Specifies the CORS options for the HTTP endpoint.

origins?: Array<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: WorkerBinding { enabled }

enabled: boolean

Indicates that the worker binding is enabled.

endpoint?: string

Indicates the endpoint URL of this stream.

formaturi

format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes }

One of the following:

Json { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding?: "number" | "string" | "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format?: "rfc3339" | "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured?: boolean

Parquet { type, compression, row_group_bytes }

type: "parquet"

compression?: "uncompressed" | "snappy" | "gzip" | 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes?: number | null

formatint64

minimum0

schema?: Schema { fields, format, inferred }

fields?: Array<Int32 { type, metadata_key, name, 2 more } | Int64 { type, metadata_key, name, 2 more } | Float32 { type, metadata_key, name, 2 more } | 8 more>

One of the following:

Int32 { type, metadata_key, name, 2 more }

type: "int32"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Int64 { type, metadata_key, name, 2 more }

type: "int64"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Float32 { type, metadata_key, name, 2 more }

type: "float32"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Float64 { type, metadata_key, name, 2 more }

type: "float64"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Bool { type, metadata_key, name, 2 more }

type: "bool"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

String { type, metadata_key, name, 2 more }

type: "string"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Binary { type, metadata_key, name, 2 more }

type: "binary"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Timestamp { type, metadata_key, name, 3 more }

type: "timestamp"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

unit?: "second" | "millisecond" | "microsecond" | "nanosecond"

One of the following:

"second"

"millisecond"

"microsecond"

"nanosecond"

Json { type, metadata_key, name, 2 more }

type: "json"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Struct

List

format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes }

One of the following:

Json { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding?: "number" | "string" | "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format?: "rfc3339" | "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured?: boolean

Parquet { type, compression, row_group_bytes }

type: "parquet"

compression?: "uncompressed" | "snappy" | "gzip" | 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes?: number | null

formatint64

minimum0

inferred?: boolean | null

StreamCreateResponse { id, created_at, http, 7 more }

id: string

Indicates a unique identifier for this stream.

created_at: string

formatdate-time

http: HTTP { authentication, enabled, cors }

authentication: boolean

Indicates that authentication is required for the HTTP endpoint.

enabled: boolean

Indicates that the HTTP endpoint is enabled.

cors?: CORS { origins }

Specifies the CORS options for the HTTP endpoint.

origins?: Array<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: WorkerBinding { enabled }

enabled: boolean

Indicates that the worker binding is enabled.

endpoint?: string

Indicates the endpoint URL of this stream.

formaturi

format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes }

One of the following:

Json { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding?: "number" | "string" | "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format?: "rfc3339" | "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured?: boolean

Parquet { type, compression, row_group_bytes }

type: "parquet"

compression?: "uncompressed" | "snappy" | "gzip" | 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes?: number | null

formatint64

minimum0

schema?: Schema { fields, format, inferred }

fields?: Array<Int32 { type, metadata_key, name, 2 more } | Int64 { type, metadata_key, name, 2 more } | Float32 { type, metadata_key, name, 2 more } | 8 more>

One of the following:

Int32 { type, metadata_key, name, 2 more }

type: "int32"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Int64 { type, metadata_key, name, 2 more }

type: "int64"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Float32 { type, metadata_key, name, 2 more }

type: "float32"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Float64 { type, metadata_key, name, 2 more }

type: "float64"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Bool { type, metadata_key, name, 2 more }

type: "bool"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

String { type, metadata_key, name, 2 more }

type: "string"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Binary { type, metadata_key, name, 2 more }

type: "binary"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Timestamp { type, metadata_key, name, 3 more }

type: "timestamp"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

unit?: "second" | "millisecond" | "microsecond" | "nanosecond"

One of the following:

"second"

"millisecond"

"microsecond"

"nanosecond"

Json { type, metadata_key, name, 2 more }

type: "json"

metadata_key?: string | null

name?: string

required?: boolean

sql_name?: string

Struct

List

format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes }

One of the following:

Json { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding?: "number" | "string" | "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format?: "rfc3339" | "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured?: boolean

Parquet { type, compression, row_group_bytes }

type: "parquet"

compression?: "uncompressed" | "snappy" | "gzip" | 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes?: number | null

formatint64

minimum0

inferred?: boolean | null

StreamUpdateResponse { id, created_at, http, 6 more }

id: string

Indicates a unique identifier for this stream.

created_at: string

formatdate-time

http: HTTP { authentication, enabled, cors }

authentication: boolean

Indicates that authentication is required for the HTTP endpoint.

enabled: boolean

Indicates that the HTTP endpoint is enabled.

cors?: CORS { origins }

Specifies the CORS options for the HTTP endpoint.

origins?: Array<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: WorkerBinding { enabled }

enabled: boolean

Indicates that the worker binding is enabled.

endpoint?: string

Indicates the endpoint URL of this stream.

formaturi

format?: Json { type, decimal_encoding, timestamp_format, unstructured } | Parquet { type, compression, row_group_bytes }

One of the following:

Json { type, decimal_encoding, timestamp_format, unstructured }

type: "json"

decimal_encoding?: "number" | "string" | "bytes"

One of the following:

"number"

"string"

"bytes"

timestamp_format?: "rfc3339" | "unix_millis"

One of the following:

"rfc3339"

"unix_millis"

unstructured?: boolean

Parquet { type, compression, row_group_bytes }

type: "parquet"

compression?: "uncompressed" | "snappy" | "gzip" | 2 more

One of the following:

"uncompressed"

"snappy"

"gzip"

"zstd"

"lz4"

row_group_bytes?: number | null

formatint64

minimum0