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

# Streams

> Every evidence stream, from the registry.

**Who may call it:** any role. A workspace API key is refused here: this is an act that belongs to a named person.



## OpenAPI

````yaml /api/openapi.json get /v1/streams
openapi: 3.1.0
info:
  title: RotaGrant API
  version: 0.1.0
  description: >-
    The HTTP API of a RotaGrant deployment, made from the product's own route
    definitions at the commit named in `x-rotascale-source`. Nothing here is
    written by hand.


    There is no shared endpoint. RotaGrant runs in your environment, and your
    deployment serves its own copy of this description at `/api/docs`. That copy
    is the authority on what your version has and which features are switched
    on; this one is the reference for one commit of the main line. The version
    is 0.1.0: routes and shapes can still change.


    Every route says who may call it. Most need a bearer token from the identity
    provider your deployment uses, held by a person with the role named. The
    routes an SDK calls also accept a workspace API key. A few are open, and say
    why.
servers:
  - url: https://{deployment}
    description: Your own deployment. There is no shared endpoint.
    variables:
      deployment:
        default: rotagrant.internal.example
        description: The host your deployment answers on.
security: []
paths:
  /v1/streams:
    get:
      tags:
        - Evidence
      summary: Streams
      description: >-
        Every evidence stream, from the registry.


        **Who may call it:** any role. A workspace API key is refused here: this
        is an act that belongs to a named person.
      operationId: streams_v1_streams_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamsOut'
      security:
        - bearerToken: []
components:
  schemas:
    StreamsOut:
      properties:
        streams:
          items:
            $ref: '#/components/schemas/StreamOut'
          type: array
          title: Streams
        count:
          type: integer
          title: Count
        all_contiguous:
          type: boolean
          title: All Contiguous
        unsealed:
          items:
            type: string
          type: array
          title: Unsealed
      type: object
      required:
        - streams
        - count
        - all_contiguous
        - unsealed
      title: StreamsOut
    StreamOut:
      properties:
        stream_key:
          type: string
          title: Stream Key
        count:
          type: integer
          title: Count
        issued:
          type: integer
          title: Issued
        highest_seq:
          anyOf:
            - type: integer
            - type: 'null'
          title: Highest Seq
        contiguous:
          type: boolean
          title: Contiguous
        gaps:
          items:
            type: integer
          type: array
          title: Gaps
        missing_from_tail:
          type: boolean
          title: Missing From Tail
        last_record_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Record At
        last_sealed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Sealed At
        sealed:
          type: boolean
          title: Sealed
          default: false
      type: object
      required:
        - stream_key
        - count
        - issued
        - contiguous
        - gaps
        - missing_from_tail
      title: StreamOut
      description: One evidence stream, and whether anything is missing from it.
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A token from the identity provider your deployment federates with. It
        identifies a person; their roles in the workspace decide what they may
        do.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.