Hokai API

openapi: 3.1.0
info:
  title: Hokai API
  version: '2026-11-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-11: 11 operation(s) read from 7 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Hokai has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 8
    pages-with-code: 3
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://hokai.io/api/agent/catalog
  - https://hokai.io/api/agent/openapi.json
  - https://hokai.io/hub/tools/apimodels
  - https://hokai.io/directory/skills/developer
  - https://hokai.io/hub/tools/speko
  - https://hokai.io/directory/skills/search
  - https://hokai.io/guides/hermes-agent-vs-openclaw
paths:
  /aisync/install.sh:
    get:
      operationId: get_aisync_install_sh
      tags:
      - Aisync
      summary: GET /aisync/install.sh
      x-source: https://hokai.io/directory/skills/developer
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl -fsSL https://maxont.github.io/aisync/install.sh | bash 11 Nov Cloakroom Masks secrets and personal data before your coding
          agent sees them. Claude · Codex · Cursor · Gemini Skill file /plugin marketplace add shanjeevrajendran/cloakroom 11 Nov FactIQ Gives
          an agent read-only SQL over 100M+ official economic and financial series. Claude · ChatGPT · Codex MCP /plugin marketplace add defog-ai/fa
  /api/agent/guide-spot:
    post:
      operationId: post_api_agent_guide_spot
      tags:
      - Api
      summary: Guide spots
      description: A paid, labelled Sponsored entry in one Hokai guide.
      x-source: https://hokai.io/api/agent/catalog
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAgentGuideSpotRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiAgentGuideSpotResponse'
      x-evidence:
        kind: documentation
  /api/agent/leads:
    post:
      operationId: post_api_agent_leads
      tags:
      - Api
      summary: Leads
      description: A buyer who told Smart Match the job, the tools they use and often the budget, then said yes to hearing from vendors.
      x-source: https://hokai.io/api/agent/catalog
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAgentLeadsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiAgentLeadsResponse'
      x-evidence:
        kind: documentation
  /api/agent/listing:
    post:
      operationId: post_api_agent_listing
      tags:
      - Api
      summary: Get listed
      description: POST the product's endpoint with a contact email. You get back checkout_url, a Stripe card payment page.
      x-source: https://hokai.io/api/agent/catalog
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAgentListingRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiAgentListingResponse'
      x-evidence:
        kind: documentation
  /api/agent/order:
    get:
      operationId: get_api_agent_order
      tags:
      - Api
      summary: order_status
      description: Retrieve order status.
      x-source: https://hokai.io/api/agent/catalog
      parameters:
      - name: session_id
        in: query
        required: true
        schema:
          type: string
        description: the cs_... id from checkout_url's session
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/listing/badge:
    post:
      operationId: post_api_listing_badge
      tags:
      - Api
      summary: Free with the "Listed on Hokai" badge on a page of the product's own site, as a normal followed link.
      description: Free route for listing using a badge.
      x-source: https://hokai.io/api/agent/catalog
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiListingBadgeRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiListingBadgeResponse'
      x-evidence:
        kind: documentation
  /api/v1/search:
    get:
      operationId: get_api_v1_search
      tags:
      - Api
      summary: SearchApi Live Google and dozens of other search engines as JSON
      x-source: https://hokai.io/directory/skills/search
      parameters:
      - name: engine
        in: query
        required: true
        schema:
          type: string
        description: Search engine to use
      - name: q
        in: query
        required: true
        schema:
          type: string
        description: Search query
      - name: location
        in: query
        required: false
        schema:
          type: string
        description: Location for localized results
      - name: api_key
        in: query
        required: true
        schema:
          type: string
        description: API key for SearchApi
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /https://jina.ai/news:
    get:
      operationId: get_https_jina_ai_news
      tags:
      - Https
      summary: GET /https://jina.ai/news
      x-source: https://hokai.io/directory/skills/search
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl "https://r.jina.ai/https://jina.ai/news" -H "Authorization: Bearer YOUR_JINA_KEY" 11 Oct SearchApi Live Google and dozens
          of other search engines as JSON, one GET call per query. Claude · ChatGPT · Gemini REST API curl "https://www.searchapi.io/api/v1/search?engine=google&q=best+ai+search+api&location=New+York,United+States&api_key=YOUR_API_KEY"
          11 Oct Orthogonal Find Leads Give AI agents ins'
  /install.sh:
    get:
      operationId: get_install_sh
      tags:
      - Install
      summary: GET /install.sh
      x-source: https://hokai.io/guides/hermes-agent-vs-openclaw
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash \n Hermes' source installer pulls in Python 3.14 along with\
          \ Node.js and ripgrep, according to its README. \n Hermes also ships a desktop app as its front door. Its homepage lists a download\
          \ for macOS 12 or newer and for Windows 10 and 11, with Linux through the terminal. For someone who has never opened a terminal, that\
          \ matters more "
  /v1/models:
    get:
      operationId: get_v1_models
      tags:
      - Models
      summary: 'Speko Review (2026): Pricing, Verdict & Alternatives | Hokai'
      x-source: https://hokai.io/hub/tools/speko
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/records/{id}:
    get:
      operationId: get_v1_records_id
      tags:
      - Records
      summary: Any request can be looked up with GET /v1/records/{id}.
      x-source: https://hokai.io/hub/tools/apimodels
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiAgentGuideSpotRequest:
      type: object
      properties:
        email:
          type: string
          description: a work email
        guide:
          type: string
          description: a guide slug from guides[] below
        product:
          type: string
          description: 'required: {"type":"tools","slug":"<hokai slug>"} for a product already on Hokai, or {"name":"...","url":"https://..."}
            for one that is not'
        starts_on:
          type: string
          description: 'optional, YYYY-MM-DD (default: the guide''s next free day)'
        months:
          type: string
          description: optional, one of 3, 6, 12 (default 3)
        company:
          type: string
          description: optional
        agent:
          type: string
          description: optional, your agent's name
      required:
      - email
      - guide
      - product
    PostApiAgentGuideSpotResponse:
      type: object
      properties:
        checkout_url:
          type: string
          description: Stripe card payment page
    PostApiAgentLeadsRequest:
      type: object
      properties:
        email:
          type: string
          description: a work email
        quantity:
          type: string
          description: 1 to 20
        company:
          type: string
          description: optional
        agent:
          type: string
          description: optional, your agent's name
      required:
      - email
      - quantity
    PostApiAgentLeadsResponse:
      type: object
      properties:
        checkout_url:
          type: string
          description: Stripe card payment page
    PostApiAgentListingRequest:
      type: object
      properties:
        tool_url:
          type: string
          description: the product's website
        email:
          type: string
          description: a work email
        company:
          type: string
          description: optional
        note:
          type: string
          description: optional, context for the editor
        agent:
          type: string
          description: optional, your agent's name
      required:
      - tool_url
      - email
    PostApiAgentListingResponse:
      type: object
      properties:
        checkout_url:
          type: string
          description: Stripe card payment page
    PostApiListingBadgeRequest:
      type: object
      properties:
        tool_url:
          type: string
          description: required
        email:
          type: string
          description: required
        badge_page_url:
          type: string
          description: required, the page that carries the badge
        company:
          type: string
          description: optional
      required:
      - tool_url
      - email
      - badge_page_url
    PostApiListingBadgeResponse:
      type: object
      properties:
        checkout_url:
          type: string
          description: Stripe card payment page
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Aisync
- name: Api
- name: Https
- name: Install
- name: Models
- name: Records