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

# Read agent instructions

> Returns one page of the main agent's routing instructions, each line prefixed with its 1-based number, so a later patch can quote text exactly as it appears. `offset` and `limit` pick the page; the totals in the response cover the whole document.



## OpenAPI

````yaml /specs-prettified/realtime/openapi.stable.json get /v1/stable/agent/instructions
openapi: 3.0.0
info:
  title: Realtime
  description: Realtime gateway API service
  version: 1.0.0
  contact: {}
servers:
  - url: https://realtime-api.voiceflow.com
security: []
tags: []
paths:
  /v1/stable/agent/instructions:
    get:
      tags:
        - Agent
      summary: Read agent instructions
      description: Returns one page of the main agent's routing instructions, each
        line prefixed with its 1-based number, so a later patch can quote text
        exactly as it appears. `offset` and `limit` pick the page; the totals in
        the response cover the whole document.
      operationId: StableAgentController_readInstructions
      parameters:
        - name: projectID
          required: true
          in: query
          schema:
            type: string
            description: The ID of the project to operate on.
        - name: environmentAlias
          required: true
          in: query
          schema:
            type: string
            description: The alias of the environment to operate on (e.g. `main`).
        - name: offset
          required: false
          in: query
          schema:
            default: 1
            description: The 1-based line number to start from. Clamped to the last line of
              the document.
            type: integer
            minimum: 1
            maximum: 9007199254740991
        - name: limit
          required: false
          in: query
          schema:
            default: 400
            description: The maximum number of lines to return. A page is also capped at
              24,000 characters, so a page of very long lines can come back
              shorter than this — follow nextOffset while hasMore is true.
            type: integer
            minimum: 1
            maximum: 2000
      responses:
        "200":
          description: Returns the requested lines of the main agent's instructions as one
            numbered block, with the page's actual offset, its line count, the
            document's total lines and characters, and whether more lines
            follow.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/StableInstructionsReadResponse"
          x-vf-doc:
            description: Returns the requested lines of the main agent's instructions as one
              numbered block, with the page's actual offset, its line count, the
              document's total lines and characters, and whether more lines
              follow.
      security:
        - token: []
components:
  schemas:
    StableInstructionsReadResponse:
      type: object
      properties:
        content:
          type: string
          description: The requested lines, each as its 1-based number, a tab, then the
            text, joined by newlines.
        offset:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The line number this page actually starts at, after clamping.
        returnedLines:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: How many lines this page carries.
        totalLines:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: How many lines the whole document has.
        totalCharacters:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: How many characters the whole document has.
        hasMore:
          type: boolean
          description: Whether lines remain after this page.
        nextOffset:
          nullable: true
          description: The first line not returned, or null when there is nothing more to
            read.
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
      required:
        - content
        - offset
        - returnedLines
        - totalLines
        - totalCharacters
        - hasMore
        - nextOffset
  securitySchemes:
    token:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Voiceflow bearer token
````