API Reference

Complete reference for the Playgent API

Base URL

All API requests should be made to:

https://api.playgent.com/v1

Authentication

The Playgent API uses Bearer token authentication. Include your API key in the Authorization header:

Authorization: Bearer your-api-key

Get your API key from the dashboard.

Response Format

All responses are JSON. Successful responses include the requested data:

{
  "id": "agent_abc123",
  "name": "My Agent",
  "created_at": "2024-12-16T10:00:00Z"
}

Error responses include an error code and message:

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: name"
  }
}

Rate Limits

• Standard: 100 requests/minute
• Pro: 1000 requests/minute

Rate limit headers are included in all responses:

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

API Sections

Agents

Create and manage agent configurations

Test Cases

Define test scenarios for your agents

Test Runs

Execute tests and get results

Tracing

Instrument agent execution with spans

Evaluation

Run evaluations with 27 built-in metrics (RAG, safety, agentic, multi-turn)

Optimization

Optimize prompts and run A/B tests