Reference

Changelog

Notable changes to the AYETO API.

View as Markdown

Changes that affect API clients are listed here, newest first. Additions that do not change existing behaviour (a new optional field, a new endpoint) are listed too, so you can see what became available.

2026-10-06

  • The model catalogue (/ai_model/get_all) has a new field is_recommended: models the administrators recommend.
  • The chat stream with runner_version "2" has a new status phase conversation_named (data.name): a new conversation is named from its first message while the first answer is generated, instead of after it. The name is stored when the event arrives.
  • find and count reject filters and sort_key on internal fields stored with a record (for example secrets) with 422; before, such conditions were accepted.

2026-10-05

  • Conversations have two new fields, booster_panel_id and panel_user_id: conversations of the signed-in users of your booster panels with your assistants. /conversation/find returns them with your other conversations (filter them out with ["panel_user_id", "==", null]); /chat answers 403 for them, only the panel user continues them.
  • Booster database records have a new field owner (UUID or null): the panel user who created the record, on panels with user accounts. find and count accept owner in filters and as sort_key. Records created through the API have owner: null. When a panel user account is deleted for good, the records it created are deleted too.
  • Collection rules have two new levels, user and owner. Like the other levels except none, they allow requests made through the API, on all records.
  • POST /ai_model/get_all can return models of the new type google_video_gen (video generation). Videos generated in chat are listed in attachments of the answer, like generated images.
  • In chat over the API, tool actions that the AYETO app lets the user confirm in the chat (for example creating a booster panel or a workflow from the chat) are refused: the tool call ends with an error and the model continues its answer.
  • POST /ai_tool/get_all lists two more tools, BoosterStudioStartFunctionTool (creates a booster panel from a template) and WorkflowStudioStartFunctionTool (creates a workflow). You can give them to your assistants; they need the user's confirmation in the chat of the AYETO app, so in chat over the API they are refused as described above.
  • Newly documented: POST /booster/panel/info, which returns a panel's name, its organization and the key's user, and checks access to the panel. The endpoint itself is unchanged.

2026-10-04

  • Tools returned by POST /ai_tool/get_all have a new field companion_of_groups (array of group names): like companion_of_group, for a helper tool that accompanies several groups.

2026-10-03

  • Tools returned by POST /ai_tool/get_all have two new fields: vision (the tool shows images to the model and is offered only with models that can see images) and outbound (the tool can send data outside AYETO, for example web requests or e-mail).
  • Malformed list queries are rejected with 422 and a clear detail instead of 500: a condition without 3 or 4 elements, a filters element that is neither an array nor an object, a group object with no key or several keys, an AND / OR group whose value is not a non-empty array, groups nested deeper than 32 levels, a negative limit_from, and a limit_to lower than limit_from.
  • 429 responses of the rate limiter have the body {"detail": "Too many requests"} like every other error (the reason key is gone); Retry-After is unchanged.
  • A missing API key scope is answered with 401 API key is invalid everywhere.
  • .../get and .../delete endpoints also accept the id in a JSON body {"id": "<uuid>"}; the entity_id query parameter still works. Neither, or two different ids, gives 422. A body sent to them must be JSON.
  • New POST /user_credit/get_self and POST /version (GET still works and shares the rate limit); /version is rate limited on the static tier (1,200 requests a minute).
  • POST /ai_tool/get_all no longer returns hidden or deprecated tools.
  • New POST /conversation/count (scope ayeto.conversation, same body as /conversation/find).
  • Conversation cost (POST /usage/cost/conversation) is the sum of the credits actually charged, not a repricing at current prices; it includes the text tokens of image models and no longer fails with 404 for models removed since.
  • Chat with a model that cannot stream stores the answer and returns it (before, the answer was lost and the response returned the user's message).
  • Chat attachments are checked and stored before anything else: an attachment refused with 422 (file is too large, a storage quota, invalid data) no longer leaves the user message behind. Malformed base64 returns 422 invalid base64 data in attachment '<filename>' (or invalid data URI in attachment '<filename>') instead of 500. The size field of attachments is no longer required and is ignored.
  • A chat follow-up to a conversation created in an organization runs in that organization when the request names none (charged there, membership required); naming a different organization returns 422 the conversation belongs to another organization. Another user's conversation is refused with 403 before any attachment is stored.
  • The structured chat stream (runner_version "2") no longer sends the unused iteration field.
  • Booster database: creating a record with a key that already exists returns 422 a record with key '<key>' already exists instead of 500; limit_from without limit_to returns up to 100 records from limit_from (limit_from must be lower than 1000); malformed AND / OR filters return 422 instead of 500.
  • Data loader: unsupported file types return 422 unsupported file type '<mime>' and are not charged.
  • Workflows: a file named by its id in the run input stays the user's and is no longer deleted with the run (files sent as base64 still belong to the run).

2026-10-02

  • Booster database collection rules apply only to panels in public database mode; in private mode they are ignored. Users a panel is shared with read-only can now write its records and take locks (in both modes).
  • POST /tts/mp3 requires the new ayeto.tts scope and POST /data-loader/load the new ayeto.data_loader scope. Existing API keys were given both scopes; keys created by pairing a desktop client (ayeto.connector only) can no longer call these endpoints.
  • POST /tts/mp3 and POST /data-loader/load accept an optional organization_id: the request runs in the organization and is charged to the user's credit there (admins and members only; guests and non-members get 403).
  • POST /tts/mp3 returns 422 with not enough user credit / not enough organization credit when the credit runs out, instead of 500 Failed to generate audio.
  • Chat refuses a model switched off by the administrators (requested directly or as the assistant's model) with 422 model is disabled, and an automatic model with no available model with 422 model is not available; model is deprecated is returned before the conversation is touched.
  • Reading another user's conversation with /conversation/get (refused with 404) no longer updates its accessed field.
  • The language header of an API request no longer changes the user's preferred language in the AYETO app (before, every request saved it, and a request without the header reset it to English).
  • POST /assistant/avatar/get accepts API keys with the new ayeto.assistant scope, which can now be selected when creating a key (it also covers /assistant/find).
  • New documentation of API v3, replacing the earlier beta notes.
  • Workflows are available on the API: reading, running, streaming runs, approvals, editing, publishing, export and import (ayeto.workflow, ayeto.workflow.write).
  • Private booster database API with its own scopes (ayeto.booster.database, ayeto.booster.database.write).