Joxo API

openapi: 3.1.0
info:
  title: Joxo API
  version: '2026-11-13'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-13: 5 operation(s) read from 32 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Joxo has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 3
    pages-with-code: 32
    pages-read: 32
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-13'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://joxo.ai/vs/hapi
  - https://joxo.ai/docs/getting-started
  - https://joxo.ai/docs/getting-started/several-agents
  - https://joxo.ai/docs/guides/gemini-cli-and-claude-code-together
  - https://joxo.ai/docs/guides/ai-collaboration-tools-for-developers
  - https://joxo.ai/docs/guides/claude-code-handoff-between-developers
  - https://joxo.ai/docs/guides/approve-claude-code-and-codex-from-phone
  - https://joxo.ai/docs/guides/ask-a-teammates-ai-agent-for-help
  - https://joxo.ai/docs/guides/chinese-models-with-claude-code
  - https://joxo.ai/docs/guides/claude-code-agent-teams-vs-real-teammates
  - https://joxo.ai/docs/guides/claude-code-and-codex-same-repo
  - https://joxo.ai/docs/guides/claude-code-and-codex-together
  - https://joxo.ai/docs/guides/claude-code-notification-when-waiting
  - https://joxo.ai/docs/guides/claude-code-sessions-message-each-other
  - https://joxo.ai/docs/guides/claude-code-team-collaboration
  - https://joxo.ai/docs/guides/claude-code-with-glm
  - https://joxo.ai/docs/guides/control-claude-code-from-phone
  - https://joxo.ai/docs/guides/cursor-and-claude-code-together
  - https://joxo.ai/docs/guides/keep-mac-awake-for-claude-code
  - https://joxo.ai/docs/guides/manage-many-claude-code-sessions
  - https://joxo.ai/docs/guides/mcp-server-for-team-collaboration
  - https://joxo.ai/docs/guides/multiplayer-ai-coding
  - https://joxo.ai/docs/guides/one-inbox-for-coding-agent-questions
  - https://joxo.ai/docs/guides/opencode-and-claude-code-together
  - https://joxo.ai/docs/guides/run-multiple-ai-agents-on-one-project
  - https://joxo.ai/docs/guides/see-what-your-coding-agents-are-doing
  - https://joxo.ai/docs/guides/share-claude-code-session-with-team
  - https://joxo.ai/docs/guides/share-context-between-ai-coding-agents
  - https://joxo.ai/docs/guides/slack-for-ai-coding-agents
  - https://joxo.ai/docs/guides/task-board-for-ai-coding-agents
  - https://joxo.ai/docs/guides/use-your-own-ai-subscription-with-a-team
  - https://joxo.ai/vs/agentsroom
paths:
  /install:
    get:
      operationId: get_install
      tags:
      - Install
      summary: 'Setup is one line in a terminal: sh curl -fsSL https://joxo.ai/install | sh'
      x-source: https://joxo.ai/docs/guides/claude-code-notification-when-waiting
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /install.sh:
    get:
      operationId: get_install_sh
      tags:
      - Install
      summary: GET /install.sh
      x-source: https://joxo.ai/docs/guides/use-your-own-ai-subscription-with-a-team
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSL https://claude.ai/install.sh | bash \n cd your-project\n claude \n On first start it opens a browser window to sign\
          \ in with your Claude account. Anthropic's guide to using Claude Code with your Pro or Max plan covers the details. Run /status inside\
          \ a session to see which account and sign-in method are active. \n Watch for a stray API key. If ANTHROPIC_ API_ KEY is set in your\
          \ shell, Claude "
  /orders.csv:
    get:
      operationId: get_orders_csv
      tags:
      - Orders
      summary: 'CSV export: GET /orders.csv streams every order.'
      x-source: https://joxo.ai/docs/guides/run-multiple-ai-agents-on-one-project
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /setup.sh:
    get:
      operationId: get_setup_sh
      tags:
      - Setup
      summary: 'paste into your agent Set up Joxo here: curl -fsSL https://joxo.ai/setup.sh | sh'
      x-source: https://joxo.ai/docs/guides/claude-code-notification-when-waiting
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /your-private-topic:
    get:
      operationId: get_your_private_topic
      tags:
      - Your Private Topic
      summary: GET /your-private-topic
      x-source: https://joxo.ai/docs/guides/claude-code-notification-when-waiting
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -s -d @- https://ntfy.sh/your-private-topic \n Use a long random topic name, because anyone who knows it can read the messages.\
          \ Never put file contents or command text in the push. \n What goes wrong with several sessions? # \n The options above are built for\
          \ one person and one session. They start to fray when you run five sessions, or when a team does: \n Every alert looks the same. \"\
          Claude need"
tags:
- name: Install
- name: Orders
- name: Setup
- name: Your Private Topic