> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://ref.scoutos.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://ref.scoutos.com/_mcp/server.

# Create or update an agent.

POST https://api.scoutos.com/agents
Content-Type: multipart/form-data

Reference: https://ref.scoutos.com/api-sdk/endpoints/agents/upsert

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (multipart/form-data)

This endpoint expects a multipart form containing an optional file.

- `agent` (string, required)
- `agent_id` (string, optional)
- `activate` (boolean, optional)
- `revision` (string, required)
- `agent_image` (file, optional)

## Response

### 200

Successful Response

- `agent` (Agent, required)
- `revision` (AgentRevision-Output, required, nullable)

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### Agent

- `created_by` (ActorIdentity, required)
- `updated_by` (ActorIdentity, required)
- `name` (string, required)
- `parent` (string, required)
- `visibility` (ActorIdentity, required)
- `id` (string, optional)
- `doc_type` ("agent", optional)
- `created_at` (datetime, optional)
- `updated_at` (datetime, optional)
- `is_seed` (boolean, optional, nullable)
- `description` (string, optional, nullable)
- `profile_icon_fill` (string, optional, nullable)
- `profile_asset_url` (string, optional, nullable)
- `active_revision` (string, optional, nullable)
- `from_persona` (string, optional, nullable)

### AgentRevision-Output

- `created_by` (ActorIdentity, required)
- `updated_by` (ActorIdentity, required)
- `parent` (string, required)
- `organization_id` (string, required)
- `model` (AgentRevisionOutputModel, required)
- `system` (string, required)
- `id` (string, optional)
- `doc_type` ("agent_revision", optional)
- `created_at` (datetime, optional)
- `updated_at` (datetime, optional)
- `is_seed` (boolean, optional, nullable)
- `model_provider` (enum, optional, nullable)
  - Allowed values: `open_ai`, `anthropic`, `google`
- `temperature` (double, optional, nullable)
- `response_style` (enum, optional, nullable)
  - Allowed values: `precise`, `balanced`, `creative`, `experimental`, `json`
- `max_tokens` (integer, optional, nullable)
- `max_turns` (integer, optional, nullable)
- `tool_config` (map from string to AgentRevisionOutputToolConfig, optional, nullable)
- `conversation_starters` (list of string, optional, nullable)
- `dynamic_fallbacks` (list of AgenticModel, optional, nullable)

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### ActorIdentity

- `type` (ActorIdentityType, required)
- `id` (ActorIdentityId, required)

### AgentRevisionOutputModel

- "_dynamic"
- string

### AgentRevisionOutputToolConfig

- boolean
- AgentRevisionOutputToolConfig1: list of ToolConfigResource

### AgenticModel

- `model` (string, required)
- `model_provider` (enum, required)
  - Allowed values: `open_ai`, `anthropic`, `google`

### ValidationErrorLocItems

- string
- integer

### ActorIdentityType

- "organization"
- "user"
- "agent"
- "system"

### ActorIdentityId

- string
- "system"

### ToolConfigResource

- `type` (enum, required)
  - Allowed values: `tables`, `workflow`, `crawl`, `file`, `integration`, `directory`
- `resource_id` (string, required)

## Examples

**Request**

```json
{
  "agent": "{\"name\":\"SupportBot\",\"description\":\"Customer support assistant\",\"language\":\"en-US\"}",
  "revision": "rev-20240601",
  "agent_image": "<file: supportbot_avatar.png>"
}
```

**Response**

