Skip to main content

API Reference — Overview

Every endpoint exposed by marketplace-fleapoai-service is auto-generated from its OpenAPI 3 spec.

Where the spec comes from​

The NestJS backend produces openapi.json via Swagger module decorators on controllers and DTOs. The docs site does not copy code; it consumes that spec.

Two locations the docs site looks for the spec, in order:

  1. marketplace-fleapoai-service/openapi.json — preferred (authoritative).
  2. fleapo-marketplace/openapi.json — fallback (vendored copy used by orval).

Override with MARKETPLACE_OPENAPI_PATH=/absolute/path/to/openapi.json pnpm sync-spec.

Sync command​

cd marketplace-docs
pnpm sync-spec        # copies openapi.json → openapi/marketplace.json
pnpm refresh-api      # sync + clean + regenerate MDX pages in docs/05-api-reference/api/
pnpm start            # open http://localhost:3000 to preview

After a refresh, the Endpoints group in the sidebar repopulates from the spec's tags.

Try-it-out console​

Each endpoint page has a "Send API Request" panel. It will:

  • Build the curl / fetch snippet for you.
  • Let you fill path / query / body parameters interactively.
  • Send the request to the configured server URL.
  • Show response status, headers, body.

The console talks to whatever servers[] entry you select. Default options are http://localhost:3000 (local dev) and https://api.fleapo.ai (production). Be careful with mutating endpoints against production.

Pages you'll want before the generated ones​

  • Authentication — how to get a session cookie or bearer token for the console.
  • Conventions — every endpoint follows the same envelope and naming rules.
  • Errors — every error.code value and what it means.
  • Pagination — cursor format.

Then dive into the endpoints by tag: Agents, Capabilities, Steps, Pricing, Tier Quotas, Subscriptions, Usage, Reviews, Tags, Waitlist, Webhooks, Interactions, Auth, Health.