Skip to main content

Base URL

All API requests should be made to:
https://api.nvrse.dev/api/interactive

Authentication

All endpoints require API key authentication. Include your key in the request headers:
X-API-Key: your_api_key_here
See Authentication for more details.

Response Format

All responses are JSON unless otherwise specified (e.g., streaming endpoints, audio).

Success Response

{
  "data": { ... }
}

Error Response

{
  "error": "Error message",
  "code": "ERROR_CODE",
  "correlationId": "uuid-for-debugging"
}

Common Error Codes

CodeHTTP StatusDescription
UNAUTHORIZED401Missing or invalid API key
FORBIDDEN403No permission for this resource
NOT_FOUND404Resource doesn’t exist
VALIDATION_ERROR400Invalid request parameters
INTERNAL_ERROR500Server error

Endpoint Groups

Pagination

List endpoints support pagination via query parameters:
ParameterTypeDefaultDescription
limitinteger20Max items to return (1-100)
offsetinteger0Number of items to skip
Example:
GET /api/interactive/runs/me?limit=10&offset=20