```json
{
  "agent": {
    "created_by": {
      "type": "organization",
      "id": "org-67890"
    },
    "updated_by": {
      "type": "organization",
      "id": "org-67890"
    },
    "name": "SupportBot",
    "parent": "root-agent",
    "visibility": {
      "type": "organization",
      "id": "org-67890"
    },
    "id": "agent-12345",
    "doc_type": "agent",
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "is_seed": true,
    "description": "Customer support assistant",
    "profile_icon_fill": "#4A90E2",
    "profile_asset_url": "https://cdn.example.com/assets/supportbot_avatar.png",
    "active_revision": "rev-20240601",
    "from_persona": "customer_service"
  },
  "revision": {
    "created_by": {
      "type": "organization",
      "id": "org-67890"
    },
    "updated_by": {
      "type": "organization",
      "id": "org-67890"
    },
    "parent": "agent-12345",
    "organization_id": "org-67890",
    "model": "gpt-4",
    "system": "You are a helpful customer support assistant.",
    "id": "rev-20240601",
    "doc_type": "agent_revision",
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "is_seed": true,
    "model_provider": "open_ai",
    "temperature": 0.7,
    "response_style": "precise",
    "max_tokens": 150,
    "max_turns": 10,
    "tool_config": {},
    "conversation_starters": [
      "Hello! How can I assist you today?"
    ],
    "dynamic_fallbacks": [
      {
        "model": "gpt-3.5-turbo",
        "model_provider": "open_ai"
      }
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.scoutos.com/agents"

files = { "agent_image": "open('supportbot_avatar.png', 'rb')" }
payload = {
    "agent": "{\"name\":\"SupportBot\",\"description\":\"Customer support assistant\",\"language\":\"en-US\"}",
    "agent_id": ,
    "activate": ,
    "revision": "rev-20240601"
}
headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```typescript
import { createReadStream } from "fs";
import { ScoutClient } from "scoutos";

const client = new ScoutClient({ apiKey: "YOUR_API_KEY" });
await client.agents.upsert({
    agent: "agent",
    revision: "revision"
});

```

```go
package main

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

func main() {

	url := "https://api.scoutos.com/agents"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agent\"\r\n\r\n{\"name\":\"SupportBot\",\"description\":\"Customer support assistant\",\"language\":\"en-US\"}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agent_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"activate\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"revision\"\r\n\r\nrev-20240601\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agent_image\"; filename=\"supportbot_avatar.png\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001--\r\n")

	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(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.scoutos.com/agents")

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=\"agent\"\r\n\r\n{\"name\":\"SupportBot\",\"description\":\"Customer support assistant\",\"language\":\"en-US\"}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agent_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"activate\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"revision\"\r\n\r\nrev-20240601\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agent_image\"; filename=\"supportbot_avatar.png\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001--\r\n"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.scoutos.com/agents")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agent\"\r\n\r\n{\"name\":\"SupportBot\",\"description\":\"Customer support assistant\",\"language\":\"en-US\"}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agent_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"activate\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"revision\"\r\n\r\nrev-20240601\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agent_image\"; filename=\"supportbot_avatar.png\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001--\r\n")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.scoutos.com/agents', [
  'multipart' => [
    [
        'name' => 'agent',
        'contents' => '{"name":"SupportBot","description":"Customer support assistant","language":"en-US"}'
    ],
    [
        'name' => 'revision',
        'contents' => 'rev-20240601'
    ],
    [
        'name' => 'agent_image',
        'filename' => 'supportbot_avatar.png',
        'contents' => null
    ]
  ]
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.scoutos.com/agents");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agent\"\r\n\r\n{\"name\":\"SupportBot\",\"description\":\"Customer support assistant\",\"language\":\"en-US\"}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agent_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"activate\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"revision\"\r\n\r\nrev-20240601\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agent_image\"; filename=\"supportbot_avatar.png\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]
let parameters = [
  [
    "name": "agent",
    "value": "{\"name\":\"SupportBot\",\"description\":\"Customer support assistant\",\"language\":\"en-US\"}"
  ],
  [
    "name": "agent_id",
    "value": 
  ],
  [
    "name": "activate",
    "value": 
  ],
  [
    "name": "revision",
    "value": "rev-20240601"
  ],
  [
    "name": "agent_image",
    "fileName": "supportbot_avatar.png"
  ]
]

let boundary = "---011000010111000001101001"

var body = ""
var error: NSError? = nil
for param in parameters {
  let paramName = param["name"]!
  body += "--\(boundary)\r\n"
  body += "Content-Disposition:form-data; name=\"\(paramName)\""
  if let filename = param["fileName"] {
    let contentType = param["content-type"]!
    let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
    if (error != nil) {
      print(error as Any)
    }
    body += "; filename=\"\(filename)\"\r\n"
    body += "Content-Type: \(contentType)\r\n\r\n"
    body += fileContent
  } else if let paramValue = param["value"] {
    body += "\r\n\r\n\(paramValue)"
  }
}

let request = NSMutableURLRequest(url: NSURL(string: "https://api.scoutos.com/agents")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```