Account

Check your partner API rate limits, credit caps, and current usage.

post/v1/get_quota

Request

  • Base URL: https://partner.mindupload.app
  • URL: https://partner.mindupload.app/v1/get_quota
  • Auth: API key in header X-Partner-Key

Request body

preferred_languagestring nullable

BCP-47-ish language code (e.g. 'en', 'zh-cn') for localized messages.

usernamestring nullable

The end-user's username.

Response

Result envelope — check the success field.

successboolean

Whether the call succeeded.

error_messagestring nullable

Human-readable reason when success is false.

error_codestring
per_user_rate_limit_per_mininteger nullable

Requests allowed per minute for each of your end-users.

per_user_daily_credit_capinteger nullable

Credit-spending calls allowed per rolling 24h for each end-user.

partner_rate_limit_per_mininteger nullable

Account-wide requests/min ceiling across all your users; the platform default applies when none is configured for your account.

external_authorization_rate_limit_per_mininteger nullable

Same value as partner_rate_limit_per_min, which now covers every operation; kept for integrations that already read it.

partner_daily_credit_capinteger nullable

Optional account-wide credit-spending calls per rolling 24h; null means no aggregate limit.

max_usersinteger nullable

Maximum end-users you may register; null means unlimited.

registered_usersinteger nullable

How many end-users you have registered so far.

partner_requests_last_minuteinteger nullable

Your requests across all users in the last 60 seconds.

partner_credit_spends_last_dayinteger nullable

Your credit-spending calls across all users in the last 24 hours.

userstring nullable

The end-user that every user_... figure in this response is scoped to (echoes your request).

user_requests_last_minuteinteger nullable

This user's requests in the last 60 seconds (present only when you pass a username).

user_credit_spends_last_dayinteger nullable

This user's credit-spending calls in the last 24 hours (present only when you pass a username).

credit_spending_tasksstring[] nullable

Which operations count toward the credit-spend caps.

calls_enabledboolean nullable

Whether live calls are switched on for your account. When false, every call operation is refused and no call_... figure in this response applies.

call_minutes_cap_monthlyinteger nullable

Participant-minutes allowed per calendar month across both kinds of call. One participant-minute is one person connected for one minute, so a four-person call for ten minutes is forty. Null means no combined ceiling.

call_max_concurrent_sessionsinteger nullable

How many of your calls may be running at the same moment. Null means no ceiling on how many run at once.

call_voice_minutes_cap_monthlyinteger nullable

Participant-minutes of calls with no picture allowed per calendar month, on top of the combined ceiling rather than instead of it. Null means no separate ceiling on voice calls — the combined one still applies.

call_video_minutes_cap_monthlyinteger nullable

Participant-minutes of calls with a picture allowed per calendar month, on top of the combined ceiling rather than instead of it. Null means no separate ceiling on video calls. Running out of these does not stop you making voice calls.

call_voice_participant_minutes_this_monthnumber nullable

Participant-minutes of calls with no picture used this calendar month, including any still running.

call_video_participant_minutes_this_monthnumber nullable

Participant-minutes of calls with a picture used this calendar month, including any still running.

call_month_start_timestampinteger nullable

UNIX timestamp of the first second of the calendar month that every call_..._this_month figure is counted over.

call_sessions_this_monthinteger nullable

How many calls you have started this calendar month.

call_participant_minutes_this_monthnumber nullable

Participant-minutes you have used this calendar month across both kinds of call. Always call_voice_participant_minutes_this_month plus call_video_participant_minutes_this_month. Covers the calls still running as well as the ones that have finished, so it can rise while you read it; call_live_participant_minutes is how much of it is still being spent.

call_live_participant_minutesnumber nullable

How much of call_participant_minutes_this_month belongs to calls that have not finished. Measured from how long each has been running and how many people are in it, so it is an estimate until the call ends and the exact figure replaces it.

call_data_transferred_bytes_this_monthinteger nullable

Bytes of sound and picture moved by the calls we have measured this calendar month. Not every call is measured, so check call_data_transferred_is_complete before treating this as the month total.

call_data_transferred_is_completeboolean nullable

Whether call_data_transferred_bytes_this_month covers every call this month. When false, some calls are not counted in it.

call_live_sessionsinteger nullable

How many of your calls are running at this moment.

call_spending_tasksstring[] nullable

Which operations count toward the call allowances.

operation_duration_msnumber nullable

Server-side duration of the operation in milliseconds.

Changes

No recorded changes to this operation across all 2 revisions of this API.