Swarms API Documentation - Build AI Agents & Multi-Agent Systems

The Swarms Marketplace publishes a machine-readable OpenAPI schema describing its public HTTP API. Point a code generator, an API client, or an agent at one URL instead of hand-writing request models. Schema URL: https://swarms.world/openapi.json

At a Glance

Property	Value
Schema URL	`https://swarms.world/openapi.json`
Format	OpenAPI, JSON
API base URL	`https://swarms.world`
Authentication	`Authorization: Bearer YOUR_API_KEY`
Access	Public - no API key needed to read the schema
Covers	Products, agents, prompts, bundles, reviews, token launch, fee claims

This is the Marketplace schema. The Swarms API (agent and swarm execution) publishes a separate schema at https://api.swarms.world/openapi.json, which powers the API Reference tab of these docs. The two are independent - different base URLs, different endpoints.

Fetching the Schema

The schema endpoint is public. No API key is required to download it.

curl -s https://swarms.world/openapi.json -o swarms-marketplace-openapi.json

import json
import requests

spec = requests.get("https://swarms.world/openapi.json", timeout=30).json()

print(spec["info"]["title"], spec["info"]["version"])
for path, methods in spec["paths"].items():
    for method in methods:
        print(f"{method.upper():6} {path}")

const res = await fetch("https://swarms.world/openapi.json");
const spec = await res.json();

for (const [path, methods] of Object.entries(spec.paths)) {
  for (const method of Object.keys(methods as object)) {
    console.log(`${method.toUpperCase().padEnd(6)} ${path}`);
  }
}

If a scripted fetch returns an HTML page titled Vercel Security Checkpoint with a 429 status instead of JSON, your client was flagged by bot protection. Open the URL in a browser to download the file, or retry from a different network, then commit the saved copy to your repo and generate from the local file.

What the Schema Covers

The schema describes the marketplace endpoints documented across this section:

Area	Endpoint	Method	Auth	Reference
Products	`/api/product/list`	GET	Required	List Products API
Products	`/api/product/fees`	GET	Required	Product Fees API
Agents	`/api/add-agent`	POST	Required	Agents API
Agents	`/api/edit-agent`	POST	Required	Agents API
Agents	`/api/query-agents`	POST	Optional	Agents API
Prompts	`/api/add-prompt`	POST	Required	Prompts API
Prompts	`/api/edit-prompt`	POST	Required	Prompts API
Prompts	`/api/query-prompts`	POST	Optional	Prompts API
Bundles	`/api/v1/publish/bundle`	POST	Required	Bundles API
Reviews	`/api/reviews`	GET / POST	POST only	Reviews API
Token Launch	`/api/token/launch`	POST	Required	Token Launch API
Token Launch	`/api/token/launch/batch`	POST	Required	Token Launch Batch API
Fees	`/api/product/claimfees`	POST	Wallet key in body	Claim Fees API

A fuller list, including read endpoints such as /api/get-agents/[id]/full and /api/get-tokenized-products, is in User Marketplace Endpoints.

The live schema is the source of truth. If it lists an operation this table does not, prefer the schema - it tracks the deployed API. Enumerate the current surface with the fetch snippets above.

Authentication

Marketplace endpoints authenticate with a bearer token:

curl -X GET "https://swarms.world/api/product/list" \
  -H "Authorization: Bearer $SWARMS_API_KEY"

Generated clients expose this as a bearer security scheme - set the token once when constructing the client rather than on each call. Get a key at swarms.world/platform/api-keys.

Never commit an API key into a generated client’s config. Read it from an environment variable such as SWARMS_API_KEY.

Generate a Client

# Type-only: emits interfaces for every request and response body
npx openapi-typescript https://swarms.world/openapi.json \
  -o src/swarms-marketplace.d.ts

# Full client with models and methods
npx @openapitools/openapi-generator-cli generate \
  -i https://swarms.world/openapi.json \
  -g python \
  -o ./swarms-marketplace-python \
  --additional-properties=packageName=swarms_marketplace

