mixus API documentation

Overview

The mixus API enables you to interact with your AI agents programmatically. Create eval tasks, automate workflows, and integrate mixus capabilities into your own applications.

Authentication

All API requests require authentication using an API key in the Authorization header:

curl https://app.mixus.ai/api/endpoint \
  -H "Authorization: Bearer YOUR_API_KEY"

Getting your API key

Navigate to Integrations → API Keys
Click “Generate API Key”
Select permissions and expiration
Copy your key (shown only once!)

API Key Format: mxs_eval_[32 random characters]
Example: mxs_eval_A7k2mN9pQx4vZ8wB3cF1dG6hJ5lK0sM

API endpoints

Evaluation API

Create and manage AI agent evaluations programmatically.

Create eval task

POST /api/eval/create-task-agent

Required Scope: eval:create Request body:

{
  "taskName": "My Evaluation Task",
  "taskDescription": "Detailed task description...",
  "autoDetectCheckpoints": true,
  "testMode": "with-verification",
  "assignedReviewer": "reviewer@example.com"
}

Response:

{
  "success": true,
  "executionId": "670a1b2c3d4e5f6g7h8i9j0k",
  "chatId": "670a1b2c3d4e5f6g7h8i9j0l",
  "chatUrl": "https://app.mixus.ai/chat/670a1b2c3d4e5f6g7h8i9j0l",
  "checkpointCount": 2,
  "message": "Eval agent created and execution started"
}

Get execution status

GET /api/eval/status/{executionId}

Required Scope: eval:read Response:

{
  "success": true,
  "execution": {
    "id": "670a1b2c3d4e5f6g7h8i9j0k",
    "status": "running",
    "progress": {
      "totalSteps": 5,
      "completedSteps": 2,
      "percentComplete": 40
    },
    "checkpoints": {
      "total": 2,
      "completed": 1,
      "details": [...]
    },
    "metrics": {
      "tapsUsed": 1,
      "expectedTaps": 2,
      "durationSeconds": 145,
      "model": "claude-3-5-sonnet-20241022"
    },
    "chatUrl": "https://app.mixus.ai/chat/...",
    "isRunning": true
  }
}

Permissions & scopes

Control what your API keys can do with granular permissions:

Scope	Description	What it allows
`eval:create`	Create eval tasks	Create and run evaluation agents
`eval:read`	Read eval metrics	View execution status, checkpoints, performance
`eval:manage`	Manage evals	Full access - create, read, update, delete
`automation:run`	Run automations	Coming soon
`analytics:read`	Read analytics	Coming soon
`agents:manage`	Manage agents	Coming soon

Rate limits

Rate Limit: 100 requests per minute per API key
Concurrent Executions: 10 simultaneous eval tasks
Key Generation: 10 active keys per user

Rate limit headers:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1625097600

Best practices

Security

✅ DO:

Store API keys in environment variables
Use different keys for dev/staging/production
Rotate keys regularly (30-90 days)
Revoke keys immediately if compromised
Use minimal required scopes

❌ DON’T:

Commit API keys to git
Share keys between team members
Use production keys in development
Store keys in client-side code

Example: Secure storage

# .env file (gitignored)
MIXUS_API_KEY=mxs_eval_your_key_here

# Use in scripts
curl https://app.mixus.ai/api/eval/create-task-agent \
  -H "Authorization: Bearer $MIXUS_API_KEY" \
  -d '{...}'

Next steps

Eval API Guide - Detailed evaluation API documentation
Quick Start - Get started in 5 minutes
Code Examples - Ready-to-use examples in Python, Node.js, cURL

Support

Need help? Contact us:

Email: support@mixus.ai
Documentation: https://docs.mixus.ai
Status: https://status.mixus.ai

Getting Started

Chats

AI Models

AI Agents

AI Tools

Files & Memory

Integrations

Legal AI

Model Context Protocol

Collaboration

Evaluation System

Micro-Agent Patterns

Organization Management

Enterprise

Account Settings

Tokens & Billing

Limits & Quotas

Security & Privacy

Videos

Support

Legal

API Reference

mixus API documentation

Overview

Authentication

Getting your API key

API endpoints

Evaluation API

Create eval task

Get execution status

Permissions & scopes

Rate limits

Best practices

Security

Example: Secure storage

Next steps

Support

​Overview

​Authentication

​Getting your API key

​API endpoints

​Evaluation API

​Create eval task

​Get execution status

​Permissions & scopes

​Rate limits

​Best practices

​Security

​Example: Secure storage

​Next steps

​Support

Overview

Authentication

Getting your API key

API endpoints

Evaluation API

Create eval task

Get execution status

Permissions & scopes

Rate limits

Best practices

Security

Example: Secure storage

Next steps

Support