> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Cognite Data Fusion (CDF) is an industrial DataOps platform. Prefer English docs unless the user asks for another locale.
> Follow /_llms/ index links recursively until you reach page URLs ending in .md. Fetch those Markdown twins instead of HTML.
> For REST APIs, default to calendar version 20230101 (stable). Use 20230101-beta or 20230101-alpha only if the user is on a preview API. Cite paths under /api-reference/concepts/<version>/ and the Cdf-Version header. Prefer the Python SDK (cognite-sdk) unless the user is in JavaScript/TypeScript.
> Start here by task: platform overview /cdf/index.md; data modeling /cdf/dm/index.md; data integration /cdf/integration/index.md; access /cdf/access/index.md; CDF Toolkit /cdf/deploy/cdf_toolkit/index.md; REST quickstart /dev/quickstart.md; Python SDK https://cognite-sdk-python.readthedocs-hosted.com/en/stable/; Atlas AI /cdf/atlas_ai/concepts/index.md; Flows apps /cdf/flows/index.md; MCP and IDE setup /dev/guides/ide_ai_integration.md.
> For implementation work, also load /skill.md.

# List stream templates

> Lists the stream templates this project can use. Requires `streamsAcl:READ`. See [Stream templates](/api-reference/concepts/20230101/streams#stream-templates).



## OpenAPI

````yaml https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /streams/templates
openapi: 3.1.0
info:
  title: Cognite API
  description: >-
    Reference documentation for the Cognite Data Fusion (CDF) API. See the [API
    introduction](/api-reference/concepts/20230101/api-description) and [API
    changelog](/api-reference/changelog).
  version: v1
  contact:
    name: Cognite Support
    url: https://support.cognite.com
    email: support@cognite.com
servers:
  - url: https://{cluster}.cognitedata.com/api/v1/projects/{project}
    description: The URL for the CDF cluster to connect to
    variables:
      cluster:
        enum:
          - api
          - az-tyo-gp-001
          - az-eastus-1
          - az-power-no-northeurope
          - westeurope-1
          - asia-northeast1-1
          - gc-dsm-gp-001
        default: api
        description: The CDF cluster to connect to
      project:
        default: publicdata
        description: The CDF project name.
security:
  - oidc-token:
      - https://{cluster}.cognitedata.com/.default
  - oauth2-client-credentials:
      - https://{cluster}.cognitedata.com/.default
  - oauth2-open-industrial-data:
      - https://api.cognitedata.com/.default
  - oauth2-auth-code:
      - https://{cluster}.cognitedata.com/.default
tags:
  - name: Token
  - name: Assets
  - name: Data Modeling
    x-uri-format-fragments: []
  - name: Streams
  - name: Records
  - name: Events
  - name: Files
  - name: Functions
  - name: Function calls
  - name: Function schedules
  - name: Function Apps
  - name: Function App Calls
  - name: Function App MCP
  - name: 3D
  - name: Time series
  - name: Data point subscriptions
  - name: Synthetic Time Series
  - name: Raw
    x-uri-format-fragments: []
  - name: Groups
  - name: Projects
  - name: Security categories
  - name: Data sets
  - name: Sequences
  - name: Labels
  - name: Relationships
  - name: Entity matching
  - name: Entity matching pipelines
  - name: Diagram parsing
  - name: Vision
  - name: Agents
  - name: Skills
  - name: Project Configuration
  - name: Models
  - name: Cognite AI
  - name: Documents
  - name: Document preview
    x-displayName: Preview
  - name: Geospatial
  - name: SessionsInternal
  - name: Sessions
  - name: Extraction Pipelines
  - name: Extraction Pipelines Runs
  - name: Extraction Pipelines Config
  - name: Extractors
  - name: Transformations
  - name: Transformation Jobs
  - name: Transformation Schedules
  - name: Transformation Notifications
  - name: Query
  - name: Schema
  - name: Transformation External Data Sources
  - name: Annotations
  - name: User profiles
  - name: Workflows
  - name: Workflow versions
  - name: Workflow executions
  - name: Tasks
  - name: Workflow triggers
  - name: Sources
  - name: Jobs
  - name: Destinations
  - name: Mappings
  - name: Previews
  - name: Postgres Gateway Users
  - name: Postgres Gateway Tables
  - name: SAP Instances
  - name: SAP Endpoints
  - name: Schema Mappings
  - name: Writeback Requests
  - name: Simulators
  - name: Simulator Integrations
  - name: Simulator Routines
  - name: Simulator Models
  - name: Simulation Runs
  - name: Simulator Logs
  - name: Units
  - name: Unit Systems
  - name: Application Data Storage
  - name: Location Filters
  - name: User Preferences
  - name: User History
  - name: Search Config
  - name: Organizations
  - name: Applications
  - name: Integrations
  - name: Integration Tasks
  - name: Integration Actions
  - name: Integration Configuration
  - name: Integration Errors
  - name: Principals
  - name: Signals
  - name: Data products
paths:
  /streams/templates:
    get:
      tags:
        - Streams
      summary: List stream templates
      description: >-
        Lists the stream templates this project can use. Requires
        `streamsAcl:READ`. See [Stream
        templates](/api-reference/concepts/20230101/streams#stream-templates).
      operationId: listStreamTemplates
      responses:
        '200':
          description: |
            List of stream templates.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamTemplateListResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
      x-code-samples:
        - lang: Python
          label: Python SDK
          source: |
            res = client.data_modeling.streams.templates.list()
components:
  schemas:
    StreamTemplateListResponse:
      type: object
      title: streamTemplateListResponse
      description: |
        Stream templates response.
      required:
        - items
      properties:
        items:
          type: array
          title: streamTemplateItems
          description: |
            List of stream templates, sorted by name.
          items:
            allOf:
              - $ref: '#/components/schemas/StreamTemplateResponseItem'
    StreamTemplateResponseItem:
      type: object
      title: streamTemplateResponseItem
      description: |
        A stream template available in the project.
      required:
        - name
        - type
        - maxStreams
        - settings
      properties:
        name:
          type: string
          title: name
          description: >
            Template name. Use it as `settings.template.name` when creating a
            stream.
          example: BasicArchive
        type:
          type: string
          title: type
          description: >
            Type of the streams created from this template.

            See the `type` property of a stream for details on the differences
            between the types.
          enum:
            - Immutable
            - Mutable
          example: Immutable
        maxStreams:
          type: object
          title: maxStreams
          description: |
            Number of streams that can be created from this template.
          required:
            - provisioned
          properties:
            provisioned:
              type: integer
              title: provisioned
              description: |
                Maximum number of active streams granted for this project.
              example: 2
        settings:
          type: object
          title: settings
          description: |
            Settings streams created from this template will get.
          required:
            - limits
            - lifecycle
          properties:
            limits:
              type: object
              title: limits
              description: >
                Limits keyed by identifier. Which limits are present depends on
                the template type.

                Known identifiers include `maxRecordsTotal`,
                `maxGigaBytesTotal`, `recordsIngestedPer10m`,

                `ingestionThroughputGigabytesPer10m`,
                `readingThroughputGigabytesPer10m`,

                `uniquePropertiesWithData`, `recordsUpdatedOrDeleted10m`
                (mutable streams only) and

                `maxFilteringInterval` (immutable streams only). New identifiers
                may be added.
              additionalProperties:
                $ref: '#/components/schemas/StreamTemplateLimit'
            lifecycle:
              type: object
              title: lifecycle
              description: >
                Lifecycle settings keyed by identifier. Known identifiers
                include `retainedAfterSoftDelete`

                and `dataDeletedAfter` (immutable streams only). New identifiers
                may be added.
              additionalProperties:
                $ref: '#/components/schemas/StreamTemplateLimit'
    Error:
      type: object
      required:
        - code
        - message
      description: Cognite API error.
      properties:
        code:
          type: integer
          description: HTTP status code.
          format: int32
          example: 401
        message:
          type: string
          description: Error message.
          example: Could not authenticate.
        missing:
          type: array
          description: List of lookup objects that do not match any results.
          items:
            type: object
            additionalProperties: true
        duplicated:
          type: array
          description: List of objects that are not unique.
          items:
            type: object
            additionalProperties: true
    StreamTemplateLimit:
      type: object
      title: streamTemplateLimit
      description: |
        A single limit or lifecycle setting of a stream template.
      required:
        - type
        - name
        - value
      properties:
        type:
          type: string
          title: type
          description: |
            Kind of setting. Currently always `fixed`.
          example: fixed
        name:
          type: string
          title: name
          description: |
            Human-readable description of the setting.
          example: Maximum total number of records
        value:
          title: value
          description: >
            Value of the setting. A number for counts and sizes, or a string for
            durations.

            Durations are ISO-8601 formatted (for example `PT168H`), or
            `infinity` when unbounded.
          oneOf:
            - type: number
            - type: string
          example: 50000000
  responses:
    ErrorResponse:
      description: The response for a failed request.
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                $ref: '#/components/schemas/Error'
  securitySchemes:
    oidc-token:
      type: http
      scheme: bearer
      bearerFormat: OpenID Connect or OAuth2 token
      description: >-
        Access token issued by the CDF project's configured identity provider.
        Access token must be an OpenID Connect token, and the project must be
        configured to accept OpenID Connect tokens. Use a header key of
        'Authorization' with a value of 'Bearer $accesstoken'. The token can be
        obtained through any flow supported by the identity provider.
    oauth2-client-credentials:
      type: oauth2
      description: >-
        Access token issued by the CDF project's configured identity provider.
        Access token must be an OpenID Connect token, and the project must be
        configured to accept OpenID Connect tokens. Use a header key of
        'Authorization' with a value of 'Bearer $accesstoken'. The token can be
        obtained through any flow supported by the identity provider.
      flows:
        clientCredentials:
          tokenUrl: https://your-idps.token.url/
          scopes:
            default: https://{cluster}.cognitedata.com/.default
    oauth2-open-industrial-data:
      type: oauth2
      description: >-
        Auth flow for Open Industrial Data. Get your client secret from
        https://hub.cognite.com/open-industrial-data-211.
      flows:
        clientCredentials:
          tokenUrl: >-
            https://login.microsoftonline.com/48d5043c-cf70-4c49-881c-c638f5796997/oauth2/v2.0/token
          scopes:
            default: https://api.cognitedata.com/.default
    oauth2-auth-code:
      type: oauth2
      description: >-
        Access token issued by the CDF project's configured identity provider.
        Access token must be an OpenID Connect token, and the project must be
        configured to accept OpenID Connect tokens. Use a header key of
        'Authorization' with a value of 'Bearer $accesstoken'. The token can be
        obtained through any flow supported by the identity provider.
      flows:
        authorizationCode:
          authorizationUrl: https://your-idps.authorization.url/
          tokenUrl: https://your-idps.token.url/
          scopes:
            default: https://{cluster}.cognitedata.com/.default

````