Skip to Content
APIOpenAPI Specification

OpenAPI Specification

The Curate-Me gateway and admin APIs are built with FastAPI , which auto-generates an OpenAPI 3.1 specification from route definitions, Pydantic models, and docstrings. You can use this spec to explore available endpoints, generate client code, or import into API tools like Postman.

Specification URLs

Production

APISpec URLSwagger UI
Gateway (port 8002)https://api.curate-me.ai/openapi.json/docs 
Admin / B2B (port 8001)https://api.curate-me.ai/admin/openapi.json/admin/docs 

Local Development

APISpec URLSwagger UI
Gatewayhttp://localhost:8002/openapi.jsonlocalhost:8002/docs 
Admin / B2Bhttp://localhost:8001/openapi.jsonlocalhost:8001/docs 

What Is Covered

The OpenAPI spec fully documents all governance and admin endpoints, including:

  • Organization management, API key CRUD, and billing
  • Runner lifecycle (create, start, stop, destroy, inspect)
  • Cost tracking, budget configuration, and usage reports
  • Webhook subscriptions and event types
  • DAG workflow definitions and execution
  • A2A (agent-to-agent) messaging and registry

Note on proxy endpoints: The gateway proxy routes (/v1/openai/*, /v1/anthropic/*, /v1/cohere/*, etc.) are pass-through proxies. Their request and response schemas follow the upstream provider’s API documentation. The OpenAPI spec lists these routes but defers to the provider for payload details.

Usage Examples

Import into Postman

  1. Open Postman and click Import.
  2. Select Link and paste: https://api.curate-me.ai/openapi.json
  3. Postman generates a collection with all endpoints, parameters, and example bodies.

Generate a Client with openapi-generator

# Install the generator npm install -g @openapitools/openapi-generator-cli # Generate a TypeScript client openapi-generator-cli generate \ -i https://api.curate-me.ai/openapi.json \ -g typescript-fetch \ -o ./generated-client # Generate a Python client openapi-generator-cli generate \ -i https://api.curate-me.ai/openapi.json \ -g python \ -o ./generated-client

Use with AI Coding Assistants

Download the spec and include it as context when prompting an AI assistant to write integration code:

curl -o curate-me-openapi.json https://api.curate-me.ai/openapi.json

Then pass the file as context to your assistant. This gives it full knowledge of available endpoints, request schemas, and response types.

Fetch the Spec Programmatically

import httpx spec = httpx.get("https://api.curate-me.ai/openapi.json").json() print(f"API title: {spec['info']['title']}") print(f"Endpoints: {len(spec['paths'])} paths")

ReDoc (Alternative UI)

FastAPI also serves a ReDoc-powered reference at /redoc:

ReDoc provides a three-panel layout that is useful for reading through the full API reference.