Skip to main content
Use the streams and records API to build high-volume extensions to industrial knowledge graphs built with Data Modeling. The streams API lets you manage the streams used to store records. You can define streams, retrieve them, and configure settings and statistics associated with each stream. For a comprehensive guide on streams, including detailed template specifications, lifecycle management, and how they relate to records, see About records and streams.

​
Rate and concurrency limits

For Streams rate and concurrency limits, see API rate limits.

​
Mutable and immutable streams

The template you choose when you create a stream sets whether the stream is mutable or immutable. You cannot change the template later. Mutable streams let you update and delete records. Queries stay fast because the stream keeps one index, and the total number of records is limited. Immutable streams do not let you update or delete records. They store larger volumes, and query speed depends on the age of the data. Filter and aggregate queries on an immutable stream must include a lastUpdatedTime range. See Query time range limits.

​
Stream templates

Stream templates are in beta. Cognite can add templates, and can change a template, without changing streams that already exist. GET /streams/templates lists the templates the project is allowed to create. That operation is available on the alpha API only.
Do not use ImmutableTestStream in production. Cognite can change the settings of a stream created from that template if the load is outside experimentation.
For throughput and the unique-property budget, see Stream template limits.

​
Soft delete

Deleting a stream soft-deletes it. The data stays recoverable until the template recovery window ends: 6 weeks for BasicArchive and BasicLiveData, and 1 day for ImmutableTestStream. While a stream is soft-deleted:
  • You cannot ingest into it or query it.
  • It does not count as an active stream.
  • You cannot create another stream with the same identifier.
Contact Cognite Support at least one week before the recovery window ends if you need the data restored. Avoid creating and deleting streams often. A project can hold only a limited number of soft-deleted streams, and deleting a stream can take a long time.
Last modified on November 2, 2026