Base URL
Authentication
OSS version: No authentication required. Cloud version: API keys (coming soon).Endpoints
Response Format
All responses are JSON:Quick Examples
Deploy:Deploy API
Deploy endpoint details →
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Orpheus REST API reference
http://localhost:7777
http://YOUR_SERVER_IP:7777
| Method | Endpoint | Description |
|---|---|---|
POST | /v1/deploy | Deploy an agent |
POST | /v1/agents/{name}/run | Execute an agent |
GET | /v1/agents | List agents |
GET | /v1/agents/{name}/stats | Get agent stats |
GET | /v1/execlog | Query execution history (?source=http|mcp) |
GET | /metrics | Prometheus metrics |
DELETE | /v1/agents/{name} | Undeploy agent |
{
"data": { ... },
"error": null
}
{
"data": null,
"error": "Error message"
}
curl -X POST http://localhost:7777/v1/deploy \
-H "Content-Type: application/octet-stream" \
--data-binary @agent.tar.gz
curl -X POST http://localhost:7777/v1/agents/my-agent/run \
-H "Content-Type: application/json" \
-d '{"input": {"query": "hello"}}'
