Get the prompt of an agent

Retrieves the current prompt configured for an agent. The agent must belong to the same company as the API key used for authentication.

GET /Agent/{agentId}/prompt

Get the prompt of an agent

cURL

curl --request GET \
  --url https://api.starleads.co/Agent/{agentId}/prompt \
  --header 'X-Api-Key: <api-key>'

import requests

url = "https://api.starleads.co/Agent/{agentId}/prompt"

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://api.starleads.co/Agent/{agentId}/prompt', 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.starleads.co/Agent/{agentId}/prompt",
  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://api.starleads.co/Agent/{agentId}/prompt"

	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://api.starleads.co/Agent/{agentId}/prompt")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.starleads.co/Agent/{agentId}/prompt")

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

200

{
  "agentId": "64a1b2c3d4e5f6a7b8c9d0e1",
  "agentName": "My Sales Agent",
  "prompt": "You are a friendly sales assistant..."
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

X-Api-Key · string · header · required

Headers

X-Api-Key · string · required

Api key to pass as a X-Api-Key request header.

Path Parameters

agentId · string · required

ID of the agent.

Response

200

application/json

Success

agentId · string

ID of the agent

agentName · string

Name of the agent

prompt · string

The current prompt text of the agent