Preview an agent computer code

Part of Devices, 10 operations. The overview covers keys, scopes and errors.

GET /v1/pair/{user_code}

The details of a pending code an agent computer showed. First-party only: your own Superbot app (a session or its device token).

Any live caller key (Authorization: Bearer sbc_… or x-api-key: sbc_…), or a signed-in session.

Operation id previewAgentPair in Devices.

Path parameters

user_code string required
The code the agent computer shows (e.g. ABCD-EFGH).

Response 200

The pending code.

application/json: AgentPairPreview.

kind string required
One of agent_computer.
label string required
agent_vendor string | null required
ip string | null required
geo string | null required
tier string required
One of link.
approve_on string required
One of this_device, phone.
asked_at string
When the agent computer asked for this code (ISO-8601 UTC). Absent on an older edge.
expires_at string
When the code lapses (ISO-8601 UTC). Absent on an older edge.

Errors

Status	Code	What to change
401	`unauthorized`	Send a live caller key or session as `Authorization: Bearer …` or `x-api-key`. No key yet: create one at /account/api, or sign a user in at /auth.md.
403	`insufficient_scope`	The key lacks the scope in `required_scopes`; mint a key that holds it.
404	`not_found`	No such resource on this account; check the id.

view .md openapi

Request

curl

curl -sS -X GET "https://superbot.gg/v1/pair/$USER_CODE" \
  -H "Authorization: Bearer $SUPERBOT_API_KEY"

JavaScript

const userCode = 'USER_CODE';
const res = await fetch(`https://superbot.gg/v1/pair/${userCode}`, {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SUPERBOT_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os
import requests

user_code = "USER_CODE"
res = requests.request(
    "GET",
    f"https://superbot.gg/v1/pair/{user_code}",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
    },
)
print(res.status_code, res.json())

Response

200 The pending code.

{
  "kind": "agent_computer",
  "label": "your-label",
  "agent_vendor": "your-agent-vendor",
  "ip": "your-ip",
  "geo": "your-geo",
  "tier": "link",
  "approve_on": "this_device",
  "asked_at": "your-asked-at",
  "expires_at": "your-expires-at"
}

401 The bearer is missing, malformed or unknown.

{
  "error": "unauthorized",
  "message": "Send a live caller key or session as Authorization: Bearer … or x-api-key. No key yet: create one at /account/api, or sign a user in at /auth.md.",
  "doc_url": "https://superbot.gg/developers#errors-unauthorized",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

403 The key lacks a scope (insufficient_scope), is revoked, or may not call this route.

{
  "error": "insufficient_scope",
  "message": "The key lacks the scope in required_scopes; mint a key that holds it.",
  "doc_url": "https://superbot.gg/developers#errors-insufficient_scope",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

404 No such resource on this account.

{
  "error": "not_found",
  "message": "No such resource on this account; check the id.",
  "doc_url": "https://superbot.gg/developers#errors-not_found",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}