curl --request POST \
--url https://api.botshield.ai/operations/gates-api/actions/request \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent": "couchtour",
"act": "hold:3f1c…:9a0b1c2d3e4f5a6b",
"partner_user_ref": "<string>",
"act_label": "Hold Summer ’26 tee · $40",
"requested_by": "Muse",
"ttl_seconds": 600
}
'import requests
url = "https://api.botshield.ai/operations/gates-api/actions/request"
payload = {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent": "couchtour",
"act": "hold:3f1c…:9a0b1c2d3e4f5a6b",
"partner_user_ref": "<string>",
"act_label": "Hold Summer ’26 tee · $40",
"requested_by": "Muse",
"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',
agent: 'couchtour',
act: 'hold:3f1c…:9a0b1c2d3e4f5a6b',
partner_user_ref: '<string>',
act_label: 'Hold Summer ’26 tee · $40',
requested_by: 'Muse',
ttl_seconds: 600
})
};
fetch('https://api.botshield.ai/operations/gates-api/actions/request', 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/gates-api/actions/request",
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',
'agent' => 'couchtour',
'act' => 'hold:3f1c…:9a0b1c2d3e4f5a6b',
'partner_user_ref' => '<string>',
'act_label' => 'Hold Summer ’26 tee · $40',
'requested_by' => 'Muse',
'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/gates-api/actions/request"
payload := strings.NewReader("{\n \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent\": \"couchtour\",\n \"act\": \"hold:3f1c…:9a0b1c2d3e4f5a6b\",\n \"partner_user_ref\": \"<string>\",\n \"act_label\": \"Hold Summer ’26 tee · $40\",\n \"requested_by\": \"Muse\",\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/gates-api/actions/request")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent\": \"couchtour\",\n \"act\": \"hold:3f1c…:9a0b1c2d3e4f5a6b\",\n \"partner_user_ref\": \"<string>\",\n \"act_label\": \"Hold Summer ’26 tee · $40\",\n \"requested_by\": \"Muse\",\n \"ttl_seconds\": 600\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botshield.ai/operations/gates-api/actions/request")
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 \"agent\": \"couchtour\",\n \"act\": \"hold:3f1c…:9a0b1c2d3e4f5a6b\",\n \"partner_user_ref\": \"<string>\",\n \"act_label\": \"Hold Summer ’26 tee · $40\",\n \"requested_by\": \"Muse\",\n \"ttl_seconds\": 600\n}"
response = http.request(request)
puts response.read_body{
"data": {
"data": {
"request_id": "<string>",
"status": "queued",
"expires_at": "2023-11-07T05:31:56Z"
},
"error": {
"message": "<string>",
"statusCode": 409,
"code": "gate_key_taken"
}
}
}{
"message": "Invalid input provided",
"input": {},
"errors": [
{
"propertyPath": "<string>",
"invalidValue": "<unknown>",
"message": "<string>"
}
]
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}Ask a linked person to confirm an action
An agent asks, a person confirms. Puts ONE BotShield Action in front of a person already linked to your company, as a card in their BotShield app naming the agent that asked. The person approves with their passkey, which signs the act itself. Collect the action token with gates-api/actions/request-status and check it with sdk/verify-token (claims.act), exactly as for a tapped action. Idempotent on (agent, request_id).
curl --request POST \
--url https://api.botshield.ai/operations/gates-api/actions/request \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent": "couchtour",
"act": "hold:3f1c…:9a0b1c2d3e4f5a6b",
"partner_user_ref": "<string>",
"act_label": "Hold Summer ’26 tee · $40",
"requested_by": "Muse",
"ttl_seconds": 600
}
'import requests
url = "https://api.botshield.ai/operations/gates-api/actions/request"
payload = {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent": "couchtour",
"act": "hold:3f1c…:9a0b1c2d3e4f5a6b",
"partner_user_ref": "<string>",
"act_label": "Hold Summer ’26 tee · $40",
"requested_by": "Muse",
"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',
agent: 'couchtour',
act: 'hold:3f1c…:9a0b1c2d3e4f5a6b',
partner_user_ref: '<string>',
act_label: 'Hold Summer ’26 tee · $40',
requested_by: 'Muse',
ttl_seconds: 600
})
};
fetch('https://api.botshield.ai/operations/gates-api/actions/request', 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/gates-api/actions/request",
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',
'agent' => 'couchtour',
'act' => 'hold:3f1c…:9a0b1c2d3e4f5a6b',
'partner_user_ref' => '<string>',
'act_label' => 'Hold Summer ’26 tee · $40',
'requested_by' => 'Muse',
'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/gates-api/actions/request"
payload := strings.NewReader("{\n \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent\": \"couchtour\",\n \"act\": \"hold:3f1c…:9a0b1c2d3e4f5a6b\",\n \"partner_user_ref\": \"<string>\",\n \"act_label\": \"Hold Summer ’26 tee · $40\",\n \"requested_by\": \"Muse\",\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/gates-api/actions/request")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent\": \"couchtour\",\n \"act\": \"hold:3f1c…:9a0b1c2d3e4f5a6b\",\n \"partner_user_ref\": \"<string>\",\n \"act_label\": \"Hold Summer ’26 tee · $40\",\n \"requested_by\": \"Muse\",\n \"ttl_seconds\": 600\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botshield.ai/operations/gates-api/actions/request")
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 \"agent\": \"couchtour\",\n \"act\": \"hold:3f1c…:9a0b1c2d3e4f5a6b\",\n \"partner_user_ref\": \"<string>\",\n \"act_label\": \"Hold Summer ’26 tee · $40\",\n \"requested_by\": \"Muse\",\n \"ttl_seconds\": 600\n}"
response = http.request(request)
puts response.read_body{
"data": {
"data": {
"request_id": "<string>",
"status": "queued",
"expires_at": "2023-11-07T05:31:56Z"
},
"error": {
"message": "<string>",
"statusCode": 409,
"code": "gate_key_taken"
}
}
}{
"message": "Invalid input provided",
"input": {},
"errors": [
{
"propertyPath": "<string>",
"invalidValue": "<unknown>",
"message": "<string>"
}
]
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}Authorizations
Your secret server API key (bs_dev_… or bs_production_…) with Gates API access: the gates:write scope, granted in the Console under Settings → Developer Tools → API Keys. Without it every Gates API call answers gates_scope_required. The organization and environment always come from the key. Site keys are refused.
Body
Response
Queued. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: invalid_key (401), gates_scope_required (403), action_invalid (400), action_not_found (404), action_off (404), agent_not_found (404), not_linked (409 — the person isn't linked to your company), request_id_reused (409).
