AsyncAPI Generate API
The Generate API from AsyncAPI — 1 operation(s) for generate.
The Generate API from AsyncAPI — 1 operation(s) for generate.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/asyncapi:asyncapi-generate-api"
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.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 0.2.0
title: AsyncAPI Server Generate 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: Generate
paths:
/generate:
post:
summary: Generate the given AsyncAPI template
operationId: generate
tags:
- Generate
externalDocs:
name: Github Repository for the AsyncAPI Generator
url: https://github.com/asyncapi/generator
requestBody:
description: Template details to be generated.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateRequest'
responses:
'200':
description: Template successfully generated.
content:
application/zip:
schema:
$ref: '#/components/schemas/GenerateResponse'
'400':
description: Failed to generate the given template due to invalid AsyncAPI document.
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
'422':
description: Failed to generate the given template due to invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
default:
description: Unexpected problem.
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
components:
schemas:
GenerateRequest:
type: object
required:
- asyncapi
- template
properties:
asyncapi:
$ref: '#/components/schemas/AsyncAPIDocument'
template:
type: string
description: Template name to be generated.
enum:
- '@asyncapi/dotnet-nats-template'
- '@asyncapi/go-watermill-template'
- '@asyncapi/html-template'
- '@asyncapi/java-spring-cloud-stream-template'
- '@asyncapi/java-spring-template'
- '@asyncapi/java-template'
- '@asyncapi/markdown-template'
- '@asyncapi/nodejs-template'
- '@asyncapi/nodejs-ws-template'
- '@asyncapi/python-paho-template'
- '@asyncapi/ts-nats-template'
- '@asyncapi/minimaltemplate'
- '@asyncapi/dotnet-rabbitmq-template'
use-fallback-generator:
type: boolean
description: Use generator version 1.17.25
default: false
parameters:
type: object
description: "Template parameters to be generated. Each template has different parameters that you should check in the documentation, \nwhich is usually located in the template's repository.\nThis field is optional but may be required for some templates.\n"
additionalProperties: true
GenerateResponse:
type: string
format: binary
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
AsyncAPIDocument:
description: AsyncAPI document in JSON or YAML.
oneOf:
- type: string
- $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.0.0.json
- $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.1.0.json
- $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.2.0.json
- $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.3.0.json
- $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.4.0.json
- $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.5.0.json
- $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.6.0.json
- $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/3.0.0.json
- $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/3.1.0.json
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)