Quotas

Overview

Quotas define the maximum number of job inputs a user, team, or project can submit. They are a limit set at the API Key’s level within a given date range or a period (hourly, daily, weekly, monthly, or yearly).

📘

If the job submission uses a team key, the quota process accumulates an input usage at user and project levels (if they exist).

If the job submission uses a project key, the quota process accumulates an input usage at team and project levels only.

Quota accumulation takes effect immediately when the endpoint submits a job. Modzy credits the input usage back (subtract from the accumulated value) when an input fails or the user submits a job cancelation.

The quota object

JSON

{
    "identifier": "...",
    "user": "...",
    "project": "...",
    "team": "...",
    "from": "...",
    "to": "...",
    "period": "...",
    "quota": 1234,
    "used": 1234
}

Parameters	Type	Description
identifier	string	The quota’s identifier.
user, project, team	string	Identifier linked to the user, project, or team that has the quota. Only one of them is provided.
from	string	Start date/time of the period to which the quota is applied in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.
to	string	End date/time of the period to which the quota is applied in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.
period	string	Defines the period considered for quota usage count. It can be null, hourly, daily, weekly, monthly, or yearly.
quota	number	Maximum number of job inputs a user, team, or project can submit in the date range.
used	number	Amount of job inputs submitted by a user, team, or project in the quota date range.