npx @openapitools/openapi-generator-cli generate \
  -i https://swarms.world/openapi.json \
  -g go \
  -o ./swarms-marketplace-go

npx @openapitools/openapi-generator-cli generate \
  -i https://swarms.world/openapi.json \
  -g rust \
  -o ./swarms-marketplace-rust

Generate from a committed local copy of the schema rather than the live URL in CI. Your build then stays reproducible, and a schema change shows up as a reviewable diff instead of a surprise build failure.

Import into API Tools

Postman

Import → Link, paste https://swarms.world/openapi.json, and Postman builds a collection with every endpoint and example body. Add a collection-level Bearer Token auth with your API key so all requests inherit it.

Insomnia

Create → Import From → URL, paste the schema URL. Insomnia generates a request per operation. Set the bearer token in an environment variable so it is not stored in the exported workspace.

Bruno

Use bruno import openapi swarms-marketplace-openapi.json against a downloaded copy - Bruno collections are plain files, so the imported collection can live in your repo alongside your integration code.

Local API explorer

Render a browsable reference from the schema without deploying anything:

npx @redocly/cli preview-docs https://swarms.world/openapi.json

Validate the Schema

Useful when you have pinned a local copy and want to confirm it still parses before generating from it:

npx @redocly/cli lint swarms-marketplace-openapi.json

npx mint openapi-check https://swarms.world/openapi.json

Use the Schema with Agents

An OpenAPI document is a tool definition an agent can read directly. Two practical paths:

Feed the schema to an agent

Pass the fetched schema (or a filtered subset of its paths) into your agent’s tool definitions so it can call marketplace endpoints itself. Trim to the operations the agent actually needs - a full spec wastes context.

Use the hosted MCP server

For agent and swarm execution, the hosted MCP server at mcp.swarms.world already exposes the Swarms API as MCP tools - no schema parsing needed.

Keeping in Sync

The marketplace API evolves. To avoid silent drift:

Pin a copy

Commit the fetched schema to your repo and generate clients from that file.

Diff on a schedule

Re-fetch the live schema in CI and diff it against the pinned copy. A non-empty diff is a signal to review, not an automatic upgrade.

Regenerate deliberately

When you accept a change, regenerate the client and run your integration tests before shipping.

# Example CI drift check
curl -s https://swarms.world/openapi.json -o /tmp/live-openapi.json
diff <(jq -S . swarms-marketplace-openapi.json) <(jq -S . /tmp/live-openapi.json) \
  && echo "Schema unchanged" \
  || echo "Schema drift detected - review before regenerating"

API Overview

Endpoint index, status codes, and rate limits

API Keys

Create and manage marketplace API keys

Agents API

Complete reference for agent management

Prompts API

Complete reference for prompt management

Token Launch API

Launch tokenized agents on Solana

Examples

Real-world marketplace integration examples

Platform

Fiat Payments

Launchpad

API

Examples

Resources

OpenAPI Schema

At a Glance

Fetching the Schema

What the Schema Covers

Authentication

Generate a Client

Import into API Tools

Validate the Schema

Use the Schema with Agents

Feed the schema to an agent

Use the hosted MCP server

Keeping in Sync

API Overview

API Keys

Agents API

Prompts API

Token Launch API

Examples

​At a Glance

​Fetching the Schema

​What the Schema Covers

​Authentication

​Generate a Client

​Import into API Tools

​Validate the Schema

​Use the Schema with Agents

Feed the schema to an agent

Use the hosted MCP server

​Keeping in Sync

​Related Resources

API Overview

API Keys

Agents API

Prompts API

Token Launch API

Examples

At a Glance

Fetching the Schema

What the Schema Covers

Authentication

Generate a Client

Import into API Tools

Validate the Schema

Use the Schema with Agents

Keeping in Sync

Related Resources