curl --request GET \
--url https://www.crossmint.com/api/unstable/agent-checkouts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://www.crossmint.com/api/unstable/agent-checkouts/{id}"
headers = {
"X-API-KEY": "<api-key>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-API-KEY': '<api-key>', Authorization: 'Bearer <token>'}
};
fetch('https://www.crossmint.com/api/unstable/agent-checkouts/{id}', 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://www.crossmint.com/api/unstable/agent-checkouts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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"
"net/http"
"io"
)
func main() {
url := "https://www.crossmint.com/api/unstable/agent-checkouts/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.crossmint.com/api/unstable/agent-checkouts/{id}")
.header("X-API-KEY", "<api-key>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.crossmint.com/api/unstable/agent-checkouts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued",
"target": {
"kind": "direct_url",
"url": "<string>",
"request": "buy the medium in black",
"merchantContext": "<string>"
},
"constraints": {
"maxCost": {
"amount": "100.00",
"currency": "USD"
}
},
"progressItems": [
{
"kind": "step",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"intentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sequence": 1,
"label": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"summary": "<string>",
"finishedAt": "2023-11-07T05:31:56Z"
}
],
"browser": {
"embedUrl": "<string>",
"permissions": [
"read"
]
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"pack": {
"packId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchantDisplayName": "<string>",
"phasesUsed": [
"<string>"
]
},
"pendingUserAction": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"intentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"responseSchema": {},
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z"
},
"receipt": {
"total": {
"amount": "100.00",
"currency": "USD"
},
"capturedAt": "2023-11-07T05:31:56Z",
"merchantOrderId": "<string>",
"evidence": {
"confirmationUrl": "<string>",
"confirmationText": "<string>"
}
},
"failure": {
"reason": "max_cost_exceeded",
"message": "<string>",
"failedAt": "2023-11-07T05:31:56Z"
},
"metadata": {}
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}Get Agent Checkout
Retrieve the current state of an agent checkout.
API scope required: agent-checkouts.read
curl --request GET \
--url https://www.crossmint.com/api/unstable/agent-checkouts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://www.crossmint.com/api/unstable/agent-checkouts/{id}"
headers = {
"X-API-KEY": "<api-key>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-API-KEY': '<api-key>', Authorization: 'Bearer <token>'}
};
fetch('https://www.crossmint.com/api/unstable/agent-checkouts/{id}', 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://www.crossmint.com/api/unstable/agent-checkouts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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"
"net/http"
"io"
)
func main() {
url := "https://www.crossmint.com/api/unstable/agent-checkouts/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.crossmint.com/api/unstable/agent-checkouts/{id}")
.header("X-API-KEY", "<api-key>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.crossmint.com/api/unstable/agent-checkouts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued",
"target": {
"kind": "direct_url",
"url": "<string>",
"request": "buy the medium in black",
"merchantContext": "<string>"
},
"constraints": {
"maxCost": {
"amount": "100.00",
"currency": "USD"
}
},
"progressItems": [
{
"kind": "step",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"intentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sequence": 1,
"label": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"summary": "<string>",
"finishedAt": "2023-11-07T05:31:56Z"
}
],
"browser": {
"embedUrl": "<string>",
"permissions": [
"read"
]
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"pack": {
"packId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchantDisplayName": "<string>",
"phasesUsed": [
"<string>"
]
},
"pendingUserAction": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"intentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"responseSchema": {},
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z"
},
"receipt": {
"total": {
"amount": "100.00",
"currency": "USD"
},
"capturedAt": "2023-11-07T05:31:56Z",
"merchantOrderId": "<string>",
"evidence": {
"confirmationUrl": "<string>",
"confirmationText": "<string>"
}
},
"failure": {
"reason": "max_cost_exceeded",
"message": "<string>",
"failedAt": "2023-11-07T05:31:56Z"
},
"metadata": {}
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}Authorizations
Client-side API key (ck_...) with the agent-checkouts.* scopes.
JWT identifying the end user, issued by an external auth provider your project trusts.
Path Parameters
The agent checkout id (returned by create).
Response
Returns the agent checkout.
The full checkout view, returned by create, get, and cancel.
The checkout id.
Lifecycle state. succeeded, failed, and cancelled are terminal.
queued, running, awaiting_user_action, succeeded, failed, cancelled Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The live browser session the agent is driving.
Show child attributes
Show child attributes
Present on the checkout view when a pack drove the run. The pack id, merchant name, and phases used are captured on the run so they survive a later edit or deletion of the pack.
Show child attributes
Show child attributes
Present when status is awaiting_user_action. Render a form from responseSchema and submit matching values.
Show child attributes
Show child attributes
Present when status is succeeded.
Show child attributes
Show child attributes
Present when status is failed.
Show child attributes
Show child attributes
Optional string key/value pairs echoed back on the checkout.
Show child attributes
Show child attributes
Was this page helpful?

