curl
curl -X POST "https://api.signalmd.dev/v1/agents/6f1d2c3b-4a5e-4f60-8b7a-9c0d1e2f3a4b/goals/<goalId>/spend" \
-H "Authorization: Bearer $SIGNAL_API_KEY"import requests
url = "https://api.signalmd.dev/v1/agents/{agentId}/goals/{goalId}/spend"
payload = {
"inputTokens": 500000000,
"outputTokens": 500000000,
"model": "<string>",
"cacheReadTokens": 500000000,
"cacheWriteTokens": 500000000,
"usd": 5000
}
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({
inputTokens: 500000000,
outputTokens: 500000000,
model: '<string>',
cacheReadTokens: 500000000,
cacheWriteTokens: 500000000,
usd: 5000
})
};
fetch('https://api.signalmd.dev/v1/agents/{agentId}/goals/{goalId}/spend', 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.signalmd.dev/v1/agents/{agentId}/goals/{goalId}/spend",
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([
'inputTokens' => 500000000,
'outputTokens' => 500000000,
'model' => '<string>',
'cacheReadTokens' => 500000000,
'cacheWriteTokens' => 500000000,
'usd' => 5000
]),
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.signalmd.dev/v1/agents/{agentId}/goals/{goalId}/spend"
payload := strings.NewReader("{\n \"inputTokens\": 500000000,\n \"outputTokens\": 500000000,\n \"model\": \"<string>\",\n \"cacheReadTokens\": 500000000,\n \"cacheWriteTokens\": 500000000,\n \"usd\": 5000\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.signalmd.dev/v1/agents/{agentId}/goals/{goalId}/spend")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputTokens\": 500000000,\n \"outputTokens\": 500000000,\n \"model\": \"<string>\",\n \"cacheReadTokens\": 500000000,\n \"cacheWriteTokens\": 500000000,\n \"usd\": 5000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.signalmd.dev/v1/agents/{agentId}/goals/{goalId}/spend")
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 \"inputTokens\": 500000000,\n \"outputTokens\": 500000000,\n \"model\": \"<string>\",\n \"cacheReadTokens\": 500000000,\n \"cacheWriteTokens\": 500000000,\n \"usd\": 5000\n}"
response = http.request(request)
puts response.read_body{
"goalId": "3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
"title": "<string>",
"status": "<string>",
"model": {
"inputTokens": 123,
"outputTokens": 123,
"usd": 123,
"bySource": {
"copilot_turn": {
"inputTokens": 123,
"outputTokens": 123,
"usd": 123
},
"client_reported": {
"inputTokens": 123,
"outputTokens": 123,
"usd": 123
},
"quick_check": {
"inputTokens": 123,
"outputTokens": 123,
"usd": 123
}
}
},
"retell": {
"runs": 123,
"retellUsd": 123,
"signalUsd": 123
},
"totalUsd": 123
}{
"error": {
"type": "not_found_error",
"code": "agent_not_found",
"message": "Agent not found.",
"param": null,
"requestId": "req_8c1f0e2b4a6d9e3f7a5c1b0d"
}
}{
"error": {
"type": "not_found_error",
"code": "agent_not_found",
"message": "Agent not found.",
"param": null,
"requestId": "req_8c1f0e2b4a6d9e3f7a5c1b0d"
}
}{
"error": {
"type": "not_found_error",
"code": "agent_not_found",
"message": "Agent not found.",
"param": null,
"requestId": "req_8c1f0e2b4a6d9e3f7a5c1b0d"
}
}{
"error": {
"type": "not_found_error",
"code": "agent_not_found",
"message": "Agent not found.",
"param": null,
"requestId": "req_8c1f0e2b4a6d9e3f7a5c1b0d"
}
}{
"error": {
"type": "not_found_error",
"code": "agent_not_found",
"message": "Agent not found.",
"param": null,
"requestId": "req_8c1f0e2b4a6d9e3f7a5c1b0d"
}
}{
"error": {
"type": "not_found_error",
"code": "agent_not_found",
"message": "Agent not found.",
"param": null,
"requestId": "req_8c1f0e2b4a6d9e3f7a5c1b0d"
}
}Goals
Report spend
Records model spend a client paid for while working on the goal. Reported, not checked, and never capped.
POST
/
v1
/
agents
/
{agentId}
/
goals
/
{goalId}
/
spend
curl
curl -X POST "https://api.signalmd.dev/v1/agents/6f1d2c3b-4a5e-4f60-8b7a-9c0d1e2f3a4b/goals/<goalId>/spend" \
-H "Authorization: Bearer $SIGNAL_API_KEY"import requests
url = "https://api.signalmd.dev/v1/agents/{agentId}/goals/{goalId}/spend"
payload = {
"inputTokens": 500000000,
"outputTokens": 500000000,
"model": "<string>",
"cacheReadTokens": 500000000,
"cacheWriteTokens": 500000000,
"usd": 5000
}
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({
inputTokens: 500000000,
outputTokens: 500000000,
model: '<string>',
cacheReadTokens: 500000000,
cacheWriteTokens: 500000000,
usd: 5000
})
};
fetch('https://api.signalmd.dev/v1/agents/{agentId}/goals/{goalId}/spend', 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.signalmd.dev/v1/agents/{agentId}/goals/{goalId}/spend",
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([
'inputTokens' => 500000000,
'outputTokens' => 500000000,
'model' => '<string>',
'cacheReadTokens' => 500000000,
'cacheWriteTokens' => 500000000,
'usd' => 5000
]),
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.signalmd.dev/v1/agents/{agentId}/goals/{goalId}/spend"
payload := strings.NewReader("{\n \"inputTokens\": 500000000,\n \"outputTokens\": 500000000,\n \"model\": \"<string>\",\n \"cacheReadTokens\": 500000000,\n \"cacheWriteTokens\": 500000000,\n \"usd\": 5000\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.signalmd.dev/v1/agents/{agentId}/goals/{goalId}/spend")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputTokens\": 500000000,\n \"outputTokens\": 500000000,\n \"model\": \"<string>\",\n \"cacheReadTokens\": 500000000,\n \"cacheWriteTokens\": 500000000,\n \"usd\": 5000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.signalmd.dev/v1/agents/{agentId}/goals/{goalId}/spend")
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 \"inputTokens\": 500000000,\n \"outputTokens\": 500000000,\n \"model\": \"<string>\",\n \"cacheReadTokens\": 500000000,\n \"cacheWriteTokens\": 500000000,\n \"usd\": 5000\n}"
response = http.request(request)
puts response.read_body{
"goalId": "3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
"title": "<string>",
"status": "<string>",
"model": {
"inputTokens": 123,
"outputTokens": 123,
"usd": 123,
"bySource": {
"copilot_turn": {
"inputTokens": 123,
"outputTokens": 123,
"usd": 123
},
"client_reported": {
"inputTokens": 123,
"outputTokens": 123,
"usd": 123
},
"quick_check": {
"inputTokens": 123,
"outputTokens": 123,
"usd": 123
}
}
},
"retell": {
"runs": 123,
"retellUsd": 123,
"signalUsd": 123
},
"totalUsd": 123
}{
"error": {
"type": "not_found_error",
"code": "agent_not_found",
"message": "Agent not found.",
"param": null,
"requestId": "req_8c1f0e2b4a6d9e3f7a5c1b0d"
}
}{
"error": {
"type": "not_found_error",
"code": "agent_not_found",
"message": "Agent not found.",
"param": null,
"requestId": "req_8c1f0e2b4a6d9e3f7a5c1b0d"
}
}{
"error": {
"type": "not_found_error",
"code": "agent_not_found",
"message": "Agent not found.",
"param": null,
"requestId": "req_8c1f0e2b4a6d9e3f7a5c1b0d"
}
}{
"error": {
"type": "not_found_error",
"code": "agent_not_found",
"message": "Agent not found.",
"param": null,
"requestId": "req_8c1f0e2b4a6d9e3f7a5c1b0d"
}
}{
"error": {
"type": "not_found_error",
"code": "agent_not_found",
"message": "Agent not found.",
"param": null,
"requestId": "req_8c1f0e2b4a6d9e3f7a5c1b0d"
}
}{
"error": {
"type": "not_found_error",
"code": "agent_not_found",
"message": "Agent not found.",
"param": null,
"requestId": "req_8c1f0e2b4a6d9e3f7a5c1b0d"
}
}Authorizations
An API key (sig_...), or a session token from the web app.
Path Parameters
The agent's id.
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Example:
"3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"
The goal's id.
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Example:
"3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"
Body
application/json
Required range:
0 <= x <= 1000000000Required range:
0 <= x <= 1000000000Required string length:
1 - 120Required range:
0 <= x <= 1000000000Required range:
0 <= x <= 1000000000Required range:
0 <= x <= 10000Response
The goal's spend after the report.
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Example:
"3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"
Model tokens and dollars: the copilot's turns, quick checks, and what a client reported.
Show child attributes
Show child attributes
The goal's Retell runs and their cost.
Show child attributes
Show child attributes
Was this page helpful?