Skip to main content
POST
/
v1
/
deploy
Deploy Agent
curl --request POST \
  --url https://api.example.com/v1/deploy

Request

POST /v1/deploy
Content-Type: application/octet-stream

[agent tarball]
The tarball should contain:
agent-name/
  agent.yaml
  agent.py (or index.js)
  requirements.txt (optional)

Create Tarball

cd my-agent
tar -czvf ../my-agent.tar.gz .

cURL Example

curl -X POST http://localhost:7777/v1/deploy \
  -H "Content-Type: application/octet-stream" \
  --data-binary @my-agent.tar.gz

Response

Success (200):
{
  "agent": "my-agent",
  "status": "deployed",
  "workers": 1
}
Error (400):
{
  "error": "agent.yaml not found"
}

CLI Equivalent

orpheus deploy ./my-agent
The CLI handles tarball creation automatically.

Next: Run API

Execute agents via API →