Sign in
catalog

Import an API spec or workflow — add to the searchable catalog

Registers an OpenAPI spec or Arazzo workflow into the catalog and BM25 index. Source types: path (local file), url (fetch from URL), inline (spec content in request body). For OpenAPI specs: parses operations, computes capability IDs, indexes descriptions. For Arazzo workflows: stores definition, extracts input schema and involved APIs. Returns the registered API or workflow with its canonical id.

post/import

Request body

Example request

{
  "sources": [
    {
      "url": "https://api.example.com/openapi.json",
      "filename": "my-api.json",
      "force_api_id": "github"
    }
  ]
}

Response

Successful Response

statusstring required

Import status: 'ok' if all sources succeeded, 'partial' if some failed, 'failed' if all failed

idstring nullable

Registered API ID (for OpenAPI specs) or workflow slug (for Arazzo)

namestring nullable

Display name extracted from spec (info.title for APIs, workflow.summary for workflows)

operations_indexedinteger nullable

Number of operations parsed and indexed in BM25 (OpenAPI specs only)

typestring nullable

Import type: 'api' for OpenAPI specs, 'workflow' for Arazzo documents

Example response

{
  "status": "imported",
  "id": "api.github.com",
  "name": "GitHub REST API",
  "operations_indexed": 247,
  "type": "api"
}

Changes