Skip to main content
POST
/
v1
/
agents
Create or upsert an agent (by slug)
curl --request POST \
  --url https://api.runtools.ai/v1/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "color": "<string>",
  "avatarSeed": "<string>",
  "model": "claude-sonnet-4",
  "tier": "platform",
  "systemPrompt": "<string>",
  "tools": [
    "<string>"
  ],
  "sandbox": "<string>",
  "maxIterations": 123,
  "maxTokens": 123,
  "temperature": 123,
  "topP": 123,
  "topK": 123,
  "presencePenalty": 123,
  "frequencyPenalty": 123,
  "seed": 123,
  "stopSequences": [
    "<string>"
  ],
  "toolChoice": "auto",
  "providerOptions": {},
  "env": {},
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "executionMode": "in_sandbox",
  "targetDeviceId": "<string>",
  "defaultFolderHint": "<string>",
  "resources": [
    {
      "type": "workspace",
      "resourceId": "<string>",
      "alias": "<string>",
      "config": {}
    }
  ]
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "name": "<string>",
    "description": "<string>",
    "color": "<string>",
    "avatarSeed": "<string>",
    "avatarImageUrl": "<string>",
    "model": "claude-sonnet-4",
    "executionMode": "in_sandbox",
    "visibility": "private",
    "systemPrompt": "<string>",
    "toolsJson": [
      "<string>"
    ],
    "sandboxId": "<string>",
    "sandboxSlug": "<string>",
    "targetDeviceId": "<string>",
    "status": "draft",
    "configJson": {},
    "providerOptions": {},
    "envJson": {},
    "attachedResources": [
      {
        "type": "workspace",
        "resourceId": "<string>",
        "alias": "<string>",
        "config": {}
      }
    ],
    "version": 123,
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ownerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ownerDisplayName": "<string>",
    "ownerEmail": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.runtools.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

WorkOS session token or RunTools API key (rt_live_* / rt_test_*). Used in Authorization: Bearer <token> header.

Body

application/json
​
slug
string
required
Pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$
​
name
string
​
description
string
​
color
string
​
avatarSeed
string
​
model
string
default:claude-sonnet-4
​
tier
enum<string>
Available options:
platform,
byok
​
systemPrompt
string
​
tools
(string | object)[]

Tool slug (e.g. exec_command, apply_patch).

​
sandbox
string

Sandbox name, ID, or rt-config tag.

​
maxIterations
integer
​
maxTokens
integer
​
temperature
number
​
topP
number
​
topK
integer
​
presencePenalty
number
​
frequencyPenalty
number
​
seed
integer
​
stopSequences
string[]
​
toolChoice
Available options:
auto,
none,
required
​
providerOptions
object
​
env
object
​
projectId
string<uuid> | null
​
executionMode
enum<string>
Available options:
in_sandbox,
managed,
local-mac
​
targetDeviceId
string | null
​
defaultFolderHint
string | null
​
resources
object[]

Response

Updated.

​
data
object