--- title: Create Stream --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Pipelines](https://developers.cloudflare.com/api/go/resources/pipelines) [Streams](https://developers.cloudflare.com/api/go/resources/pipelines/subresources/streams) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create Stream client.Pipelines.Streams.New(ctx, params) (\*[StreamNewResponse](), error) POST/accounts/{account\_id}/pipelines/v1/streams Create a new Stream. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

##### Accepted Permissions (at least one required) `Pipelines Write` ##### ParametersExpand Collapse

params StreamNewParams

AccountID param.Field\[string] Path param: Specifies the public ID of the account. Link to this property Name param.Field\[string] Body param: Specifies the name of the Stream. maxLength128 minLength1 Link to this property

Format param.Field\[StreamNewParamsFormat]Optional Body param: Defines the data format of the events.

type StreamNewParamsFormatJson struct{…}

Type StreamNewParamsFormatJsonType Link to this property

DecimalEncoding StreamNewParamsFormatJsonDecimalEncodingOptional

One of the following: const StreamNewParamsFormatJsonDecimalEncodingNumber StreamNewParamsFormatJsonDecimalEncoding = "number" Link to this property const StreamNewParamsFormatJsonDecimalEncodingString StreamNewParamsFormatJsonDecimalEncoding = "string" Link to this property const StreamNewParamsFormatJsonDecimalEncodingBytes StreamNewParamsFormatJsonDecimalEncoding = "bytes" Link to this property

Link to this property

TimestampFormat StreamNewParamsFormatJsonTimestampFormatOptional

One of the following: const StreamNewParamsFormatJsonTimestampFormatRfc3339 StreamNewParamsFormatJsonTimestampFormat = "rfc3339" Link to this property const StreamNewParamsFormatJsonTimestampFormatUnixMillis StreamNewParamsFormatJsonTimestampFormat = "unix\_millis" Link to this property

Link to this property Unstructured boolOptional Link to this property

Link to this property

type StreamNewParamsFormatParquet struct{…}

Type StreamNewParamsFormatParquetType Link to this property

Compression StreamNewParamsFormatParquetCompressionOptional

One of the following: const StreamNewParamsFormatParquetCompressionUncompressed StreamNewParamsFormatParquetCompression = "uncompressed" Link to this property const StreamNewParamsFormatParquetCompressionSnappy StreamNewParamsFormatParquetCompression = "snappy" Link to this property const StreamNewParamsFormatParquetCompressionGzip StreamNewParamsFormatParquetCompression = "gzip" Link to this property const StreamNewParamsFormatParquetCompressionZstd StreamNewParamsFormatParquetCompression = "zstd" Link to this property const StreamNewParamsFormatParquetCompressionLz4 StreamNewParamsFormatParquetCompression = "lz4" Link to this property

Link to this property RowGroupBytes int64Optional formatint64 minimum0 Link to this property

Link to this property

HTTP param.Field\[StreamNewParamsHTTP]Optional Body param

Authentication bool Indicates that authentication is required for the HTTP endpoint. Link to this property Enabled bool Indicates that the HTTP endpoint is enabled. Link to this property

CORS StreamNewParamsHTTPCORSOptional Specifies the CORS options for the HTTP endpoint.

Origins \[]stringOptional Link to this property

Link to this property

Schema param.Field\[StreamNewParamsSchema]Optional Body param: Defines the schema of the events in the data stream.

Fields \[]SourceFieldOptional

One of the following:

type SourceFieldInt32 struct{…}

Type SourceFieldInt32Type Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property

Link to this property

type SourceFieldInt64 struct{…}

Type SourceFieldInt64Type Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property

Link to this property

type SourceFieldFloat32 struct{…}

Type SourceFieldFloat32Type Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property

Link to this property

type SourceFieldFloat64 struct{…}

Type SourceFieldFloat64Type Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property

Link to this property

type SourceFieldBool struct{…}

Type SourceFieldBoolType Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property

Link to this property

type SourceFieldString struct{…}

Type SourceFieldStringType Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property

Link to this property

type SourceFieldBinary struct{…}

Type SourceFieldBinaryType Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property

Link to this property

type SourceFieldTimestamp struct{…}

Type SourceFieldTimestampType Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property

Unit SourceFieldTimestampUnitOptional

One of the following: const SourceFieldTimestampUnitSecond SourceFieldTimestampUnit = "second" Link to this property const SourceFieldTimestampUnitMillisecond SourceFieldTimestampUnit = "millisecond" Link to this property const SourceFieldTimestampUnitMicrosecond SourceFieldTimestampUnit = "microsecond" Link to this property const SourceFieldTimestampUnitNanosecond SourceFieldTimestampUnit = "nanosecond" Link to this property

Link to this property

type SourceFieldJson struct{…}

Type SourceFieldJsonType Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property

Link to this property

type SourceFieldStruct struct{…}

Type SourceFieldStructType Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property

Link to this property

type SourceFieldList struct{…}

Type SourceFieldListType Link to this property MetadataKey stringOptional Link to this property Name stringOptional Link to this property Required boolOptional Link to this property SqlName stringOptional Link to this property

Link to this property

Link to this property Inferred boolOptional Link to this property

Link to this property

WorkerBinding param.Field\[StreamNewParamsWorkerBinding]Optional Body param

Enabled bool Indicates that the worker binding is enabled. Link to this property

Link to this property

[Link to this property](<#(resource)%20pipelines.streams%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

type StreamNewResponse struct{…}

ID string Indicates a unique identifier for this stream. Link to this property CreatedAt Time formatdate-time Link to this property

HTTP StreamNewResponseHTTP

Authentication bool Indicates that authentication is required for the HTTP endpoint. Link to this property Enabled bool Indicates that the HTTP endpoint is enabled. Link to this property

CORS StreamNewResponseHTTPCORSOptional Specifies the CORS options for the HTTP endpoint.

Origins \[]stringOptional Link to this property

Link to this property

Link to this property ModifiedAt Time formatdate-time Link to this property Name string Indicates the name of the Stream. maxLength128 minLength1 Link to this property Version int64 Indicates the current version of this stream. Link to this property

WorkerBinding StreamNewResponseWorkerBinding

Enabled bool Indicates that the worker binding is enabled. Link to this property

Link to this property Endpoint stringOptional Indicates the endpoint URL of this stream. formaturi Link to this property

Format StreamNewResponseFormatOptional Defines the data format of the events.

One of the following:

type StreamNewResponseFormatJson struct{…}

Type StreamNewResponseFormatJsonType Link to this property

DecimalEncoding StreamNewResponseFormatJsonDecimalEncodingOptional

One of the following: const StreamNewResponseFormatJsonDecimalEncodingNumber StreamNewResponseFormatJsonDecimalEncoding = "number" Link to this property const StreamNewResponseFormatJsonDecimalEncodingString StreamNewResponseFormatJsonDecimalEncoding = "string" Link to this property const StreamNewResponseFormatJsonDecimalEncodingBytes StreamNewResponseFormatJsonDecimalEncoding = "bytes" Link to this property

Link to this property

TimestampFormat StreamNewResponseFormatJsonTimestampFormatOptional

One of the following: const StreamNewResponseFormatJsonTimestampFormatRfc3339 StreamNewResponseFormatJsonTimestampFormat = "rfc3339" Link to this property const StreamNewResponseFormatJsonTimestampFormatUnixMillis StreamNewResponseFormatJsonTimestampFormat = "unix\_millis" Link to this property

Link to this property Unstructured boolOptional Link to this property

Link to this property

type StreamNewResponseFormatParquet struct{…}

Type StreamNewResponseFormatParquetType Link to this property

Compression StreamNewResponseFormatParquetCompressionOptional

One of the following: const StreamNewResponseFormatParquetCompressionUncompressed StreamNewResponseFormatParquetCompression = "uncompressed" Link to this property const StreamNewResponseFormatParquetCompressionSnappy StreamNewResponseFormatParquetCompression = "snappy" Link to this property const StreamNewResponseFormatParquetCompressionGzip StreamNewResponseFormatParquetCompression = "gzip" Link to this property const StreamNewResponseFormatParquetCompressionZstd StreamNewResponseFormatParquetCompression = "zstd" Link to this property const StreamNewResponseFormatParquetCompressionLz4 StreamNewResponseFormatParquetCompression = "lz4" Link to this property

Link to this property RowGroupBytes int64Optional formatint64 minimum0 Link to this property

Link to this property

Schema StreamNewResponseSchemaOptional Defines the schema of the events in the data stream.

Fields \[]SourceFieldOptional

One of the following:

type SourceFieldInt32 struct{…}

Link to this property

type SourceFieldInt64 struct{…}

Link to this property

type SourceFieldFloat32 struct{…}

Link to this property

type SourceFieldFloat64 struct{…}

Link to this property

type SourceFieldBool struct{…}

Link to this property

type SourceFieldString struct{…}

Link to this property

type SourceFieldBinary struct{…}

Link to this property

type SourceFieldTimestamp struct{…}

Unit SourceFieldTimestampUnitOptional

Link to this property

type SourceFieldJson struct{…}

Link to this property

type SourceFieldStruct struct{…}

Link to this property

type SourceFieldList struct{…}

Link to this property

Link to this property Inferred boolOptional Link to this property

Link to this property

[Link to this property](<#(resource)%20pipelines.streams%20%3E%20(model)%20StreamNewResponse%20%3E%20(schema)>) ### Create Stream Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/pipelines" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) stream, err := client.Pipelines.Streams.New(context.TODO(), pipelines.StreamNewParams{ AccountID: cloudflare.F("0123105f4ecef8ad9ca31a8372d0c353"), Name: cloudflare.F("my_stream"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", stream.ID) } ``` 200 example ``` { "result": { "id": "01234567890123457689012345678901", "created_at": "2019-12-27T18:11:19.117Z", "http": { "authentication": false, "enabled": true, "cors": { "origins": [ "string" ] } }, "modified_at": "2019-12-27T18:11:19.117Z", "name": "my_stream", "version": 3, "worker_binding": { "enabled": true }, "endpoint": "https://01234567890123457689012345678901.ingest.cloudflare.com/v1", "format": { "type": "json", "decimal_encoding": "number", "timestamp_format": "rfc3339", "unstructured": true }, "schema": { "fields": [ { "type": "int32", "metadata_key": "metadata_key", "name": "name", "required": true, "sql_name": "sql_name" } ], "inferred": true } }, "success": true } ``` ##### Returns Examples 200 example ``` { "result": { "id": "01234567890123457689012345678901", "created_at": "2019-12-27T18:11:19.117Z", "http": { "authentication": false, "enabled": true, "cors": { "origins": [ "string" ] } }, "modified_at": "2019-12-27T18:11:19.117Z", "name": "my_stream", "version": 3, "worker_binding": { "enabled": true }, "endpoint": "https://01234567890123457689012345678901.ingest.cloudflare.com/v1", "format": { "type": "json", "decimal_encoding": "number", "timestamp_format": "rfc3339", "unstructured": true }, "schema": { "fields": [ { "type": "int32", "metadata_key": "metadata_key", "name": "name", "required": true, "sql_name": "sql_name" } ], "inferred": true } }, "success": true } ```