HiAPI

HiAPI API

HiAPI API as documented publicly: 6 operations. Contract generated from the documentation by API Evangelist (2026-11-11); not the provider's own document.

GitHub OpenAPI

Operations 6

GET /v1/chat/completions GET /v1/chat/completions #
POST /v1/chat/completions POST /v1/chat/completions #
POST /v1/responses POST /v1/responses #
GET /v1/tasks List tasks (paginated, newest first) #
POST /v1/tasks Create a task , returns taskId #
GET /v1/tasks/{id} Get task detail : status, output, or failure reason #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/hiapi-ai/openapi/_ae-authored/hiapi-ai-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/hiapi-ai/json-schema/hiapi-ai-post-v1-responses-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hiapi-ai/json-schema/hiapi-ai-get-v1-tasks-id-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hiapi-ai/json-schema/hiapi-ai-post-v1-tasks-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/hiapi-ai/json-schema/hiapi-ai-get-v1-tasks-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hiapi-ai/json-schema/hiapi-ai-post-v1-tasks-response-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/hiapi-ai/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/hiapi-ai:hiapi-ai-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hiapi-ai-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: HiAPI API
  version: '2026-11-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-11: 6 operation(s) read from 8 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; HiAPI has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 3
    pages-with-code: 6
    pages-read: 8
  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://hiapi.ai/docs/async-api
  - https://hiapi.ai/docs/text-api/responses
  - https://hiapi.ai/docs/text-api/chat-completions
  - https://hiapi.ai/docs/zh/async-api
  - https://hiapi.ai/docs/async-api/list
  - https://hiapi.ai/docs/async-api/create
  - https://hiapi.ai/docs/async-api/detail
  - https://hiapi.ai/docs/zh/async-api/list
servers:
- url: https://api.hiapi.ai
paths:
  /v1/chat/completions:
    get:
      operationId: get_v1_chat_completions
      tags:
      - Chat
      summary: GET /v1/chat/completions
      x-source: https://hiapi.ai/docs/text-api/chat-completions
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://api.hiapi.ai/v1/chat/completions \\ -H \" Authorization: Bearer YOUR_API_KEY \" \\ -H \" Content-Type: application/json\
          \ \" \\ -d ' { \"model\": \"deepseek-v4-flash\", \"messages\": [{\"role\": \"user\", \"content\": \"Explain sparse attention.\"}], \"\
          stream\": false } ' \n Required fields are model and messages . Common optional fields include stream , max_tokens , thinking , reasoning_effort\
          \ , response_form"
    post:
      operationId: post_v1_chat_completions
      tags:
      - Chat
      summary: POST /v1/chat/completions
      x-source: https://hiapi.ai/docs/text-api/responses
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/responses:
    post:
      operationId: post_v1_responses
      tags:
      - Responses
      summary: POST /v1/responses
      x-source: https://hiapi.ai/docs/text-api/responses
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1ResponsesResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \" https://api.hiapi.ai/v1/responses \" \\ -H \" Authorization: Bearer YOUR_API_KEY \" \\ -H \" Content-Type: application/json\
          \ \" \\ -d ' { \"model\": \"YOUR_RESPONSES_MODEL_ID\", \"input\": [{ \"type\": \"message\", \"role\": \"user\", \"content\": [{\"type\"\
          : \"input_text\", \"text\": \"Explain sparse attention.\"}] }], \"reasoning\": {\"effort\": \"medium\"}, \"stream\": false } ' \n Request\
          \ shape Section titled “Request s"
  /v1/tasks:
    get:
      operationId: get_v1_tasks
      tags:
      - Tasks
      summary: List tasks (paginated, newest first)
      x-source: https://hiapi.ai/docs/async-api
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer YOUR_API_KEY required Account API key.
      - name: page
        in: query
        required: false
        schema:
          type: string
        description: Pagination page number.
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Number of tasks per page.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1TasksResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_tasks
      tags:
      - Tasks
      summary: Create a task , returns taskId
      x-source: https://hiapi.ai/docs/async-api
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer YOUR_API_KEY required Account API key.
      - name: Content-Type
        in: header
        required: false
        schema:
          type: string
        description: application/json optional. The body is always parsed as JSON.
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          type: string
        description: order-42-submit optional. Idempotency key — retries with the same key create the task only once.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1TasksRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1TasksResponse'
      x-evidence:
        kind: documentation
  /v1/tasks/{id}:
    get:
      operationId: get_v1_tasks_id
      tags:
      - Tasks
      summary: 'Get task detail : status, output, or failure reason'
      x-source: https://hiapi.ai/docs/async-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer YOUR_API_KEY required Account API key.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1TasksIdResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostV1ResponsesResponse:
      type: object
      properties:
        model:
          type: string
        input:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              role:
                type: string
              content:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                    text:
                      type: string
        reasoning:
          type: object
          properties:
            effort:
              type: string
        stream:
          type: boolean
    GetV1TasksResponse:
      type: object
      properties:
        tasks:
          type: string
          description: Array of task summary objects.
        next_page_token:
          type: string
          description: Token for fetching the next page.
    PostV1TasksRequest:
      type: object
      properties:
        model:
          type: string
          description: Model to use for generation.
        input:
          type: string
          description: Model‑specific input fields.
        callback:
          type: string
          description: Optional callback object with url.
      required:
      - model
      - input
    PostV1TasksResponse:
      type: object
      properties:
        taskId:
          type: string
          description: Identifier of the created task.
    GetV1TasksIdResponse:
      type: object
      properties:
        status:
          type: string
          description: Task status enum (queued, handling, archiving, success, fail).
        output:
          type: string
          description: Output data when status is success.
        error:
          type: string
          description: Error object when status is fail.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Chat
- name: Responses
- name: Tasks