Models I can choose

GET

/models

const url = 'https://api.asklucy.eu/v1/models';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://api.asklucy.eu/v1/models \
  --header 'Authorization: Bearer <token>'

The models the caller may pick for their conversations. can_choose is false, with no models, when the organization doesn’t let them choose any: answers then use Auto. requestable are the models the organization offers to selected people and groups that the caller doesn’t have: they can ask for them (POST /me/requests).

Authorizations

zitadel

Responses

200

application/json

object

can_choose

required

boolean

models

required

Cheapest tier first.

Array<object>

object

required

string

label

required

string

description

required

string

vision

required

Reads images.

boolean

tools

required

Uses tools (the sandbox, memory, files on your computer).

boolean

context_tokens

required

How long a conversation it can read at once, in tokens.

integer

cost_tier

required

How fast it uses your limits, from 1 (slowest) to 3.

integer

>= 1 <= 3

requestable

required

Models the organization offers to selected people and groups that you don’t have; you can ask for them. Cheapest tier first.

Array

object

required

string

label

required

string

description

required

string

vision

required

Reads images.

boolean

tools

required

Uses tools (the sandbox, memory, files on your computer).

boolean

context_tokens

required

How long a conversation it can read at once, in tokens.

integer

cost_tier

required

How fast it uses your limits, from 1 (slowest) to 3.

integer

>= 1 <= 3

request

required

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

Example

{
  "models": [
    {
      "id": "mistral-large-4-0",
      "label": "Mistral Large",
      "description": "Most capable"
    }
  ],
  "requestable": [
    {
      "id": "mistral-large-4-0",
      "label": "Mistral Large",
      "description": "Most capable",
      "request": {
        "status": "pending"
      }
    }
  ]
}

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.