List chat agents

curl --request GET \
  --url https://api.upon-ai.com/api/chat-agents \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.upon-ai.com/api/chat-agents', 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.upon-ai.com/api/chat-agents",
  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.upon-ai.com/api/chat-agents"

	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.upon-ai.com/api/chat-agents")

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

{
  "data": [
    {
      "agent_id": "chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6",
      "agent_name": "Website Concierge",
      "version": 3,
      "response_engine": {
        "type": "uponai-llm",
        "llm_id": "llm_1ab234cde567fgh"
      },
      "auto_close_message": "Thanks for chatting with UponAI.",
      "is_public": true
    }
  ],
  "pagination_key": "chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6",
  "pagination_key_version": 3
}

GET

api

chat-agents

List chat agents

curl --request GET \
  --url https://api.upon-ai.com/api/chat-agents \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.upon-ai.com/api/chat-agents', 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.upon-ai.com/api/chat-agents",
  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.upon-ai.com/api/chat-agents"

	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.upon-ai.com/api/chat-agents")

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

{
  "data": [
    {
      "agent_id": "chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6",
      "agent_name": "Website Concierge",
      "version": 3,
      "response_engine": {
        "type": "uponai-llm",
        "llm_id": "llm_1ab234cde567fgh"
      },
      "auto_close_message": "Thanks for chatting with UponAI.",
      "is_public": true
    }
  ],
  "pagination_key": "chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6",
  "pagination_key_version": 3
}

Authorizations

Authorization

string

header

required

Generate tokens from your profile settings at app.uponai.com.

Query Parameters

workspaceId

integer

required

Workspace identifier. Call GET /api/workspaces to list workspaces accessible to your token.

limit

integer

default:1000

Maximum number of records to return.

Required range: 1 <= x <= 1000

paginationKey

string

Identifier to continue pagination.

paginationKeyVersion

integer

Version paired with the pagination key.

Response

200 - application/json

Chat agent summary list.

data

object[]

Show child attributes

pagination_key

string | null

pagination_key_version

integer | null

Calls

LLM Models

Agents

Chat Agents

Chats

Conversation Flows

Knowledge Bases

Voices

Test Case Definitions

Test Runs

Account

Phone Numbers

List chat agents

Authorizations

Query Parameters

Response