Get the dashboard session · SocialTap API reference

The signed-in person and account of the session cookie.

Auth: the dashboard session cookie.

Example

cURL

curl 'https://socialtap.dev/v1/session' \
  -H "x-api-key: $SOCIALTAP_API_KEY"

Authorizations

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

Response

application/json

200

Get the dashboard session

dataobject

Show 14 child fields

account_idstring

The account this session acts on: the one x-account-id named, else the person's own.

accountsobject[]

Every account the signed-in person belongs to, their own first, then by when they joined: send one's account_id as x-account-id to act on it.

Show 6 child fields

account_idstring

The account (acct_…): send it as x-account-id to act on it.

deletes_atstring date-timenullable

When the account is deleted for good, RFC 3339 UTC: its owner asked to delete it, and starting the dashboard on it (POST /v1/session with x-account-id) cancels that. null when it isn't being deleted.

joined_atstring date-time

When they joined it, RFC 3339 UTC.

objectstring

Always account_membership.

One ofaccount_membership

owner_emailstring

Its owner's address, which names it.

rolestring

The person's role in it.

One ofowneradminmember

activated_key_idsstring[]

IDs of the agent's pending live keys this call activated (agent_token); [] otherwise.

credits_grantedinteger

Free credits this call granted (once per account); 0 otherwise.

deletion_canceled_atstring date-timenullable

When signing in last canceled this account's scheduled deletion (its API keys stayed revoked: create new ones), RFC 3339 UTC; null when it never was.

emailstring

The signed-in person's verified email address.

expires_atstring date-time

When the session ends, RFC 3339 UTC.

free_credits_skippedstringnullable

Why the account this session acts on has no free credits (Account.free_credits_skipped), for its owner; null otherwise.

One ofdisposable_addressdomain_daily_limitnetwork_daily_limitmailbox_used

fresh_untilstring date-time

Until when this session may create API keys and change keys without re-verifying (password or two-factor code), RFC 3339 UTC.

new_api_keysobject[]

Keys this call created, with their secrets shown only here (a new account's first key, the first time its dashboard starts); [] otherwise.

Show 17 child fields

created_atstring date-time

When the key was created, RFC 3339 UTC.

created_by_keystringnullable

The API key (key_…) that last created this key, gave it the admin scope or rotated it: revoking that key also revokes this one if this one has admin. Null when none did, or a person has rotated it in the dashboard since.

created_by_userstringnullable

The person (GET /v1/members user_id) who created this key in the dashboard, or whose key created it. They may have left the account since. Null when no person did (an operator, or a key from before this was recorded).

dashboardboolean

true for the account's built-in dashboard key: the dashboard's playground runs as it (so its requests are logged, counted and billed like any key's). Nobody holds its secret, so it works only from the signed-in dashboard. Only its spend_limit can be changed (to cap what the playground spends live); renaming, rescoping, restricting, rotating or revoking it is forbidden (details.reason dashboard_key). It is made on first use and revoked with the account.

expires_atstring date-timenullable

When the key stops working, RFC 3339 UTC; null when it never expires.

idstring

Key ID (key_…): manage the key with it. It is not the secret.

ip_allowliststring[]

IP addresses or CIDR ranges (IPv4 or IPv6) the key works from; [] = any.

last_used_atstring date-timenullable

About when the key was last used (updated at most hourly); null when never.

namestring

Your label for the key.

objectstring

Always api_key.

One ofapi_key

prefixstring

The secret's first characters, to recognize it.

previous_secret_expires_atstring date-timenullable

Until then the secret this key had before its last rotation works too (rotate_secret), RFC 3339 UTC; null when none does.

revoked_atstring date-timenullable

When the key was revoked; null while it is not.

scopesstring[]

What the key may call: endpoints (data endpoints), jobs (create, read and cancel jobs; includes jobs:read), jobs:read (read jobs and their results), account:read (account, usage, ledger, keys), admin (account settings and key management; includes account:read).

One ofendpointsjobsjobs:readaccount:readadmin

secretstring

The key itself: send it in the x-api-key header. Shown only once: store it now.

spend_limitobjectnullable

The key's spend limit and what it used this interval; null when the key has none.

statusstring

pending: created by an agent signup and waiting for the owner's email confirmation (it can only read GET /v1/account). expired: past expires_at.

One ofactivependingexpiredrevoked

objectstring

Always session.

One ofsession

rolestring

The signed-in person's role in this account (account_id): what the dashboard lets them do here.

One ofowneradminmember

setup_requiredboolean

Whether POST /v1/session still has this account's setting up to do: a new account's first key (its secret in its answer, once), or the decision on an agent-made account. False in POST /v1/session's own answer once it has done it.

two_factor_enabledboolean

Whether the signed-in person has two-factor authentication on.

metaobject

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

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 session.get