Ask

Ask the agent a question

Ask the agent a question from your backend and get a grounded answer — the same headless answerer that serves email, WhatsApp, Messenger and Instagram.

Credential: workspace secret key (sk_…)

Warning

This returns an answer, not a plan. It cannot click, type, scroll or drive a UI — there is no browser on the server. It is deliberately not a server-side /api/act. Anything that would need a live page escalates, exactly as it does on email and WhatsApp. A consumer that ignores the escalate branch has a latent bug.

Answers are metered and consume credits like any other conversation turn, and the kill switch silences this endpoint along with every other channel.

POST

answer

Ask the agent a question

curl --request POST \
  --url https://api.peeve.ai/v1/answer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "How do I add a teammate?",
  "external_user_id": "user_8412"
}
'

import requests

url = "https://api.peeve.ai/v1/answer"

payload = {
    "message": "How do I add a teammate?",
    "external_user_id": "user_8412"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({message: 'How do I add a teammate?', external_user_id: 'user_8412'})
};

fetch('https://api.peeve.ai/v1/answer', 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.peeve.ai/v1/answer",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'message' => 'How do I add a teammate?',
    'external_user_id' => 'user_8412'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.peeve.ai/v1/answer"

	payload := strings.NewReader("{\n  \"message\": \"How do I add a teammate?\",\n  \"external_user_id\": \"user_8412\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.peeve.ai/v1/answer")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message\": \"How do I add a teammate?\",\n  \"external_user_id\": \"user_8412\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.peeve.ai/v1/answer")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"message\": \"How do I add a teammate?\",\n  \"external_user_id\": \"user_8412\"\n}"

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

{
  "path": "answer",
  "say": "You can add a teammate under Settings → Team.",
  "conversation_id": "00000000-0000-4000-8000-000000000000"
}

Authorizations

Authorization

string

header

required

The workspace secret key (sk_…) as Authorization: Bearer sk_…. X-Peeve-Key is accepted too.

Body

application/json

message

string

required

The question, in the end user's words.

external_user_id

string

Your id for the person asking, so the answer is grounded in who they are.

conversation_id

string<uuid>

Continue an existing conversation. Omit to start one.

Response

A discriminated union on path. Handle both branches.

answer
escalate

path

string

Allowed value: "answer"

say

string

The grounded answer.

conversation_id

string<uuid>

Ask the agent a question

curl --request POST \
  --url https://api.peeve.ai/v1/answer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "How do I add a teammate?",
  "external_user_id": "user_8412"
}
'

import requests

url = "https://api.peeve.ai/v1/answer"

payload = {
    "message": "How do I add a teammate?",
    "external_user_id": "user_8412"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({message: 'How do I add a teammate?', external_user_id: 'user_8412'})
};

fetch('https://api.peeve.ai/v1/answer', 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.peeve.ai/v1/answer",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'message' => 'How do I add a teammate?',
    'external_user_id' => 'user_8412'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.peeve.ai/v1/answer"

	payload := strings.NewReader("{\n  \"message\": \"How do I add a teammate?\",\n  \"external_user_id\": \"user_8412\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.peeve.ai/v1/answer")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message\": \"How do I add a teammate?\",\n  \"external_user_id\": \"user_8412\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.peeve.ai/v1/answer")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"message\": \"How do I add a teammate?\",\n  \"external_user_id\": \"user_8412\"\n}"

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

{
  "path": "answer",
  "say": "You can add a teammate under Settings → Team.",
  "conversation_id": "00000000-0000-4000-8000-000000000000"
}

Overview

Sessions

Contacts

Users

Leads

Meetings

Hand-offs

Analytics

Configuration

Webhooks

Ask

Ask the agent a question

Authorizations

Body

Response