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

# Get the OpenAPI document for the Agreements API

> Returns the OpenAPI 3.1 specification describing the Agreements API surface.



## OpenAPI

````yaml /openapi.json get /v0/openapi.json
openapi: 3.1.0
info:
  title: Agreements API
  version: v0
  description: Author, deploy, read, and advance agreements through the Agreements API.
servers:
  - url: https://test-api.shodai.network
    description: Public base URL for the Agreements API testnet environment.
  - url: https://api.shodai.network
    description: Public base URL for the Agreements API production environment.
security: []
tags:
  - name: Agreement Records
    description: List and read agreement records.
  - name: Agreement Documents
    description: Resolve hosted agreement prose documents.
  - name: Authoring
    description: Check authored agreement JSON before deployment.
  - name: Deployment
    description: Preflight and deploy agreements.
  - name: Using Agreements
    description: Read state, inspect input history, and submit signed inputs.
  - name: System
    description: Health and OpenAPI discovery endpoints.
paths:
  /v0/openapi.json:
    get:
      tags:
        - System
      summary: Get the OpenAPI document for the Agreements API
      description: >-
        Returns the OpenAPI 3.1 specification describing the Agreements API
        surface.
      operationId: getExternalApiOpenApiDocument
      responses:
        '200':
          description: OpenAPI document for the Agreements API.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true

````