The signed-in person and account of the session cookie.
Auth: the dashboard session cookie.
Example
curl 'https://staging.socialtap.dev/v1/session' \
-H "x-api-key: $SOCIALTAP_API_KEY"Response
200
Get the dashboard session
| Field | Type | Description |
|---|---|---|
data | object | |
data.account_id | string | The signed-in account. |
data.activated_key_ids | string[] | IDs of the agent's pending live keys this call activated (agent_token); [] otherwise. |
data.credits_granted | integer | Free credits this call granted (once per account); 0 otherwise. |
data.email | string | The signed-in person's verified email address. |
data.expires_at | string (date-time) | When the session ends, RFC 3339 UTC. |
data.fresh_until | string (date-time) | Until when this session may create API keys and change keys without re-verifying (password or two-factor code), RFC 3339 UTC. |
data.new_api_keys | object[] | Keys this call created, with their secrets shown only here (a new account's live and test keys, the first time its dashboard starts); [] otherwise. |
data.new_api_keys[].created_at | string (date-time) | When the key was created, RFC 3339 UTC. |
data.new_api_keys[].expires_at | string (date-time) or null | When the key stops working, RFC 3339 UTC; null when it never expires. |
data.new_api_keys[].id | string | Key ID (key_…): manage the key with it. It is not the secret. |
data.new_api_keys[].ip_allowlist | string[] | IP addresses or CIDR ranges (IPv4 or IPv6) the key works from; [] = any. |
data.new_api_keys[].last_used_at | string (date-time) or null | About when the key was last used (updated at most hourly); null when never. |
data.new_api_keys[].mode | string | live keys spend credits on real requests; test keys answer from recorded responses, free. One of live, test |
data.new_api_keys[].name | string | Your label for the key. |
data.new_api_keys[].object | string | Always api_key. One of api_key |
data.new_api_keys[].prefix | string | The secret's first characters, to recognize it. |
data.new_api_keys[].revoked_at | string (date-time) or null | When the key was revoked; null while it is not. |
data.new_api_keys[].scopes | string[] | What the key may call: endpoints (data endpoints), jobs, account:read (account, usage, ledger, keys), admin (account settings and key management; includes account:read). One of endpoints, jobs, account:read, admin |
data.new_api_keys[].secret | string | The key itself: send it in the x-api-key header. Shown only once: store it now. |
data.new_api_keys[].spend_limit | object or null | The key's spend limit and what it used this interval; null when the key has none. |
data.new_api_keys[].status | string | 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 of active, pending, expired, revoked |
data.object | string | Always session. One of session |
data.two_factor_enabled | boolean | Whether the signed-in person has two-factor authentication on. |
meta | object | The shared route meta (see the API reference introduction). |
dataobjectShowHide 9 child fields
account_idstringThe signed-in account.
activated_key_idsstring[]IDs of the agent's pending live keys this call activated (agent_token); [] otherwise.
credits_grantedintegerFree credits this call granted (once per account); 0 otherwise.
emailstringThe signed-in person's verified email address.
expires_atstring date-timeWhen the session ends, RFC 3339 UTC.
fresh_untilstring date-timeUntil 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 live and test keys, the first time its dashboard starts); [] otherwise.
ShowHide 14 child fields
created_atstring date-timeWhen the key was created, RFC 3339 UTC.
expires_atstring date-timenullableWhen the key stops working, RFC 3339 UTC; null when it never expires.
idstringKey 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-timenullableAbout when the key was last used (updated at most hourly); null when never.
modestringlive keys spend credits on real requests; test keys answer from recorded responses, free.
One oflivetest
namestringYour label for the key.
objectstringAlways api_key.
One ofapi_key
prefixstringThe secret's first characters, to recognize it.
revoked_atstring date-timenullableWhen the key was revoked; null while it is not.
scopesstring[]What the key may call: endpoints (data endpoints), jobs, account:read (account, usage, ledger, keys), admin (account settings and key management; includes account:read).
One ofendpointsjobsaccount:readadmin
secretstringThe key itself: send it in the x-api-key header. Shown only once: store it now.
spend_limitobjectnullableThe key's spend limit and what it used this interval; null when the key has none.
statusstringpending: 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
objectstringAlways session.
One ofsession
two_factor_enabledbooleanWhether the signed-in person has two-factor authentication on.
metaobjectThe shared route meta (see the API reference introduction).
401
401 Unauthorized.
| Code | HTTP | Retry | Meaning | What to do |
|---|---|---|---|---|
unauthorized | 401 | No | The x-api-key header is missing, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired). | Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_url). |
unauthorizedNo retryThe x-api-key header is missing, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired).
Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_url).
403
403 Forbidden.
| Code | HTTP | Retry | Meaning | What to do |
|---|---|---|---|---|
forbidden | 403 | No | The API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include. A running job stops the same way 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): branch on the code. | Do what details.reason says: if suspended, contact support; otherwise use a key whose scopes cover the route (details.required_scope), have the owner confirm the emailed link, create a new key, or call from an allowed IP. |
forbiddenNo retryThe API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include. A running job stops the same way 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): branch on the code.
Do what details.reason says: if suspended, contact support; otherwise use a key whose scopes cover the route (details.required_scope), have the owner confirm the emailed link, create a new key, or call from an allowed IP.
429
429 Too Many Requests.
| Code | HTTP | Retry | Meaning | What to do |
|---|---|---|---|---|
rate_limited | 429 | Yes, later | The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead. | Wait for the number of seconds in the retry-after header, then retry; ask support to raise the ceiling if your sustained traffic needs more (calls without an API key: use one). |
rate_limitedYes, laterThe account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead.
Wait for the number of seconds in the retry-after header, then retry; ask support to raise the ceiling if your sustained traffic needs more (calls without an API key: use one).
operationId session.get