Get an agent and its hosted configuration

Get an agent

curl --request GET \
  --url https://api.onecli.sh/v1/agents/{agentId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "kind": "byo",
  "harness": "<string>",
  "model": "<string>",
  "instructions": "<string>",
  "imageUrl": "<string>",
  "channels": [
    {
      "provider": "slack",
      "identityName": "<string>",
      "externalId": "<string>",
      "status": "<string>",
      "settingsUrl": "<string>"
    }
  ],
  "recentRequestAt": "2023-11-07T05:31:56Z",
  "workingInBackground": true,
  "createdAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>"
}

GET

agents

{agentId}

Get an agent

curl --request GET \
  --url https://api.onecli.sh/v1/agents/{agentId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "kind": "byo",
  "harness": "<string>",
  "model": "<string>",
  "instructions": "<string>",
  "imageUrl": "<string>",
  "channels": [
    {
      "provider": "slack",
      "identityName": "<string>",
      "externalId": "<string>",
      "status": "<string>",
      "settingsUrl": "<string>"
    }
  ],
  "recentRequestAt": "2023-11-07T05:31:56Z",
  "workingInBackground": true,
  "createdAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>"
}

Fetches a single agent and its hosted settings. The access token is not included, so use List agents or regenerate the token if you need it. See Agent access for related concepts. The agent with its hosted configuration (harness, model, instructions). Never returns the access token.

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

Response

The agent

GET /agents/{agentId}. Carries the hosted-agent configuration the list omits; never the access token.

string

name

string

identifier

string

kind

enum<string>

Available options:

byo,

hosted

harness

string | null

Hosted agents only. The agent runtime inside the sandbox.

model

string | null

Hosted agents only. The model override, or null for the provider's default.

instructions

string | null

Hosted agents only. The agent's standing brief.

imageUrl

string | null

channels

object[]

Show child attributes

recentRequestAt

string<date-time> | null

workingInBackground

boolean

createdAt

string<date-time>

Workspace

Organization

Enterprise

Platform

Get an agent and its hosted configuration

Authorizations

Path Parameters

Response