API Documentation
Integrate Deployara into your applications with our REST API
Base URL
All API requests should be made to:
https://api.deployara.dev/api/v1Authentication
Bearer Token
Include your JWT token in the Authorization header
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...WebSocket Connection
Connect to real-time chat using WebSocket with token
wss://api.deployara.dev/api/v1/instances/{id}/ws?token=YOUR_TOKENWebhooks
Configure webhooks to receive real-time events from external services. Each instance has a unique webhook URL:
https://api.deployara.dev/api/v1/webhooks/incoming/YOUR_INSTANCE_IDEndpoints
GET
/api/v1/instances🔒 Auth requiredList all instances for the authenticated user
Example:
curl -H "Authorization: Bearer YOUR_TOKEN" \ https://api.deployara.dev/api/v1/instances
POST
/api/v1/instances🔒 Auth requiredCreate a new instance
Request Body:
{
"name": "My Assistant",
"model": "openai/gpt-4o-mini",
"plan": "starter"
}Example:
curl -X POST \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"My Assistant","model":"openai/gpt-4o-mini"}' \
https://api.deployara.dev/api/v1/instancesGET
/api/v1/instances/{id}🔒 Auth requiredGet details of a specific instance
Example:
curl -H "Authorization: Bearer YOUR_TOKEN" \ https://api.deployara.dev/api/v1/instances/abc123
DELETE
/api/v1/instances/{id}🔒 Auth requiredDelete an instance
Example:
curl -X DELETE \ -H "Authorization: Bearer YOUR_TOKEN" \ https://api.deployara.dev/api/v1/instances/abc123
POST
/api/v1/instances/{id}/chat🔒 Auth requiredSend a message to an instance (WebSocket preferred)
Request Body:
{
"message": "Hello, how can you help me?"
}Example:
curl -X POST \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"message":"Hello!"}' \
https://api.deployara.dev/api/v1/instances/abc123/chatGET
/api/v1/instances/{id}/logs🔒 Auth requiredGet instance logs
Example:
curl -H "Authorization: Bearer YOUR_TOKEN" \ https://api.deployara.dev/api/v1/instances/abc123/logs
POST
/api/v1/webhooks/incoming/{instance_id}Incoming webhook for external integrations
Request Body:
{
"event": "github.push",
"payload": { ... }
}Example:
curl -X POST \
-H "Content-Type: application/json" \
-d '{"event":"github.push","payload":{...}}' \
https://api.deployara.dev/api/v1/webhooks/incoming/abc123Rate Limits
| Plan | Requests/min | WebSocket |
|---|---|---|
| Hobby | 60 | 1 connection |
| Starter | 300 | 3 connections |
| Pro | 1,000 | 10 connections |
| Team | 5,000 | Unlimited |