Propose an action for human confirmation
curl --request POST \
--url https://api.botshield.ai/operations/agentlink/inquire \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": {
"summary_title": "<string>",
"category": "travel.book",
"summary_detail": {
"label": "TOTAL",
"value": "$100.90"
},
"trusted_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"opaque_id": "<string>",
"botshield_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_email": "[email protected]",
"adaptive_card_payload": {},
"ttl_seconds": 600
}
'import requests
url = "https://api.botshield.ai/operations/agentlink/inquire"
payload = {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": {
"summary_title": "<string>",
"category": "travel.book",
"summary_detail": {
"label": "TOTAL",
"value": "$100.90"
},
"trusted_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"opaque_id": "<string>",
"botshield_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_email": "[email protected]",
"adaptive_card_payload": {},
"ttl_seconds": 600
}
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({
request_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
action: {
summary_title: '<string>',
category: 'travel.book',
summary_detail: {label: 'TOTAL', value: '$100.90'},
trusted_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
},
opaque_id: '<string>',
botshield_user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
user_email: '[email protected]',
adaptive_card_payload: {},
ttl_seconds: 600
})
};
fetch('https://api.botshield.ai/operations/agentlink/inquire', 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.botshield.ai/operations/agentlink/inquire",
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([
'request_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'action' => [
'summary_title' => '<string>',
'category' => 'travel.book',
'summary_detail' => [
'label' => 'TOTAL',
'value' => '$100.90'
],
'trusted_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'opaque_id' => '<string>',
'botshield_user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'user_email' => '[email protected]',
'adaptive_card_payload' => [
],
'ttl_seconds' => 600
]),
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.botshield.ai/operations/agentlink/inquire"
payload := strings.NewReader("{\n \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"action\": {\n \"summary_title\": \"<string>\",\n \"category\": \"travel.book\",\n \"summary_detail\": {\n \"label\": \"TOTAL\",\n \"value\": \"$100.90\"\n },\n \"trusted_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"opaque_id\": \"<string>\",\n \"botshield_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"user_email\": \"[email protected]\",\n \"adaptive_card_payload\": {},\n \"ttl_seconds\": 600\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.botshield.ai/operations/agentlink/inquire")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"action\": {\n \"summary_title\": \"<string>\",\n \"category\": \"travel.book\",\n \"summary_detail\": {\n \"label\": \"TOTAL\",\n \"value\": \"$100.90\"\n },\n \"trusted_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"opaque_id\": \"<string>\",\n \"botshield_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"user_email\": \"[email protected]\",\n \"adaptive_card_payload\": {},\n \"ttl_seconds\": 600\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botshield.ai/operations/agentlink/inquire")
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 \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"action\": {\n \"summary_title\": \"<string>\",\n \"category\": \"travel.book\",\n \"summary_detail\": {\n \"label\": \"TOTAL\",\n \"value\": \"$100.90\"\n },\n \"trusted_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"opaque_id\": \"<string>\",\n \"botshield_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"user_email\": \"[email protected]\",\n \"adaptive_card_payload\": {},\n \"ttl_seconds\": 600\n}"
response = http.request(request)
puts response.read_body{
"data": {
"data": {
"status": "queued",
"card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ttl_at": "2023-11-07T05:31:56Z",
"idempotent_replay": true
},
"error": {
"message": "<string>",
"statusCode": 123,
"code": "<string>",
"min_ttl_seconds": 123,
"max_ttl_seconds": 123,
"violations": [
{
"type": "<string>",
"path": "<string>",
"severity": "<string>"
}
]
}
}
}{
"message": "Invalid input provided",
"input": {},
"errors": [
{
"propertyPath": "<string>",
"invalidValue": "<unknown>",
"message": "<string>"
}
]
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}Agents Ask
Propose an action for human confirmation
Agents Ask a human-presence-gated action for a BotShield user. The user receives the card in the BotShield app (Agents Ask), confirms or denies with a biometric ceremony, and BotShield delivers a signed Proof of Resolution JWT through `GET /agentlink/check-status` and the `agents_ask.resolution.*` webhooks. Identify the user by opaque_id — the pairwise id from the bind ceremony. Authentication: agent key (bs_agent_<name>__<secret>) in the Authorization header.
POST
/
agentlink
/
inquire
Propose an action for human confirmation
curl --request POST \
--url https://api.botshield.ai/operations/agentlink/inquire \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": {
"summary_title": "<string>",
"category": "travel.book",
"summary_detail": {
"label": "TOTAL",
"value": "$100.90"
},
"trusted_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"opaque_id": "<string>",
"botshield_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_email": "[email protected]",
"adaptive_card_payload": {},
"ttl_seconds": 600
}
'import requests
url = "https://api.botshield.ai/operations/agentlink/inquire"
payload = {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": {
"summary_title": "<string>",
"category": "travel.book",
"summary_detail": {
"label": "TOTAL",
"value": "$100.90"
},
"trusted_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"opaque_id": "<string>",
"botshield_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_email": "[email protected]",
"adaptive_card_payload": {},
"ttl_seconds": 600
}
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({
request_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
action: {
summary_title: '<string>',
category: 'travel.book',
summary_detail: {label: 'TOTAL', value: '$100.90'},
trusted_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
},
opaque_id: '<string>',
botshield_user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
user_email: '[email protected]',
adaptive_card_payload: {},
ttl_seconds: 600
})
};
fetch('https://api.botshield.ai/operations/agentlink/inquire', 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.botshield.ai/operations/agentlink/inquire",
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([
'request_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'action' => [
'summary_title' => '<string>',
'category' => 'travel.book',
'summary_detail' => [
'label' => 'TOTAL',
'value' => '$100.90'
],
'trusted_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'opaque_id' => '<string>',
'botshield_user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'user_email' => '[email protected]',
'adaptive_card_payload' => [
],
'ttl_seconds' => 600
]),
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.botshield.ai/operations/agentlink/inquire"
payload := strings.NewReader("{\n \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"action\": {\n \"summary_title\": \"<string>\",\n \"category\": \"travel.book\",\n \"summary_detail\": {\n \"label\": \"TOTAL\",\n \"value\": \"$100.90\"\n },\n \"trusted_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"opaque_id\": \"<string>\",\n \"botshield_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"user_email\": \"[email protected]\",\n \"adaptive_card_payload\": {},\n \"ttl_seconds\": 600\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.botshield.ai/operations/agentlink/inquire")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"action\": {\n \"summary_title\": \"<string>\",\n \"category\": \"travel.book\",\n \"summary_detail\": {\n \"label\": \"TOTAL\",\n \"value\": \"$100.90\"\n },\n \"trusted_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"opaque_id\": \"<string>\",\n \"botshield_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"user_email\": \"[email protected]\",\n \"adaptive_card_payload\": {},\n \"ttl_seconds\": 600\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botshield.ai/operations/agentlink/inquire")
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 \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"action\": {\n \"summary_title\": \"<string>\",\n \"category\": \"travel.book\",\n \"summary_detail\": {\n \"label\": \"TOTAL\",\n \"value\": \"$100.90\"\n },\n \"trusted_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"opaque_id\": \"<string>\",\n \"botshield_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"user_email\": \"[email protected]\",\n \"adaptive_card_payload\": {},\n \"ttl_seconds\": 600\n}"
response = http.request(request)
puts response.read_body{
"data": {
"data": {
"status": "queued",
"card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ttl_at": "2023-11-07T05:31:56Z",
"idempotent_replay": true
},
"error": {
"message": "<string>",
"statusCode": 123,
"code": "<string>",
"min_ttl_seconds": 123,
"max_ttl_seconds": 123,
"violations": [
{
"type": "<string>",
"path": "<string>",
"severity": "<string>"
}
]
}
}
}{
"message": "Invalid input provided",
"input": {},
"errors": [
{
"propertyPath": "<string>",
"invalidValue": "<unknown>",
"message": "<string>"
}
]
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}Authorizations
A trusted agent key (bs_agent_<Name>__<secret>), shown once when you register the agent in the Console under Agents Ask → Trusted Agents. Scoped to one agent and one environment.
Body
application/json
Agent-supplied UUID for idempotency. Re-proposing with the same request_id returns the existing card_id.
Show child attributes
Show child attributes
CANONICAL. The pairwise id this agent holds for the human, obtained once via the bind ceremony (agent/bind-session → claim → check-binding). Meaningless to any other agent. Provide exactly one of opaque_id, botshield_user_id, user_email.
Required string length:
4 - 64The user's global BotShield id. Prefer opaque_id — this key is identical across agents and can correlate a human between integrations.
Deprecated — use opaque_id. Email of the BotShield user to receive this proposal.
Optional Adaptive Card v1.5 JSON shown when the user expands the card. Allowlist: TextBlock, FactSet, ColumnSet, Container, Table, Image (bundled-asset only).
How long the user has to respond before the proposal expires (60–86400; default 600). Out-of-range values are rejected with ttl_below_floor / ttl_above_ceiling.
Required range:
60 <= x <= 86400Response
Action proposal queued (or replayed). NOTE: handler errors also arrive here (HTTP 200) as data.error — codes for this operation: 401, 403 (category_not_allowed), 404 (no binding for opaque_id / user not found), 422 (Adaptive Card rejected, see violations), 400 with code ttl_below_floor | ttl_above_ceiling, 500, 502 (user lookup failed).
Show child attributes
Show child attributes