Prepare TFU Live agent
Sets up the TFU Live agent’s current saved version for real calls. Send the ifVersion you read. Every save already starts this. Use it to retry a save whose setupError says setup did not start. It is refused as setup_incomplete while setup items are left (a setting still to fill, or a Brain template placeholder in the prompt). The refusal names the first and lists every one. A success means setup started. It does not mean the agent is ready or live. Check that with GET /api/tfu-live-agents/{id}/go-live-check.
Required scope: agents:write.
Required API key scope: agents:write.
POST
/
api
/
tfu-live-agents
/
{id}
/
prepare
cURL
curl --request POST \
--url https://api.teamfollowup.ai/api/tfu-live-agents/{id}/prepare \
--header 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.teamfollowup.ai/api/tfu-live-agents/{id}/prepare"
payload = { "ifVersion": "<string>" }
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({ifVersion: '<string>'})
};
fetch('https://api.teamfollowup.ai/api/tfu-live-agents/{id}/prepare', 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.teamfollowup.ai/api/tfu-live-agents/{id}/prepare",
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([
'ifVersion' => '<string>'
]),
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.teamfollowup.ai/api/tfu-live-agents/{id}/prepare"
payload := strings.NewReader("{\n \"ifVersion\": \"<string>\"\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.teamfollowup.ai/api/tfu-live-agents/{id}/prepare")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ifVersion\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.teamfollowup.ai/api/tfu-live-agents/{id}/prepare")
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 \"ifVersion\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"agent": {
"id": "tfu_live:example_agent",
"runtime": "tfu_live",
"name": "Consultation desk",
"brain": {
"prompt": "Help people arrange a consultation. Confirm that their postal code is covered before offering an appointment.",
"capabilities": [
"outreach"
],
"capabilityConfig": {
"workflows": {
"wf_area2k9x": {
"id": "wf_area2k9x",
"name": "Check service area",
"description": "Use when the caller wants to know whether we serve their area.",
"steps": [
{
"id": "zip",
"type": "collect_information",
"config": {
"items": [
{
"id": "zip_code",
"label": "Zip code",
"question": "What is the zip code of the address?",
"type": "text",
"field": "contact.postalCode"
}
]
}
},
{
"id": "coverage",
"type": "check_zip_code",
"config": {
"field": "contact.postalCode",
"codes": [
"10001"
]
},
"outputs": {
"in_area": [
{
"id": "covered",
"type": "steer_agent",
"config": {
"guidance": "Offer a consultation."
}
}
],
"out_of_area": [
{
"id": "outside",
"type": "steer_agent",
"config": {
"guidance": "Explain that this area is not covered."
}
}
]
}
}
]
}
}
}
},
"voice": {
"voiceId": "marin",
"prompt": "Speak at a calm pace and pronounce addresses clearly."
},
"authoring": {
"editable": true,
"reasons": []
},
"orb": {
"style": "default"
},
"ifVersion": "3f2b9c0d1e",
"setup": {
"status": "preparing",
"revision": 2
}
},
"setupStarted": true
}
}Authorizations
Path Parameters
Query Parameters
Body
application/json
{ ifVersion }: the version you read.
⌘I
cURL
curl --request POST \
--url https://api.teamfollowup.ai/api/tfu-live-agents/{id}/prepare \
--header 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.teamfollowup.ai/api/tfu-live-agents/{id}/prepare"
payload = { "ifVersion": "<string>" }
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({ifVersion: '<string>'})
};
fetch('https://api.teamfollowup.ai/api/tfu-live-agents/{id}/prepare', 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.teamfollowup.ai/api/tfu-live-agents/{id}/prepare",
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([
'ifVersion' => '<string>'
]),
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.teamfollowup.ai/api/tfu-live-agents/{id}/prepare"
payload := strings.NewReader("{\n \"ifVersion\": \"<string>\"\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.teamfollowup.ai/api/tfu-live-agents/{id}/prepare")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ifVersion\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.teamfollowup.ai/api/tfu-live-agents/{id}/prepare")
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 \"ifVersion\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"agent": {
"id": "tfu_live:example_agent",
"runtime": "tfu_live",
"name": "Consultation desk",
"brain": {
"prompt": "Help people arrange a consultation. Confirm that their postal code is covered before offering an appointment.",
"capabilities": [
"outreach"
],
"capabilityConfig": {
"workflows": {
"wf_area2k9x": {
"id": "wf_area2k9x",
"name": "Check service area",
"description": "Use when the caller wants to know whether we serve their area.",
"steps": [
{
"id": "zip",
"type": "collect_information",
"config": {
"items": [
{
"id": "zip_code",
"label": "Zip code",
"question": "What is the zip code of the address?",
"type": "text",
"field": "contact.postalCode"
}
]
}
},
{
"id": "coverage",
"type": "check_zip_code",
"config": {
"field": "contact.postalCode",
"codes": [
"10001"
]
},
"outputs": {
"in_area": [
{
"id": "covered",
"type": "steer_agent",
"config": {
"guidance": "Offer a consultation."
}
}
],
"out_of_area": [
{
"id": "outside",
"type": "steer_agent",
"config": {
"guidance": "Explain that this area is not covered."
}
}
]
}
}
]
}
}
}
},
"voice": {
"voiceId": "marin",
"prompt": "Speak at a calm pace and pronounce addresses clearly."
},
"authoring": {
"editable": true,
"reasons": []
},
"orb": {
"style": "default"
},
"ifVersion": "3f2b9c0d1e",
"setup": {
"status": "preparing",
"revision": 2
}
},
"setupStarted": true
}
}