Models and tools

The model catalogue and the tool catalogue are the same for every user of the server. Use them to find the model_id to send to chat or to put on an assistant, and the tool names an assistant's tool list refers to.

Both endpoints return the whole catalogue in one response; there is no paging.

List models #

Returns the AI models known to the server, optionally only those of one type. The list is not personalised: every user gets the same catalogue, regardless of organization.

The list also contains models the administrators have switched off (is_enabled false) or retired (is_deprecated true). Chat refuses both (422 model is disabled / model is deprecated, see Chat); pick models with is_enabled true and is_deprecated false. The list is not sorted in any guaranteed order.

Concrete prices are not exposed. Use price_tier for a relative price indication, and conversation cost for what a conversation actually cost.

Request #

The body is required; send {} to get models of every type.

Response #

200 OK with an array of models.

Errors #

Authentication, rate limit and server errors are described in conventions.

Example #

curl -X POST "https://ayeto.ai/api/v3/ai_model/get_all" \
  -H "uni-api-key: $AYETO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model_type": "llm"}'

[
  {
    "id": "3f2a6c1e-8b4d-4e2a-9c7f-1d5e8a2b4c6d",
    "model_id": "example-chat-large",
    "model_type": "llm",
    "provider": "openai_responses",
    "display_name": "Example Chat Large",
    "description": "General purpose model for complex tasks.",
    "multilang_description": {
      "CZ": "Univerzální model pro složité úlohy.",
      "EN": "General purpose model for complex tasks."
    },
    "max_tokens": 32000,
    "max_reasoning_tokens": 0,
    "capabilities": ["chat", "stream", "assistant", "tools", "vision", "reasoning"],
    "use_system_prompt": true,
    "is_deprecated": false,
    "is_enabled": true,
    "is_beta": false,
    "price_tier": 3,
    "price_tier_max": 3,
    "auto_tiers": [],
    "is_new": false
  },
  {
    "id": "9a1b2c3d-4e5f-4061-8a7b-6c5d4e3f2a10",
    "model_id": "example-auto",
    "model_type": "llm",
    "provider": "openai_responses",
    "display_name": "Auto",
    "description": "Picks a suitable model for every message.",
    "multilang_description": {},
    "max_tokens": 16000,
    "max_reasoning_tokens": 0,
    "capabilities": ["chat", "stream", "assistant", "tools"],
    "use_system_prompt": true,
    "is_deprecated": false,
    "is_enabled": true,
    "is_beta": true,
    "price_tier": 1,
    "price_tier_max": 3,
    "auto_tiers": ["example-chat-mini", "example-chat-large"],
    "is_new": true
  }
]

Model #

Model types #

Only llm models can be used directly through this API (in chat and on assistants). The other types are listed so you can see what the server's tools use.

Capabilities #

Price tiers #

price_tier places the model on a scale from 1 (cheapest) to 4 (most expensive), based on its output price compared with fixed boundaries per model type:

The actual cost of using a model is charged in credits; see account.

Auto models #

An auto model is an llm model whose auto_tiers list is not empty. It does not answer by itself: for every message it picks one of the models in auto_tiers, a cheaper one for simple messages and a stronger one for demanding ones. Use its model_id like any other model. Its price_tier and price_tier_max span the cheapest and the most expensive of those models. Its capabilities are those that all of its tier models share, and its max_tokens is the smallest limit among them.

List tools #

Returns the AI tools an assistant may use. An assistant lists the tools it may use in ai_tools, by tool name.

The list leaves out tools that are not meant to be picked by hand (hidden helpers the server adds automatically where they are needed) and retired tools, so is_hidden and is_deprecated are always false in it. It includes tools that only work inside an organization (organization_only). Some tools also need a connected account (for example Google or Microsoft) or a paired desktop client to do anything.

display_name, description and category are translated to the language in the language request header (EN, CZ or FR; default EN).

Request #

No body is needed.

Response #

200 OK with an array of tools.

Errors #

This endpoint has no endpoint-specific errors. Authentication, rate limit and server errors are described in conventions.

Example #

curl -X POST "https://ayeto.ai/api/v3/ai_tool/get_all" \
  -H "uni-api-key: $AYETO_API_KEY" \
  -H "language: EN"

[
  {
    "name": "DownloadUrlFunctionTool",
    "display_name": "Download URL",
    "description": "Download content from a URL",
    "icon": "ayeto",
    "is_advanced": false,
    "is_hidden": false,
    "is_deprecated": false,
    "is_silent": false,
    "organization_only": false,
    "tags": ["download", "url", "web", "content", "internet"],
    "category": "Web service",
    "group": null,
    "in_default_assistant": true,
    "always": false,
    "companion_of_group": null,
    "order": 0
  },
  {
    "name": "AssistantMemoryFunctionTool",
    "display_name": "Assistant Memory",
    "description": "Manage the assistant's memory which persists across conversations. Use to store important information that the assistant should remember.",
    "icon": "ayeto",
    "is_advanced": false,
    "is_hidden": false,
    "is_deprecated": false,
    "is_silent": true,
    "organization_only": false,
    "tags": [],
    "category": "General",
    "group": null,
    "in_default_assistant": false,
    "always": false,
    "companion_of_group": null,
    "order": 0
  }
]

Tool #