Create Agent Run

curl --request POST \
  --url https://api.example.com/agents/{agent_id}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'message=<string>' \
  --form stream=true \
  --form 'session_id=<string>' \
  --form 'user_id=<string>' \
  --form 'files=<string>' \
  --form 'version=<string>' \
  --form background=false \
  --form 'factory_input=<string>'

import requests

url = "https://api.example.com/agents/{agent_id}/runs"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"stream\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"factory_input\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "multipart/form-data"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const form = new FormData();
form.append('message', '<string>');
form.append('stream', 'true');
form.append('session_id', '<string>');
form.append('user_id', '<string>');
form.append('files', '<string>');
form.append('version', '<string>');
form.append('background', 'false');
form.append('factory_input', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.example.com/agents/{agent_id}/runs', 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/agents/{agent_id}/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"stream\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"factory_input\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/agents/{agent_id}/runs"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"stream\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"factory_input\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	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/agents/{agent_id}/runs")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"stream\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"factory_input\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/{agent_id}/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"stream\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"factory_input\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "run_id": "<string>",
  "parent_run_id": "<string>",
  "agent_id": "<string>",
  "user_id": "<string>",
  "status": "<string>",
  "run_input": "<string>",
  "content": "<string>",
  "run_response_format": "<string>",
  "reasoning_content": "<string>",
  "reasoning_steps": [
    {}
  ],
  "metrics": {},
  "messages": [
    {}
  ],
  "tools": [
    {}
  ],
  "events": [
    {}
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "references": [
    {}
  ],
  "citations": {},
  "reasoning_messages": [
    {}
  ],
  "session_state": {},
  "images": [
    {}
  ],
  "videos": [
    {}
  ],
  "audio": [
    {}
  ],
  "files": [
    {}
  ],
  "response_audio": {},
  "input_media": {},
  "followups": [
    "<string>"
  ],
  "forked_from_run_id": "<string>",
  "forked_from_message_index": 123,
  "forked_from_session_id": "<string>",
  "regenerated_from": "<string>",
  "last_checkpoint_at_message_index": 123
}

{
  "run_id": "<string>",
  "session_id": "<string>",
  "status": "<string>"
}

{
  "detail": "Bad request",
  "error_code": "BAD_REQUEST"
}

{
  "detail": "Unauthenticated access",
  "error_code": "UNAUTHENTICATED"
}

{
  "detail": "Insufficient permissions"
}

{
  "detail": "Not found",
  "error_code": "NOT_FOUND"
}

{
  "detail": "Validation error",
  "error_code": "VALIDATION_ERROR"
}

{
  "detail": "Internal server error",
  "error_code": "INTERNAL_SERVER_ERROR"
}

Agents

Create Agent Run

Execute an agent with a message and optional media files. Supports both streaming and non-streaming responses.

Features:

Text message input with optional session management
Multi-media support: images (PNG, JPEG, WebP), audio (WAV, MP3), video (MP4, WebM, etc.)
Document processing: PDF, CSV, DOCX, TXT, JSON
Real-time streaming responses with Server-Sent Events (SSE)
User and session context preservation

Streaming Response: When stream=true, returns SSE events with event and data fields.

POST

agents

{agent_id}

runs

Create Agent Run

curl --request POST \
  --url https://api.example.com/agents/{agent_id}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'message=<string>' \
  --form stream=true \
  --form 'session_id=<string>' \
  --form 'user_id=<string>' \
  --form 'files=<string>' \
  --form 'version=<string>' \
  --form background=false \
  --form 'factory_input=<string>'

import requests

url = "https://api.example.com/agents/{agent_id}/runs"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"stream\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"factory_input\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "multipart/form-data"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const form = new FormData();
form.append('message', '<string>');
form.append('stream', 'true');
form.append('session_id', '<string>');
form.append('user_id', '<string>');
form.append('files', '<string>');
form.append('version', '<string>');
form.append('background', 'false');
form.append('factory_input', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.example.com/agents/{agent_id}/runs', 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/agents/{agent_id}/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"stream\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"factory_input\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/agents/{agent_id}/runs"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"stream\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"factory_input\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	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/agents/{agent_id}/runs")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"stream\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"factory_input\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/{agent_id}/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"stream\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"session_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"factory_input\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "run_id": "<string>",
  "parent_run_id": "<string>",
  "agent_id": "<string>",
  "user_id": "<string>",
  "status": "<string>",
  "run_input": "<string>",
  "content": "<string>",
  "run_response_format": "<string>",
  "reasoning_content": "<string>",
  "reasoning_steps": [
    {}
  ],
  "metrics": {},
  "messages": [
    {}
  ],
  "tools": [
    {}
  ],
  "events": [
    {}
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "references": [
    {}
  ],
  "citations": {},
  "reasoning_messages": [
    {}
  ],
  "session_state": {},
  "images": [
    {}
  ],
  "videos": [
    {}
  ],
  "audio": [
    {}
  ],
  "files": [
    {}
  ],
  "response_audio": {},
  "input_media": {},
  "followups": [
    "<string>"
  ],
  "forked_from_run_id": "<string>",
  "forked_from_message_index": 123,
  "forked_from_session_id": "<string>",
  "regenerated_from": "<string>",
  "last_checkpoint_at_message_index": 123
}

{
  "run_id": "<string>",
  "session_id": "<string>",
  "status": "<string>"
}

{
  "detail": "Bad request",
  "error_code": "BAD_REQUEST"
}

{
  "detail": "Unauthenticated access",
  "error_code": "UNAUTHENTICATED"
}

{
  "detail": "Insufficient permissions"
}

{
  "detail": "Not found",
  "error_code": "NOT_FOUND"
}

{
  "detail": "Validation error",
  "error_code": "VALIDATION_ERROR"
}

{
  "detail": "Internal server error",
  "error_code": "INTERNAL_SERVER_ERROR"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id

string

required

Body

multipart/form-data

message

string

required

The input message or prompt to send to the agent

stream

boolean

default:true

Enable streaming responses via Server-Sent Events (SSE)

session_id

string | null

Session ID for conversation continuity. If not provided, a new session is created

user_id

string | null

User identifier for tracking and personalization

files

string[] | null

Files to upload (images, audio, video, or documents)

version

string | null

Agent version to use for this run

background

boolean

default:false

Run in background and return immediately with run metadata (requires database)

factory_input

string | null

JSON object with factory-specific parameters for dynamic agent construction

Response

Agent run executed successfully

run_id

string

required

Unique identifier for the run

parent_run_id

string | null

Parent run ID if this is a nested run

agent_id

string | null

Agent ID that executed this run

user_id

string | null

User ID associated with the run

status

string | null

Run status (PENDING, RUNNING, COMPLETED, ERROR, etc.)

run_input

string | null

Input provided to the run

content

Output content from the run

run_response_format

string | null

Format of the response (text/json)

reasoning_content

string | null

Reasoning content if reasoning was enabled

reasoning_steps

Reasoning Steps · object[] | null

List of reasoning steps

metrics

Metrics · object | null

Performance and usage metrics

messages

Messages · object[] | null

Message history for the run

tools

Tools · object[] | null

Tools used in the run

events

Events · object[] | null

Events generated during the run

created_at

string<date-time> | null

Run creation timestamp

references

References · object[] | null

References cited in the run

citations

Citations · object | null

Citations from the model (e.g., from Gemini grounding/search)

reasoning_messages

Reasoning Messages · object[] | null

Reasoning process messages

session_state

Session State · object | null

Session state at the end of the run

images

Images · object[] | null

Images included in the run

videos

Videos · object[] | null

Videos included in the run

audio

Audio · object[] | null

Audio files included in the run

files

Files · object[] | null

Files included in the run

response_audio

Response Audio · object | null

Audio response if generated

input_media

Input Media · object | null

Input media attachments

followups

string[] | null

Followup suggestions generated after the run

forked_from_run_id

string | null

If this run was forked from another run, the source run's ID

forked_from_message_index

integer | null

If this run was forked, the message index at which the source was truncated

forked_from_session_id

string | null

If this run was created via session branch, the source session's ID

regenerated_from

string | null

If this run was produced via regenerate=true, the source run's ID

last_checkpoint_at_message_index

integer | null

Message index of the most recent mid-run checkpoint (checkpoint='tool-batch' runs)

List Agent Runs Cancel Agent Run

⌘I

Agno SDK Reference

AgentOS API Reference

Agno CLI

Agno Infra CLI

Create Agent Run

Authorizations

Path Parameters

Body

Response