API Overview
Base URL, authentication, error format, rate limits, and pagination for the AskVerdict REST API.
The AskVerdict API is a RESTful JSON API for creating and managing AI-powered debates.
Base URL
https://api.askverdict.aiAll endpoints are prefixed with /v1/.
Authentication
Every request requires an API key passed via the Authorization header:
Authorization: Bearer vrd_your_api_keySee Authentication for details on creating keys and BYOK setup.
Request Format
- All request bodies use
Content-Type: application/json - Query parameters use standard URL encoding
- Dates are ISO 8601 format
Response Format
All responses follow a consistent structure:
{
"debate": { ... },
"verdict": { ... }
}Error responses:
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Question is required"
}
}HTTP Status Codes
| Code | Meaning |
|---|---|
200 | Success |
201 | Created |
400 | Bad Request — invalid parameters |
401 | Unauthorized — missing or invalid API key |
403 | Forbidden — insufficient permissions or plan |
404 | Not Found — resource doesn't exist |
429 | Too Many Requests — rate limit exceeded |
500 | Internal Server Error |
Rate Limits
Default rate limit is 60 requests per minute per API key. Headers included in every response:
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57
X-RateLimit-Reset: 1708444800Pagination
List endpoints support pagination via query parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
page | number | 1 | Page number |
limit | number | 20 | Items per page (max 100) |
Response includes pagination metadata:
{
"debates": [...],
"pagination": {
"page": 1,
"limit": 20,
"total": 47,
"totalPages": 3
}
}Endpoints
/v1/verdictsCreate a new debate and get a verdict
/v1/verdictsList your debates with pagination and filtering
/v1/verdicts/:idGet a specific debate with its verdict
/v1/verdicts/:id/streamStream debate events via SSE
/v1/verdicts/:idDelete a debate
/v1/meGet authenticated user profile
/v1/usageGet API key usage statistics
Next Steps
- Create a Verdict — Full POST /v1/verdicts reference
- Stream Events — Real-time SSE streaming
- API User Profile — Verify API key identity and plan context
- API Key Usage — Track per-key request volume and endpoint usage
- Health Checks — Public and service-level readiness endpoints
- Attachments — File and URL context for debates
- Sharing — Share links and public token access
- Error Codes — Comprehensive error reference
Was this page helpful?