Documentation
Learn how to integrate and use ORBX API in your applications
Quick Start
Get started with ORBX API by using your static bearer token to authenticate your requests.
Your Bearer Token:
ORBX_static_token_dhj2834hjkad2Authentication
All API requests require authentication using a Bearer token in the Authorization header.
Authorization: Bearer ORBX_static_token_dhj2834hjkad2API Endpoints
POST
/api/workflows/executeExecute a workflow with input data
Request Example:
curl -X POST https://api.orbxagents.com/v1/workflows/execute \
-H "Authorization: Bearer ORBX_static_token_dhj2834hjkad2" \
-H "Content-Type: application/json" \
-d '{
"workflowId": "wf_abc123",
"input": {
"text": "Hello, ORBX!"
}
}'Response:
{
"success": true,
"workflowId": "wf_abc123",
"executionId": "exec_xyz789",
"output": {
"result": "Processed: Hello, ORBX!"
},
"timestamp": "2025-01-15T10:30:00Z"
}GET
/api/workflows/:id/statusGet the status of a workflow execution
Request Example:
curl -X GET https://api.orbxagents.com/v1/workflows/exec_xyz789/status \
-H "Authorization: Bearer ORBX_static_token_dhj2834hjkad2"Response:
{
"executionId": "exec_xyz789",
"status": "completed",
"progress": 100,
"startedAt": "2025-01-15T10:30:00Z",
"completedAt": "2025-01-15T10:30:05Z"
}GET
/api/workflowsList all available workflows
Request Example:
curl -X GET https://api.orbxagents.com/v1/workflows \
-H "Authorization: Bearer ORBX_static_token_dhj2834hjkad2"Response:
{
"workflows": [
{
"id": "wf_abc123",
"name": "Text Processing Workflow",
"description": "Process and analyze text input",
"createdAt": "2025-01-10T08:00:00Z"
},
{
"id": "wf_def456",
"name": "Image Generation Workflow",
"description": "Generate images from text prompts",
"createdAt": "2025-01-12T14:30:00Z"
}
]
}Error Handling
All errors follow a consistent format:
{
"error": {
"code": "invalid_request",
"message": "Missing required parameter: workflowId",
"details": {}
}
}Common Error Codes:
401- Unauthorized: Invalid or missing bearer token404- Not Found: Workflow or execution not found429- Rate Limit Exceeded: Too many requests500- Internal Server Error: Something went wrong on our end
Rate Limits
API rate limits are enforced per bearer token:
- Free Tier: 100 requests per hour
- Pro Tier: 1,000 requests per hour
- Enterprise: Custom limits
Rate limit headers are included in every response to help you track usage.
SDKs & Libraries
JavaScript/TypeScript
SOONOfficial SDK for Node.js and browser environments
npm install @orbx/sdkPython
SOONOfficial Python client library
pip install orbx