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

# Read a conversation



## OpenAPI

````yaml /partner-openapi.gen.json get /partner/conversations/{conversationId}
openapi: 3.1.0
info:
  title: Circuit partner API
  version: '0.1'
servers:
  - url: https://api.circuit.org
security: []
paths:
  /partner/conversations/{conversationId}:
    get:
      summary: Read a conversation
      operationId: readConversation
      parameters:
        - name: circuit-partner-version
          in: header
          required: true
          example: '0.1'
          schema:
            type: string
            const: '0.1'
        - name: conversationId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  turns:
                    type: array
                    items:
                      $ref: '#/components/schemas/PartnerTurn'
                  retryAfterMs:
                    description: >-
                      Read again after this many milliseconds; null once nothing
                      is in progress.
                    type:
                      - integer
                      - 'null'
                    format: uint64
                    minimum: 0
                required:
                  - turns
        default:
          description: Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerFailure'
      security:
        - permit: []
components:
  schemas:
    PartnerTurn:
      type: object
      properties:
        id:
          description: The `messageId` that asked, or Circuit's own follow-up.
          type: string
          format: uuid
        state:
          description: '`pending`, `done` or `failed`.'
          type: string
        text:
          description: What the user asked; null on Circuit's own follow-ups.
          type:
            - string
            - 'null'
        message:
          description: >-
            Circuit's reply or why it failed, in Markdown; null while it is
            working.
          type:
            - string
            - 'null'
        actions:
          type: array
          items:
            $ref: '#/components/schemas/PartnerAction'
      required:
        - id
        - state
        - actions
    PartnerFailure:
      description: 'A failed call: act on its HTTP status and show `error` to the user.'
      type: object
      properties:
        error:
          type: string
      required:
        - error
    PartnerAction:
      type: object
      properties:
        id:
          description: >-
            Starts with `op_` for a trade or transaction, `aga_` for an agent
            change.
          type: string
        title:
          description: One sentence, verb first, as Circuit's own Activity shows it.
          type: string
        state:
          description: >-
            `review`, `pending`, `done`, `dismissed` or `failed` (see
            `message`).
          type: string
        message:
          type:
            - string
            - 'null'
        agentId:
          description: The agent this action started or changed.
          type:
            - string
            - 'null'
        decisions:
          description: 'What your app may send now: `confirm`, `dismiss`.'
          type: array
          items:
            type: string
      required:
        - id
        - title
        - state
        - decisions
  securitySchemes:
    permit:
      type: http
      scheme: bearer
      description: The permit the user approved for your app.

````

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