Skip to main content

​
Base URL

https://api.vela.dev/v1
For local development: 
http://localhost:3000/v1

​
Authentication

The API uses two authentication methods:
MethodHeaderUsed for
Client secretAuthorization: Bearer vela_cs_...Management endpoints (apps, schemas, rules)
API keyx-api-key: vela_live_...Event ingestion
See Authentication for details.

​
Content type

All requests and responses use JSON: 
Content-Type: application/json

​
Error format

All errors return a consistent shape: 
{
  "statusCode": 400,
  "timestamp": "2024-06-01T12:00:00.000Z",
  "path": "/v1/apps",
  "error": "Bad Request",
  "message": "name must be a string"
}
StatusDescription
400Validation error — check your request body
401Unauthorized — missing or invalid credentials
403Forbidden — valid credentials but insufficient permissions
404Not found
429Rate limited — back off and retry
500Internal server error

​
Endpoints overview

GroupBase pathAuth
Apps/v1/appsClient secret
Schemas/v1/apps/:appId/schemasClient secret
Events/v1/ingestAPI key
Events (read)/v1/apps/:appId/eventsClient secret
Notification Rules/v1/apps/:appId/notification-rulesClient secret