FAQ

Where is the API reference?

The complete API reference is at /settings/api-docs. It includes live examples, request schemas, and response formats.

Why don't the docs show endpoint details?

The /docs section focuses on guides and best practices. All endpoint details, schemas, and examples are in the API reference to maintain a single source of truth.

How do I authenticate?

Create an API key at /settings/apikeys, then include it in requests:

Authorization: Bearer YOUR_API_KEY

See the Authentication guide for more details.

Can I explore capabilities before using them?

Yes. Use any of these methods:

• Browse the API reference
• GET /v1/schema — list all capabilities
• GET /v1/schema/{capability} — get a specific schema
• apimux schema capabilities — CLI command
• apimux schema show <capability> — CLI schema viewer

Does the CLI work in automated environments?

Yes. Set APIMUX_API_KEY as an environment variable for non-interactive use:

export APIMUX_API_KEY=your_key_here
apimux schema capabilities

How do I set up APIMUX for AI agents?

See the For Agents guide for step-by-step setup instructions and a ready-to-use agent prompt template.