API Reference

Build powerful AI agent workflows with our comprehensive REST API. Explore 151 endpoints across 6 categories.

151

Endpoints

Groups

Categories

Prefer the terminal? Use the Fruxon CLI

The Fruxon CLI is the fastest way to explore and call the API — authenticated calls, real responses, no scaffolding. Every write command accepts --schema to print the live JSON Schema for its request body, so coding agents can author valid requests against the same OpenAPI spec these docs are built from. There's a drop-in bootstrap snippet for Claude Code / Cursor.

pip install fruxon
fruxon login
fruxon agents list
fruxon agents create --schema > schema.json   # live request shape, pipe to your LLM

API Categories

Agents

Create, configure, and manage AI agents with versioning, execution, and asset management.

Evaluation

Test and evaluate agent performance with datasets and sample management.

Connectors

Connect agents to external platforms and manage conversations.

Integrations

Extend functionality with third-party integrations and custom tools.

Users

Manage users, API keys, invitations, and authentication.

System

Health checks, storage, forms, and system utilities.

Base URL

All API requests should be made to:

https://api.fruxon.com

Authentication

The API supports two authentication methods:

User Token (Most endpoints)

Most endpoints require a Bearer token from your logged-in session:

curl -X GET "https://api.fruxon.com/v1/tenants" \
  -H "Authorization: Bearer YOUR_USER_TOKEN" \
  -H "Content-Type: application/json"

API Key (Agent execution)

Agent execution endpoints use an API key in the X-API-KEY header:

curl -X POST "https://api.fruxon.com/v1/tenants/{tenant}/agents/{agent}:execute" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Generate API Keys

To generate an API key for agent execution, see the Settings guide.

Rate Limiting

API requests are rate limited to ensure fair usage. Rate limit headers are included in all responses:

X-RateLimit-Limit: Maximum requests per window
X-RateLimit-Remaining: Remaining requests in current window
X-RateLimit-Reset: Unix timestamp when the window resets