Skip to main content
GET
/
api
/
v1
/
agents
/
cURL
curl --request GET \
  --url https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/ \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/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 => [
"X-API-Key: <api-key>"
],
]);

$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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/"

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

req.Header.Add("X-API-Key", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "systemPrompt": "<string>",
      "firstMessage": "<string>",
      "profilePicture": "<string>",
      "tools": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>",
          "apiSchema": "<unknown>",
          "creditCost": 123,
          "active": true
        }
      ],
      "documents": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "file": "<string>",
          "status": "<string>"
        }
      ],
      "memoryKeys": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "key": "<string>",
          "type": "<string>",
          "initialValue": "<string>",
          "whenToUpdate": "<string>"
        }
      ],
      "wakeUpConfigs": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "description": "<string>",
          "forceMessage": true,
          "enabled": true
        }
      ],
      "outboundTriggers": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "url": "<string>",
          "templateId": "<string>",
          "templateName": "<string>",
          "secret": "<string>",
          "enabled": true
        }
      ],
      "websiteTools": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "url": "<string>",
          "prompt": "<string>",
          "active": true
        }
      ],
      "imageGenerateTools": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "prompt": "<string>",
          "creditCost": 123,
          "name": "<string>",
          "description": "<string>",
          "active": true
        }
      ],
      "handoffTools": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "parentAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "childAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "childAgentName": "<string>",
          "description": "<string>",
          "active": true
        }
      ],
      "mcpConfigs": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "connectorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "connectorName": "<string>",
          "toolWhitelist": "<unknown>"
        }
      ],
      "paywallConfig": "<string>",
      "adConfig": "<string>",
      "creditSettings": "<string>",
      "voiceCallConfig": "<string>",
      "owner": "<string>",
      "sharings": "<string>",
      "phoneNumbers": [
        {
          "whatsappPhoneNumberId": "<string>",
          "whatsappBusinessAccountId": "<string>",
          "wabaId": "<string>",
          "phoneNumber": "<string>"
        }
      ],
      "totalMessages": "<string>",
      "totalSessions": "<string>",
      "connectUrl": "<string>",
      "ownerActive": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "icebreakers": "<unknown>",
      "llmModel": "<string>"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

X-API-Key
string
header
required

API key authentication. Pass your API key in the X-API-Key header.

Query Parameters

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"