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

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

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/{id}/', 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/{id}/",
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/{id}/"

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/{id}/")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

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

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
{
  "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>"
}

Authorizations

X-API-Key
string
header
required

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

Path Parameters

id
string
required

Response

200 - application/json
id
string<uuid>
required
read-only
name
string
required
Maximum string length: 255
systemPrompt
string
required
firstMessage
string
required
profilePicture
string
required
read-only
tools
object[]
required
read-only
documents
object[]
required
read-only
memoryKeys
object[]
required
read-only
wakeUpConfigs
object[]
required
read-only
outboundTriggers
object[]
required
read-only
websiteTools
object[]
required
read-only
imageGenerateTools
object[]
required
read-only
handoffTools
object[]
required
read-only
mcpConfigs
object[]
required
read-only
paywallConfig
string
required
read-only
adConfig
string
required
read-only
creditSettings
string
required
read-only
voiceCallConfig
string
required
read-only
owner
string
required
read-only
sharings
string
required
read-only
phoneNumbers
object[]
required
read-only
totalMessages
string
required
read-only
totalSessions
string
required
read-only
connectUrl
string
required
read-only
ownerActive
string
required
read-only
createdAt
string<date-time>
required
read-only
description
string
icebreakers
any
llmModel
string | null