API Reference

Complete API documentation for Arcada Gateway. All endpoints use standard Router format compatible with OpenAI SDK and other standard SDKs.

Base URL

https://api.arcada.dev

Authentication

All API requests require authentication using your API key. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Health Check

Verify API connectivity and authentication status.

GET/api/v1/health

Response

{
  "status": "healthy",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "version": "1.0.0"
}

Content Generation

Generate content using universal Router format API. Automatically selects the top-ranked model from DesignArena's leaderboard for your format. Compatible with standard SDKs for easy integration.

POST/api/v1/generate

Request Body

Required fields: messages, input_format, output_format

{
  "input_format": "text",
  "output_format": "website",
  "messages": [
    {
      "role": "user",
      "content": "Create a landing page for a coffee shop"
    }
  ]
}

Note: The model field is not used. Arcada automatically selects the top-performing model from DesignArena's leaderboard based on your input_format and output_format.

Response

Standard Router format response compatible with OpenAI SDK and other standard SDKs.

{
  "id": "chatcmpl-abc123...",
  "object": "chat.completion",
  "created": 1234567890,
  "model": "GPT-4 Turbo",
  "choices": [{
    "index": 0,
    "message": {
      "role": "assistant",
      "content": "Generated content here..."
    },
    "finish_reason": "stop"
  }],
  "usage": {
    "prompt_tokens": 150,
    "completion_tokens": 200,
    "total_tokens": 350
  }
}

Rate Limits

The following rate limits apply to all API requests:

  • 300 requests per minute
  • 10,000 requests per hour
  • 100,000 requests per day

Try it out

Example

curl https://api.arcada.dev/api/v1/health \
  -H "Authorization: Bearer YOUR_API_KEY"