Skip to main content

Quick start - mixus API

Get started in 5 minutes

Step 1: Generate API key (2 minutes)

  1. Sign in to app.mixus.ai
  2. Navigate to Integrations → API Keys
  3. Click “Generate API Key”
  4. Configure your key:
    • Name: “My First API Key”
    • Permissions: ✓ eval:create, ✓ eval:read
    • Expiration: 30 days
  5. Click “Generate API Key”
  6. Copy the key immediately (shown only once!)
Your key will look like: mxs_eval_A7k2mN9pQx4vZ8wB3cF1dG6hJ5lK0sM

Step 2: Make your first API call (1 minute)

export MIXUS_API_KEY="mxs_eval_YOUR_KEY_HERE"

curl -X POST https://app.mixus.ai/api/eval/create-task-agent \
  -H "Authorization: Bearer $MIXUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "taskName": "Quick Test",
    "taskDescription": "Calculate 15% of $50,000 and explain the result",
    "checkpoints": [{
      "stage": "calculation",
      "description": "Perform calculation",
      "verificationQuestion": "Is the result $7,500?"
    }],
    "testMode": "with-verification",
    "assignedReviewer": "your-email@example.com"
  }'
Response:
{
  "success": true,
  "executionId": "670a1b2c3d4e5f6g7h8i9j0k",
  "chatUrl": "https://app.mixus.ai/chat/670a1b2c3d4e5f6g7h8i9j0l"
}

Step 3: Track progress (2 minutes)

# Save the execution ID from previous response
EXEC_ID="670a1b2c3d4e5f6g7h8i9j0k"

# Check status
curl "https://app.mixus.ai/api/eval/status/$EXEC_ID" \
  -H "Authorization: Bearer $MIXUS_API_KEY"
Or open the chat URL in your browser to watch in real-time!

What just happened?

  1. ✅ You created an evaluation task via API
  2. ✅ mixus agent started working on it
  3. ✅ Agent will pause at the checkpoint for your verification
  4. ✅ You can approve/reject via email or web UI
  5. ✅ Agent continues and completes the task
  6. ✅ You get metrics on performance

Next steps

Try AI auto-detection

Let AI decide where to add verification points:
curl -X POST https://app.mixus.ai/api/eval/create-task-agent \
  -H "Authorization: Bearer $MIXUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "taskName": "AI Auto-Detect Test",
    "taskDescription": "Research top 3 AI companies, analyze their pricing, and email summary to team@company.com",
    "autoDetectCheckpoints": true,
    "testMode": "with-verification",
    "assignedReviewer": "your-email@example.com"
  }'
The AI will automatically add verification before sending the email!

Explore more


Common questions

Q: How long does an eval take?
A: Typically 30 seconds to 5 minutes, depending on task complexity.
Q: Can I run multiple evals at once?
A: Yes! Up to 10 concurrent executions per API key.
Q: What if I lose my API key?
A: Generate a new one and revoke the old one immediately.
Q: Can I skip human verification?
A: Yes, use testMode: "without-verification" for fully automated runs.
Q: How do I get notified when complete?
A: Add a webhookUrl to receive completion notifications.

That’s it! You’re now ready to use the mixus API 🚀 Start building with complete documentation or explore code examples.
I