Upload an agent's avatar
curl --request PUT \
--url https://api.onecli.sh/v1/agents/{agentId}/image \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: image/*' \
--data '<string>'import requests
url = "https://api.onecli.sh/v1/agents/{agentId}/image"
payload = "<string>"
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "image/*"
}
response = requests.put(url, data=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'image/*'},
body: '<string>'
};
fetch('https://api.onecli.sh/v1/agents/{agentId}/image', 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}/image",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "<string>",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: image/*"
],
]);
$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}/image"
payload := strings.NewReader("<string>")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "image/*")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.onecli.sh/v1/agents/{agentId}/image")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "image/*")
.body("<string>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onecli.sh/v1/agents/{agentId}/image")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'image/*'
request.body = "<string>"
response = http.request(request)
puts response.read_body{
"imageUrl": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Agents
Upload an avatar image for an agent
Uploads raw PNG, JPEG, GIF, or WebP bytes as an agent avatar, up to 1 MB. SVG files are refused, and every upload rotates the public URL of the image.
PUT
/
agents
/
{agentId}
/
image
Upload an agent's avatar
curl --request PUT \
--url https://api.onecli.sh/v1/agents/{agentId}/image \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: image/*' \
--data '<string>'import requests
url = "https://api.onecli.sh/v1/agents/{agentId}/image"
payload = "<string>"
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "image/*"
}
response = requests.put(url, data=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'image/*'},
body: '<string>'
};
fetch('https://api.onecli.sh/v1/agents/{agentId}/image', 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}/image",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "<string>",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: image/*"
],
]);
$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}/image"
payload := strings.NewReader("<string>")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "image/*")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.onecli.sh/v1/agents/{agentId}/image")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "image/*")
.body("<string>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onecli.sh/v1/agents/{agentId}/image")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'image/*'
request.body = "<string>"
response = http.request(request)
puts response.read_body{
"imageUrl": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Sets the image shown for the agent. The format is detected from the bytes, not the header. See Agent access for managing agents in a workspace.
Raw image bytes in the body (PNG, JPEG, GIF, or WebP; SVG is refused). The format is detected from the bytes, not the header. Capped at 1 MB. Each upload rotates the public URL.
Availability: Cloud · Community (self-hosted) · Enterprise (self-hosted)
Authorizations
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
Body
image/*
The body is of type file.
Response
The new public avatar URL