StatusSupportGet API keyDashboard
SignupSee an agent's request for a key

Signup

See an agent's request for a key

Use with AI

POST /v1/agent_claims/lookup

The approval page calls it with the code an agent shows its person: what is asking, from where, and what its key could do. Free.

Auth: the dashboard session cookie.

Example

cURL
curl -X POST 'https://socialtap.dev/v1/agent_claims/lookup' \
  -H "x-api-key: $SOCIALTAP_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "code": "string"
}'

Authorizations

The dashboard's session cookie, not an API key.

Body

application/json

JSON. Fields marked nullable may be null; optional ones may be left out.

codestring

The code the agent shows, or the one in its link.

Response

application/json

200

See an agent's request for a key

dataobject
ShowHide 11 child fields
client_name?string

What the agent calls itself. Nothing verifies it.

created_atstring date-time

When it asked, RFC 3339 UTC.

expires_atstring date-time

When the request lapses, RFC 3339 UTC.

key_namestring

The label its key will have.

location?string

Roughly where the request came from: city and country, where known. Absent for an OAuth client, like network.

loopback?boolean

An OAuth client on the person's own computer: the approval goes back to a local port.

network?string

The network it came from: the client's IPv4 address or IPv6 /64. Absent for an OAuth client: its request comes through the person's own browser.

objectstring

Always agent_claim.

One ofagent_claim

redirect_host?string

An OAuth client: the host the approval goes back to.

scopesstring[]

What its key may do.

user_code?string

The code the agent shows, to compare. Absent for an OAuth client, which shows none.

metaobject

The shared route meta (see the API reference introduction).

400

400 Bad Request.

invalid_inputNo retry

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

401

401 Unauthorized.

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

403

403 Forbidden.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

429

429 Too Many Requests.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

operationId agent_claims.lookup