Execute agent | Runtype Documentation

Execute an agent (Quick Agent mode) with a message array. Streams a Server-Sent Events response when streamResponse is true (default); otherwise returns a JSON result.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects a map from strings to any.

Response

Server-Sent Events stream of agent execution events (or a JSON result when streamResponse is false)

object

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/agents/id/execute \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"messages": [
>	{
>	"content": "Help me with my order",
>	"role": "user"
>	}
>	],
>	"options": {
>	"streamResponse": true
>	}
>	}'

$	curl -X POST https://api.runtype.com/v1/agents/id/execute \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"messages": [
>	{
>	"content": "Help me with my order",
>	"role": "user"
>	}
>	],
>	"options": {
>	"streamResponse": true
>	}
>	}'