agent-manager-dev Meta API

openapi: 3.2.0
info:
  title: agent-manager reference Meta API
  version: 1.0.0
  summary: Read-only reference data about agent-manager.
  description: 'This is the public read-only API for agent-manager''s reference data: the documentation, the coding CLIs it manages, the tools its MCP server exposes, and the current release. Driving agent-manager itself happens on the developer''s own machine through the MCP server that ships in the binary, not through this API.


    ## Versioning and deprecation


    Every path is available unversioned and pinned: `/api/docs` always points at the newest

    version, `/api/v1/docs` stays on v1. A breaking change to a response shape ships under a new

    `/api/v2` prefix, never in place.


    Every response carries `API-Version` with the version that produced it and `Deprecation:

    false`. When a version is scheduled for removal, that header becomes an IMF-fixdate per RFC

    9745 and a `Sunset` header per RFC 8594 names the date the version stops answering, at least

    180 days ahead. A `Link: rel="deprecation"` on the same response points at the migration note.


    ## Rate limits


    The published budget is 600 requests per 60 seconds per caller, advertised on every response

    through `RateLimit`, `RateLimit-Policy`, `RateLimit-Limit`, `RateLimit-Remaining` and

    `RateLimit-Reset`. A throttled request answers `429` with `Retry-After`.


    ## Authentication


    None. Every endpoint is public and read-only; see /auth.md.'
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    name: agent-manager issues
    url: https://github.com/YoanWai/agent-manager/issues
servers:
- url: https://agent-manager.dev
  description: Production, newest version
- url: https://agent-manager.dev/api/v1
  description: Production, pinned to v1
security: []
tags:
- name: Meta
  description: What this API offers.
paths:
  /api:
    get:
      operationId: getApiIndex
      tags:
      - Meta
      summary: Index of this API
      description: Lists every endpoint on this API with its path and purpose, plus the machine-readable files and the MCP endpoint this site publishes. Start here when discovering the API.
      parameters:
      - name: tag
        in: query
        required: false
        description: 'Return only the endpoints in this tag: meta, docs, product or releases.'
        schema:
          type: string
          enum:
          - meta
          - docs
          - product
          - releases
      responses:
        '200':
          description: The endpoint index.
          content:
            application/json:
              schema:
                type: object
                required:
                - name
                - version
                - endpoints
                properties:
                  name:
                    type: string
                  version:
                    type: string
                  description:
                    type: string
                  documentation_url:
                    type: string
                    format: uri
                  openapi_url:
                    type: string
                    format: uri
                  llms_txt_url:
                    type: string
                    format: uri
                  mcp:
                    type: object
                    description: The Streamable HTTP MCP endpoint this site serves.
                    properties:
                      endpoint:
                        type: string
                        format: uri
                      transport:
                        type: string
                      server_card_url:
                        type: string
                        format: uri
                  endpoints:
                    type: array
                    items:
                      type: object
                      required:
                      - path
                      - method
                      - operation_id
                      - summary
                      properties:
                        path:
                          type: string
                        method:
                          type: string
                        operation_id:
                          type: string
                        summary:
                          type: string
                        tags:
                          type: array
                          items:
                            type: string
        '405':
          description: The path exists but not for that HTTP method.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '406':
          description: No representation matches the request's Accept header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/batch:
    post:
      operationId: runBatch
      tags:
      - Meta
      summary: Run several read operations in one request
      description: 'Takes an array of read operations and returns one result per entry, in order, so an agent that needs several pages pays one round trip instead of one per page. Each entry is answered independently: one failing does not fail the batch. Every operation is a read, so replaying the same request is always safe.'
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        description: Optional key echoed back on the response so a retried request can be matched with its original. Nothing is deduplicated server-side because every operation reads.
        schema:
          type: string
          minLength: 1
          maxLength: 200
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - operations
              properties:
                operations:
                  type: array
                  minItems: 1
                  maxItems: 20
                  items:
                    type: object
                    required:
                    - op
                    properties:
                      id:
                        type: string
                        description: Echoed back on the result.
                      op:
                        type: string
                        enum:
                        - get_doc_page
                        - search_docs
                        - list_doc_pages
                        - list_agents
                        - list_mcp_tools
                      slug:
                        type: string
                        description: For get_doc_page.
                      query:
                        type: string
                        description: For search_docs.
                      limit:
                        type: integer
                        description: For search_docs.
                      section:
                        type: string
                        description: For list_doc_pages.
      responses:
        '200':
          description: One result per operation.
          content:
            application/json:
              schema:
                type: object
                required:
                - count
                - results
                properties:
                  count:
                    type: integer
                  succeeded:
                    type: integer
                  results:
                    type: array
                    items:
                      type: object
                      required:
                      - op
                      - status
                      properties:
                        id:
                          type:
                          - string
                          - 'null'
                        op:
                          type:
                          - string
                          - 'null'
                        status:
                          type: string
                          enum:
                          - ok
                          - error
                        result:
                          type: object
                          description: Present when status is ok.
                        error:
                          type: object
                          description: Present when status is error.
        '400':
          description: A parameter is missing or out of range.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: The path exists but not for that HTTP method.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '406':
          description: No representation matches the request's Accept header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
      - error
      description: Every failing response on this API has this shape.
      properties:
        error:
          type: object
          required:
          - code
          - message
          - status
          properties:
            code:
              type: string
              enum:
              - invalid_request
              - not_found
              - method_not_allowed
              - not_acceptable
              - upstream_unavailable
              description: Stable machine-readable error code.
            message:
              type: string
              description: What went wrong, in one sentence.
            status:
              type: integer
              description: The HTTP status of this response.
            hint:
              type: string
              description: What to try instead.
            documentation_url:
              type: string
              format: uri
              description: Where this endpoint is documented.
externalDocs:
  description: Documentation
  url: https://agent-manager.dev/docs/