AsyncAPI

AsyncAPI Help API

The Help API from AsyncAPI — 1 operation(s) for help.

Documentation GitHub OpenAPI

Operations 1

GET /help Retrieve help information for the given command #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/asyncapi/openapi/asyncapi-help-api-openapi.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/asyncapi:asyncapi-help-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

openapi: 3.2.0
info:
  version: 0.2.0
  title: AsyncAPI Server Help API
  description: Server API providing official AsyncAPI tools
  contact:
    name: AsyncAPI Initiative
    email: info@asyncapi.io
    url: https://asyncapi.com/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://api.asyncapi.com/v1
tags:
- name: Help
paths:
  /help:
    get:
      summary: Retrieve help information for the given command
      operationId: help
      tags:
      - Help
      parameters:
      - name: command
        in: query
        style: form
        explode: true
        description: The command for which help information is needed.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Help information retrieved successfully.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/HelpListResponse'
                - $ref: '#/components/schemas/HelpCommandResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: Command not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        default:
          description: Unexpected problem.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
components:
  schemas:
    HelpCommandResponse:
      type: object
      description: Detailed help information for a specific command.
      properties:
        command:
          type: string
          description: The name of the command.
        description:
          type: string
          description: Detailed description of the command.
    Problem:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: 'An absolute URI that identifies the problem type. When dereferenced,

            it SHOULD provide human-readable documentation for the problem type

            (e.g., using HTML).

            '
          default: about:blank
          example: https://api.asyncapi.com/problem/invalid-template-parameters
        title:
          type: string
          description: 'A short, summary of the problem type. Written in english and readable.

            '
          example: Invalid AsyncAPI document.
        status:
          type: integer
          format: int32
          description: 'The HTTP status code generated by the origin server for this occurrence

            of the problem.

            '
          minimum: 100
          maximum: 600
          exclusiveMaximum: true
          example: 422
        detail:
          type: string
          description: 'A human readable explanation specific to this occurrence of the problem.

            '
          example: Connection to database timed out
        instance:
          type: string
          format: uri
          description: 'An absolute URI that identifies the specific occurrence of the problem.

            It may or may not yield further information if dereferenced.

            '
      required:
      - type
      - title
      - status
      additionalProperties: true
    HelpListResponse:
      type: object
      properties:
        commands:
          type: array
          items:
            type: string
          description: A list of all available commands.
x-provenance:
  method: harvested
  publisher: AsyncAPI
  source: https://api.asyncapi.com/v1/docs/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)