Update an agent's name, brief, or model

Update an agent

curl --request PATCH \
  --url https://api.onecli.sh/v1/agents/{agentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "instructions": "<string>",
  "model": "<string>",
  "effort": "<string>"
}
'

import requests

url = "https://api.onecli.sh/v1/agents/{agentId}"

payload = {
    "name": "<string>",
    "instructions": "<string>",
    "model": "<string>",
    "effort": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    instructions: '<string>',
    model: '<string>',
    effort: '<string>'
  })
};

fetch('https://api.onecli.sh/v1/agents/{agentId}', 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.onecli.sh/v1/agents/{agentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'instructions' => '<string>',
    'model' => '<string>',
    'effort' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.onecli.sh/v1/agents/{agentId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"model\": \"<string>\",\n  \"effort\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.onecli.sh/v1/agents/{agentId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"model\": \"<string>\",\n  \"effort\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/agents/{agentId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"model\": \"<string>\",\n  \"effort\": \"<string>\"\n}"

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

{
  "success": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

PATCH

agents

{agentId}

Update an agent

curl --request PATCH \
  --url https://api.onecli.sh/v1/agents/{agentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "instructions": "<string>",
  "model": "<string>",
  "effort": "<string>"
}
'

import requests

url = "https://api.onecli.sh/v1/agents/{agentId}"

payload = {
    "name": "<string>",
    "instructions": "<string>",
    "model": "<string>",
    "effort": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    instructions: '<string>',
    model: '<string>',
    effort: '<string>'
  })
};

fetch('https://api.onecli.sh/v1/agents/{agentId}', 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.onecli.sh/v1/agents/{agentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'instructions' => '<string>',
    'model' => '<string>',
    'effort' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.onecli.sh/v1/agents/{agentId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"model\": \"<string>\",\n  \"effort\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.onecli.sh/v1/agents/{agentId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"model\": \"<string>\",\n  \"effort\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/agents/{agentId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"model\": \"<string>\",\n  \"effort\": \"<string>\"\n}"

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

{
  "success": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Updates an agent’s editable fields. Changing a hosted agent’s model restarts its sandbox. See Coding agents for how agents use the gateway. Rename the agent, or (hosted agents) change its brief and model override. At least one field is required. null clears instructions, model, or effort. kind and harness are immutable. Changing the model restarts the hosted agent’s sandbox.

Availability: Cloud · Community (self-hosted) · Enterprise (self-hosted)

Authorizations

Authorization

string

header

required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

agentId

string

required

Body

application/json

name

string

Required string length: 1 - 255

instructions

string | null

Maximum string length: 20000

model

string | null

A model id from GET /agents/{agentId}/models.

Maximum string length: 200

effort

string | null

A reasoning-effort id from GET /agents/{agentId}/models.

Response

Updated

success

boolean

Workspace

Organization

Enterprise

Platform

Update an agent's name, brief, or model

Authorizations

Path Parameters

Body

Response