Run Agent
curl --request POST \
--url https://api.example.com/v1/agents/{name}/runimport requests
url = "https://api.example.com/v1/agents/{name}/run"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/v1/agents/{name}/run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/agents/{name}/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/agents/{name}/run"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/agents/{name}/run")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/agents/{name}/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyReference
Run Agent
Execute an agent
POST
/
v1
/
agents
/
{name}
/
run
Run Agent
curl --request POST \
--url https://api.example.com/v1/agents/{name}/runimport requests
url = "https://api.example.com/v1/agents/{name}/run"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/v1/agents/{name}/run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/agents/{name}/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/agents/{name}/run"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/agents/{name}/run")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/agents/{name}/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyRequest
POST /v1/agents/{name}/run
Content-Type: application/json
{
"input": {
"query": "Your input here"
}
}
Headers
| Header | Description |
|---|---|
Content-Type | application/json |
X-Session-ID | Optional. Route to same worker |
Accept | text/event-stream for SSE streaming |
cURL Example
curl -X POST http://localhost:7777/v1/agents/my-agent/run \
-H "Content-Type: application/json" \
-d '{"input": {"query": "hello"}}'
curl -X POST http://localhost:7777/v1/agents/my-agent/run \
-H "Content-Type: application/json" \
-H "X-Session-ID: user-123" \
-d '{"input": {"query": "hello"}}'
Response
Success (200):{
"request_id": "abc-123-def",
"result": {
"response": "Hello!",
"status": "success"
},
"duration_ms": 45,
"worker_id": "my-agent-worker-1"
}
{
"request_id": "abc-123-def",
"error": "Handler raised exception",
"duration_ms": 12
}
CLI Equivalent
orpheus run my-agent '{"query": "hello"}'
# With session
orpheus run my-agent '{"query": "hello"}' --session user-123
Next: ExecLog API
Query execution history →
⌘I

