Confirm Card-Gated Action

Confirm Card-Gated Action (Stream)

curl --request POST \
  --url https://api.xpander.ai/v1/agents/{agent_id}/conversations/{conversation_id}/confirm \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "decision_id": "d-1a2b3c",
  "approve": true
}
'

import requests

url = "https://api.xpander.ai/v1/agents/{agent_id}/conversations/{conversation_id}/confirm"

payload = {
    "decision_id": "d-1a2b3c",
    "approve": True
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({decision_id: 'd-1a2b3c', approve: true})
};

fetch('https://api.xpander.ai/v1/agents/{agent_id}/conversations/{conversation_id}/confirm', 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.xpander.ai/v1/agents/{agent_id}/conversations/{conversation_id}/confirm",
  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([
    'decision_id' => 'd-1a2b3c',
    'approve' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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.xpander.ai/v1/agents/{agent_id}/conversations/{conversation_id}/confirm"

	payload := strings.NewReader("{\n  \"decision_id\": \"d-1a2b3c\",\n  \"approve\": true\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.xpander.ai/v1/agents/{agent_id}/conversations/{conversation_id}/confirm")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"decision_id\": \"d-1a2b3c\",\n  \"approve\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.xpander.ai/v1/agents/{agent_id}/conversations/{conversation_id}/confirm")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"decision_id\": \"d-1a2b3c\",\n  \"approve\": true\n}"

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

POST

agents

{agent_id}

conversations

{conversation_id}

confirm

Confirm Card-Gated Action (Stream)

curl --request POST \
  --url https://api.xpander.ai/v1/agents/{agent_id}/conversations/{conversation_id}/confirm \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "decision_id": "d-1a2b3c",
  "approve": true
}
'

import requests

url = "https://api.xpander.ai/v1/agents/{agent_id}/conversations/{conversation_id}/confirm"

payload = {
    "decision_id": "d-1a2b3c",
    "approve": True
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({decision_id: 'd-1a2b3c', approve: true})
};

fetch('https://api.xpander.ai/v1/agents/{agent_id}/conversations/{conversation_id}/confirm', 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.xpander.ai/v1/agents/{agent_id}/conversations/{conversation_id}/confirm",
  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([
    'decision_id' => 'd-1a2b3c',
    'approve' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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.xpander.ai/v1/agents/{agent_id}/conversations/{conversation_id}/confirm"

	payload := strings.NewReader("{\n  \"decision_id\": \"d-1a2b3c\",\n  \"approve\": true\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.xpander.ai/v1/agents/{agent_id}/conversations/{conversation_id}/confirm")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"decision_id\": \"d-1a2b3c\",\n  \"approve\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.xpander.ai/v1/agents/{agent_id}/conversations/{conversation_id}/confirm")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"decision_id\": \"d-1a2b3c\",\n  \"approve\": true\n}"

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

When a turn raises a confirmation card for a destructive action (deleting an agent, for example), approve or decline it here. The target of the action is read from the card itself, never from the body, and the action’s own permission check runs again against the confirming user. approve: false dismisses the card and changes nothing. Streams the continued turn’s events over SSE. Send the card’s id as decision_id. Only Omni raises confirmation cards. For any other agent the call returns 400 with Confirmation endpoints are Omni-only. See the Conversations overview for the full conversation model.

Authorizations

x-api-key

string

header

required

API Key for authentication

Path Parameters

agent_id

string

required

conversation_id

string

required

Body

application/json

decision_id

string

required

Id of the confirmation card's interaction being resolved.

approve

boolean

default:true

true carries out the action, false dismisses it.

Response

200

Server-Sent Events stream of TaskUpdateEvent frames

Overview

REST API - Conversations

REST API - Agents

REST API - Tasks

Agent Workspace

REST API - Knowledge

REST API - Skills

REST API - Workflows

REST API - Custom Functions

REST API - Scheduled Tasks

REST API - Self-Schedules

REST API - Misc

SDK: get started

SDK integrations

Memory

Knowledge

Channels and webhooks

Skills in code

Advanced

CLI Reference

SDK Reference

Confirm Card-Gated Action

Authorizations

Path Parameters

Body

Response