Account
Inspect your key, credit balance, usage, and prices.
Account endpoints return information about the account associated with the API key used to make the request. Use them to inspect the authenticating key and check the current credit balance. Use them also to read the credit usage history, and the credit price of each PBR action.
Returns the identity of the account associated with the API key and metadata about the API key used to authenticate the request.
API key created in the Marso Studio dashboard. The value has the form
mxr_live_<entropy> and is sent as a Bearer token in the Authorization
header.
Account identity and API key metadata.
Response from GET /account/me. Contains the account's identity and the
API key used to authenticate the request.
Unique identifier of the account.
Email address associated with the account.
This value is always free. Use subscription_plan_code and
subscription_plan_class for the current personal plan.
Opaque code for the personal subscription plan.
^plan_[A-Za-z0-9]{7,64}$Stable class of the personal subscription plan.
Opaque code for the assigned Organization seat plan.
^plan_[A-Za-z0-9]{7,64}$Stable class of the assigned Organization seat plan.
The API key is missing, invalid, or revoked. Possible error codes:
API_KEY_MISSING, API_KEY_INVALID, API_KEY_REVOKED, or UNAUTHORIZED.
Rate limit exceeded (RATE_LIMITED). The response includes a Retry-After
header with the number of seconds to wait before retrying, plus the
X-RateLimit-* headers. Those headers are also present on successful (2xx)
responses so a client can pace itself.
Account plan information is temporarily unavailable (SERVICE_UNAVAILABLE).
GET /api/public/v1/account/me HTTP/1.1
Host: api.marso.app/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"user_id": "text",
"email": "text",
"plan_tier": "text",
"subscription_plan_code": "text",
"subscription_plan_class": "free",
"organization_seat_plan_code": "text",
"organization_seat_plan_class": "free",
"effective_features": [
"commercial_license"
],
"api_key": {
"prefix": "text",
"label": "text",
"created_at": 1,
"last_used_at": null
}
}Returns the current credit balance for the account associated with the API key, including daily-free and paid credits. Organization pool balances are not exposed.
API key created in the Marso Studio dashboard. The value has the form
mxr_live_<entropy> and is sent as a Bearer token in the Authorization
header.
Credit balance.
Response from GET /account/credits. Contains the account's personal
credit balance. Organization pool balances are not exposed.
Sum of personal daily-free and paid credits. Does not include any organization pool balance.
Remaining personal daily-free credits.
Remaining personal paid credits.
Preferred billing source for the account.
Possible enum values:
personal: charges are applied to the account's personal credits.organization: charges are applied to the account's organization credits, if available.
Whether the account belongs to an organization. No organization identity or pool balance is exposed in this response.
The API key is missing, invalid, or revoked. Possible error codes:
API_KEY_MISSING, API_KEY_INVALID, API_KEY_REVOKED, or UNAUTHORIZED.
Rate limit exceeded (RATE_LIMITED). The response includes a Retry-After
header with the number of seconds to wait before retrying, plus the
X-RateLimit-* headers. Those headers are also present on successful (2xx)
responses so a client can pace itself.
Credit balance information is temporarily unavailable (SERVICE_UNAVAILABLE).
GET /api/public/v1/account/credits HTTP/1.1
Host: api.marso.app/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"total_credits": 1,
"daily_free_credits": 1,
"paid_credits": 1,
"billing_source": "personal",
"organization_member": true
}Returns credit consumption over a time range, grouped by UTC day. The from and to parameters are Unix millisecond timestamps; to must be greater than from, and the requested window must be 90 days or less.
API key created in the Marso Studio dashboard. The value has the form
mxr_live_<entropy> and is sent as a Bearer token in the Authorization
header.
Time represented as milliseconds since the Unix epoch.
Time represented as milliseconds since the Unix epoch.
Aggregated credit usage.
Response from GET /account/usage. Contains credit consumption over the
requested time range, grouped by UTC day.
Total credits consumed across all days in the requested window.
Missing or invalid from/to, to not after from, or window exceeds 90 days (INVALID_REQUEST).
The API key is missing, invalid, or revoked. Possible error codes:
API_KEY_MISSING, API_KEY_INVALID, API_KEY_REVOKED, or UNAUTHORIZED.
Rate limit exceeded (RATE_LIMITED). The response includes a Retry-After
header with the number of seconds to wait before retrying, plus the
X-RateLimit-* headers. Those headers are also present on successful (2xx)
responses so a client can pace itself.
Credit usage information is temporarily unavailable (SERVICE_UNAVAILABLE).
GET /api/public/v1/account/usage?from=1&to=1 HTTP/1.1
Host: api.marso.app/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"total_credits": 1,
"buckets": [
{
"date": "text",
"credits": 1
}
]
}Returns the credit price of every PBR generation action this API can charge, for the account associated with the API key. Prices are per action. A single submit costs the same as one item of the matching batch. To price a batch, multiply its per-item price by the number of items.
Prices can differ between accounts. Read this endpoint instead of storing an amount.
Each price appears under 2 keys. Read the current key, such as mesh_to_pbr. The contract marks the api_-prefixed key beside it as deprecated, and that key carries the same number.
API key created in the Marso Studio dashboard. The value has the form
mxr_live_<entropy> and is sent as a Bearer token in the Authorization
header.
PBR credit prices for the account.
Response from GET /pricing. Contains the PBR credit prices that apply
to the account associated with the API key.
Identifier of the price set, for example standard-v3. Include this
value when you report a question about a charge.
The API key is missing, invalid, or revoked. Possible error codes:
API_KEY_MISSING, API_KEY_INVALID, API_KEY_REVOKED, or UNAUTHORIZED.
Rate limit exceeded (RATE_LIMITED). The response includes a Retry-After
header with the number of seconds to wait before retrying, plus the
X-RateLimit-* headers. Those headers are also present on successful (2xx)
responses so a client can pace itself.
Price information is temporarily unavailable, or an action has no
price (SERVICE_UNAVAILABLE).
GET /api/public/v1/pricing HTTP/1.1
Host: api.marso.app/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"pricing_catalogue_id": "text",
"execution_costs": {
"mesh_to_pbr": 1,
"image_to_pbr": 1,
"mesh_to_pbr_batch_item": 1,
"image_to_pbr_batch_item": 1
}
}Last updated