Ask for a higher limit or a model

POST

/me/requests

const url = 'https://api.asklucy.eu/v1/me/requests';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"kind":"limit","window":"five_hours","model":"example","reason":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.asklucy.eu/v1/me/requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "kind": "limit", "window": "five_hours", "model": "example", "reason": "example" }'

limit: a window that limits you now (one with a limit at any level). model: a model your organization offers to selected people and groups (ModelList.requestable); 403 model-choice-off while the organization has model choice switched off. When the same request is already waiting, it is returned (200) rather than made again.

Authorizations

zitadel

Request Body^required

application/json

object

kind

required

string

Allowed values: limit model

window

Required for limit.

string

Allowed values: five_hours week month

model

Required for model, a model ID of ModelList.requestable.

string

reason

string | null

<= 500 characters

Responses

200

The same request was already waiting.

application/json

Something a member asked their admins for.

object

required

string

kind

required

string

Allowed values: limit model

user

required

object

required

Zitadel user ID.

string

name

required

string

email

string | null format: email

kind

service is a customer system’s Zitadel service user; agent is a service agent (its ID is the agt_ ID), the author of its runs’ messages.

string

Allowed values: person service agent

window

For limit, the window they want raised.

string

Allowed values: five_hours week month

model

For model, the model they want.

object

required

string

label

required

string

reason

required

Their words, for the admins.

string | null

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

decided_by

required

One of:

object
null

object

required

Zitadel user ID.

string

name

required

string

email

string | null format: email

kind

service is a customer system’s Zitadel service user; agent is a service agent (its ID is the agt_ ID), the author of its runs’ messages.

string

Allowed values: person service agent

note

required

What the admin who decided wrote back; the member sees it.

string | null

granted_limit

required

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

current

Admins only, for a waiting limit, the person’s window now.

object

window

required

string

Allowed values: five_hours week month

limit

required

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

spent

required

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

percent_used

number | null

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

source

required

Where this window’s limit comes from.

object

level

required

string

Allowed values: user_override group_override org_default none

group

One of:

object
null

object

required

string

name

required

string

source

required

Where the group and its members come from.

string

Allowed values: identity_provider

member_count

integer | null

Example

{
  "id": "req_4aB9cD2eF7gH1jK3mN5p",
  "kind": "limit",
  "user": {
    "kind": "person"
  },
  "window": "five_hours",
  "status": "pending",
  "decided_by": {
    "kind": "person"
  },
  "granted_limit": {
    "amount": "50.00",
    "currency": "EUR"
  },
  "current": {
    "window": "five_hours",
    "limit": {
      "amount": "50.00",
      "currency": "EUR"
    },
    "spent": {
      "amount": "50.00",
      "currency": "EUR"
    },
    "source": {
      "level": "user_override",
      "group": {
        "source": "identity_provider"
      }
    }
  }
}

201

Created

application/json

Something a member asked their admins for.

object

required

string

kind

required

string

Allowed values: limit model

user

required

object

required

Zitadel user ID.

string

name

required

string

email

string | null format: email

kind

service is a customer system’s Zitadel service user; agent is a service agent (its ID is the agt_ ID), the author of its runs’ messages.

string

Allowed values: person service agent

window

For limit, the window they want raised.

string

Allowed values: five_hours week month

model

For model, the model they want.

object

required

string

label

required

string

reason

required

Their words, for the admins.

string | null

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

decided_by

required

One of:

object
null

object

required

Zitadel user ID.

string

name

required

string

email

string | null format: email

kind

service is a customer system’s Zitadel service user; agent is a service agent (its ID is the agt_ ID), the author of its runs’ messages.

string

Allowed values: person service agent

note

required

What the admin who decided wrote back; the member sees it.

string | null

granted_limit

required

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

current

Admins only, for a waiting limit, the person’s window now.

object

window

required

string

Allowed values: five_hours week month

limit

required

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

spent

required

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

percent_used

number | null

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

source

required

Where this window’s limit comes from.

object

level

required

string

Allowed values: user_override group_override org_default none

group

One of:

object
null

object

required

string

name

required

string

source

required

Where the group and its members come from.

string

Allowed values: identity_provider

member_count

integer | null

Example

{
  "id": "req_4aB9cD2eF7gH1jK3mN5p",
  "kind": "limit",
  "user": {
    "kind": "person"
  },
  "window": "five_hours",
  "status": "pending",
  "decided_by": {
    "kind": "person"
  },
  "granted_limit": {
    "amount": "50.00",
    "currency": "EUR"
  },
  "current": {
    "window": "five_hours",
    "limit": {
      "amount": "50.00",
      "currency": "EUR"
    },
    "spent": {
      "amount": "50.00",
      "currency": "EUR"
    },
    "source": {
      "level": "user_override",
      "group": {
        "source": "identity_provider"
      }
    }
  }
}

400

The request is invalid; errors lists what’s wrong.

application/problem+json

RFC 9457 problem details.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

quota

For quota-exceeded, the window that is used up.

object

window

required

string

Allowed values: five_hours week month

percent_used

required

number

<= 100

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

limited_by

required

organization when the organization’s budget is closer to running out than the member’s own limit.

string

Allowed values: personal organization

request

One of:

object
null

A request as its member sees it, where they asked.

object

required

string

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

note

required

What the admin who decided wrote back.

string | null

errors

Field-level problems (400 only).

Array<object>

object

field

required

JSON pointer into the request body.

string

message

required

string

Example

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

X-Request-Id

string

Unique per request; quote it to support.

401

Missing, expired or invalid token.

application/problem+json

RFC 9457 problem details.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

quota

For quota-exceeded, the window that is used up.

object

window

required

string

Allowed values: five_hours week month

percent_used

required

number

<= 100

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

limited_by

required

organization when the organization’s budget is closer to running out than the member’s own limit.

string

Allowed values: personal organization

request

One of:

object
null

A request as its member sees it, where they asked.

object

required

string

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

note

required

What the admin who decided wrote back.

string | null

errors

Field-level problems (400 only).

Array<object>

object

field

required

JSON pointer into the request body.

string

message

required

string

Example

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

X-Request-Id

string

Unique per request; quote it to support.

403

The token is valid but lacks the role this needs.

application/problem+json

RFC 9457 problem details.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

quota

For quota-exceeded, the window that is used up.

object

window

required

string

Allowed values: five_hours week month

percent_used

required

number

<= 100

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

limited_by

required

organization when the organization’s budget is closer to running out than the member’s own limit.

string

Allowed values: personal organization

request

One of:

object
null

A request as its member sees it, where they asked.

object

required

string

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

note

required

What the admin who decided wrote back.

string | null

errors

Field-level problems (400 only).

Array<object>

object

field

required

JSON pointer into the request body.

string

message

required

string

Example

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

X-Request-Id

string

Unique per request; quote it to support.

Ask for a higher limit or a model

Authorizations

Request Bodyrequired

Responses

200

Example

201

Example

400

Example

Headers

401

Example

Headers

403

Example

Headers

Request Body^required