DispatchSEO API

openapi: 3.1.0
info:
  title: DispatchSEO API
  version: '2026-11-05'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-05: 5 operation(s) read from 10 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; DispatchSEO has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 5
    documentation: 0
    pages-with-code: 10
    pages-read: 10
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-05'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://dispatchseo.com/docs/how-it-works
  - https://dispatchseo.com/docs/docker-compose
  - https://dispatchseo.com/docs/vps
  - https://dispatchseo.com/docs/install-claude-code
  - https://dispatchseo.com/docs/install-cursor
  - https://dispatchseo.com/docs/how-it-works.md
  - https://dispatchseo.com/docs/docker-compose.md
  - https://dispatchseo.com/docs/vps.md
  - https://dispatchseo.com/docs/install-claude-code.md
  - https://dispatchseo.com/docs/install-cursor.md
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://dispatchseo.com/docs/docker-compose
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSL https://get.docker.com | sh\n Copy \n To confirm it's ready, this should print a version number: docker --version\n\
          \ Copy Run the command Open a terminal. On Mac that's the Terminal app (press Cmd+Space , type\n\"terminal\"). On Windows press Start,\
          \ type \"powershell\", and open Windows\nPowerShell - just install Git first\nif you haven't (the command fetches the code with it).\
          \ Run it from any pla"
  /api/mcp:
    get:
      operationId: get_api_mcp
      tags:
      - Api
      summary: GET /api/mcp
      x-source: https://dispatchseo.com/docs/how-it-works
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: httpie
        snippet: http https://your-install/api/mcp \
  /install:
    get:
      operationId: get_install
      tags:
      - Install
      summary: GET /install
      x-source: https://dispatchseo.com/docs/install-cursor.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://cursor.com/install -fsS | bash

          ```'
    post:
      operationId: post_install
      tags:
      - Install
      summary: POST /install
      x-source: https://dispatchseo.com/docs/install-cursor
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://cursor.com/install -fsS | bash\n Copy \n That installs cursor-agent into ~/.local/bin . If your shell can't find\
          \ it\nafterwards, that directory isn't on your PATH - add it: \n echo 'export PATH=\"$HOME/.local/bin:$PATH\"' >> ~/.zshrc && source\
          \ ~/.zshrc\n Copy \n Check it worked: \n cursor-agent --version\n Copy \n Step 2: connect your project \n Open a terminal in your site's\
          \ repo folder - the sa"
  /install.sh:
    get:
      operationId: get_install_sh
      tags:
      - Install
      summary: GET /install.sh
      x-source: https://dispatchseo.com/docs/install-claude-code
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSL https://claude.ai/install.sh | bash\n Copy On Windows, in PowerShell: irm https://claude.ai/install.ps1 | iex\n Copy\
          \ That's the whole install. It updates itself from here on, so this is a\none-time thing. Prefer a package manager? brew install --cask\
          \ claude-code on a Mac and\n winget install Anthropic.ClaudeCode on Windows both work, but neither\nauto-updates - upgrading is on you,\
          \ with brew"
tags:
- name: Api
- name: Install
components:
  securitySchemes:
    WordPress_application_password:
      type: http
      scheme: basic
      x-source: https://dispatchseo.com/docs
security:
- WordPress_application_password: []