Account
Your company's account: who is calling, its keys, its caps, what it spent and the models it may use.
GET/v1/orgThe company account: name, status, the wallet in billed dollars, day and month caps, alert thresholds, allowed return URLs, allowed embed origins, default deployment.
Answers 20018 fields
idstringThe company account's id.
- Example
org_2f8k
object"org"Always org.
- Type
"org"
namestringThe company's name.
- Type
string
statusstringactive while the account works. Any other value means it is switched off, and calls answer 403 org_disabled.
- Type
string
mode"live" | "test"The mode these settings and this wallet belong to: live or test, the mode of the key in use.
- Type
"live" | "test"
allowed_return_urlsstring[]Where a connect link may send a person back to (return_url). Empty: no return URL is allowed.
- Type
string[]
allowed_embed_originsstring[]The https origins whose pages may show Bash in an iframe, and open a voice call.
- Type
string[]
default_deploymentstring | nullThe deployment a conversation runs when neither it nor its user names one; null: Bash as it comes, with no deployment of yours.
- Type
string | null
require_userbooleanWhen true, a request that names no user_id answers 400 user_required instead of reaching the company's own Bash.
- Type
boolean
memory_panelbooleanWhether a session may show the user what Bash remembers (POST /v1/sessions with memory: true). Off until you turn it on.
- Type
boolean
memory_mode"vestra" | "customer" | "none"Who keeps what Bash remembers about each user, unless a deployment says otherwise: vestra (Bash keeps it), customer (your side keeps it, at memory_endpoint) or none.
- Type
"vestra" | "customer" | "none"
memory_endpointstring | nullWith memory_mode: customer, the https URL Bash asks for what to remember about a user; null otherwise.
- Type
string | null
otlp_endpointstring | nullWhere Bash sends its traces, as OpenTelemetry (OTLP over HTTP); null: none are sent.
- Type
string | null
otlp_headers_secretstring | nullThe name of your secret that holds the headers sent with each trace; its value is never returned. Null: none.
- Type
string | null
balance_usdnumberThis mode's wallet, in billed US dollars, up to 5 decimals. Work stops with 402 wallet_empty when it runs out.
- Type
number
capsobjectThis mode's spending caps, for the company and per user, per day and per month.
org_daily_usdnumber | nullThe company's spending cap per day (UTC), in US dollars, across all its users; null: none, up to the account's ceiling.
- Limits
- 0 to 1000000.
user_daily_usdnumber | nullThe default cap per user per day (UTC), in US dollars; a user's own spend_cap_usd wins. Null: none.
- Limits
- 0 to 1000000.
max_org_daily_usdnumberThe highest the company's daily cap may be set, in US dollars. Ask Vestra to raise it.
- Limits
- 0 to 1000000.
org_monthly_usdnumber | nullThe company's cap per calendar month (UTC), in US dollars. Null (the default): none.
- Limits
- 0 to 1000000.
user_monthly_usdnumber | nullThe default cap per user per calendar month (UTC), in US dollars; a user's own monthly_cap_usd wins. Null (the default): none.
- Limits
- 0 to 1000000.
usage_alertsobjectWhen Bash tells your webhooks that spend is nearing a cap.
thresholdsinteger[]Percents of a cap at which usage.threshold_reached fires; reaching 100 always fires usage.cap_reached.
- Limits
- At most 5 items.
created_atstringWhen the account was made, as an ISO 8601 date and time in UTC.
- Type
string
No sample in your language for this route, so here it is over HTTP.
curl "$VESTRA_BASE_URL/v1/org" \ -H "Authorization: Bearer $VESTRA_API_KEY"