{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/api-reference/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"redocly_category":"API Reference","searchWeight":120,"type":"markdown"},"seo":{"title":"Auto model","description":"Complete API reference and documentation for Freddy AI-powered backend system by Aitronos","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"auto-model","__idx":0},"children":["Auto model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Auto picks the model, the reasoning effort and the speed tier for every message sent with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["model: \"auto\""]},", inside the rules an organisation sets. These endpoints read and change those rules, show who gets what, preview a rule, hold each person's own priority, explain a single reply's pick, and report what Auto spent."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Read ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/documentation/core-concepts/auto-model"},"children":["Auto Model"]}," first: it explains the layers (organisation, departments, assistant, person, chat), what \"enforced\" and \"people can choose\" mean, and how a pick is made."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"availability","__idx":1},"children":["Availability"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every endpoint here sits behind the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auto_model"]}," feature switch. While it is off for the caller's organisation, each one answers ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}," with code ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_MODEL_NOT_ENABLED"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error.details.feature"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auto_model"]},"), so a client can hide the feature instead of treating it as a wrong address. Key on the code, not the message."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organisation is the one in the path where there is one; otherwise the request's current organisation (the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Organization-Id"]}," header, or the token's organisation)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"endpoints","__idx":2},"children":["Endpoints"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"rules-organisation-admins-assistant-editors","__idx":3},"children":["Rules (organisation admins, assistant editors)"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/auto-model/list-rules"},"children":["List Auto model rules"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/organizations/{organization_id}/auto-model/rules"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/auto-model/get-rule"},"children":["Get an Auto model rule"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/organizations/{organization_id}/auto-model/rules/{scope_type}/{scope_id}"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/auto-model/update-rule"},"children":["Create or replace an Auto model rule"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /v1/organizations/{organization_id}/auto-model/rules/{scope_type}/{scope_id}"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/auto-model/reset-rule"},"children":["Delete an Auto model rule"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /v1/organizations/{organization_id}/auto-model/rules/{scope_type}/{scope_id}"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/auto-model/simulate"},"children":["Preview an Auto model rule"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/organizations/{organization_id}/auto-model/simulate"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/auto-model/get-effective-settings"},"children":["Check who gets what"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/organizations/{organization_id}/auto-model/effective"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/assets/set-primary-department.6fcb4d3279c9dca14f79a0f3a84dda0ad07ff85db955150a3d01388050bbd9d1.31e6e729.md"},"children":["Set a member's primary department"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /v1/organizations/{organization_id}/members/{user_id}/primary-department"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"people","__idx":4},"children":["People"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/auto-model/get-catalog"},"children":["Get the Auto model option catalogue"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/auto-model/catalog"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/auto-model/get-my-choice"},"children":["Get my Auto priority"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/users/me/auto-model"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/auto-model/set-my-choice"},"children":["Set my Auto priority"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /v1/users/me/auto-model"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/threads/get-message-route"},"children":["Get why Auto picked a reply's model"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/threads/{thread_id}/messages/{message_id}/route"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"analytics","__idx":5},"children":["Analytics"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/auto-model/analytics"},"children":["Get Auto model analytics"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/analytics/auto-model/{org_id}"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"in-other-endpoints","__idx":6},"children":["In other endpoints"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/responses/create"},"children":["Create a response"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["model: \"auto\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auto_choice"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auto_retry"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/objects/streaming-event-object"},"children":["Streaming events"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["response.model_selected"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/threads/update-per-thread-user-state"},"children":["Update per-thread user state"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auto_choice"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/models/list"},"children":["List models"]}," — the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auto"]}," entry"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"objects","__idx":7},"children":["Objects"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/objects/auto-model-rule-object"},"children":["Auto model rule object"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/objects/auto-model-route-object"},"children":["Auto model route object"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-codes","__idx":8},"children":["Error codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Code"},"children":["Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP"},"children":["HTTP"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When"},"children":["When"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_MODEL_NOT_ENABLED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Auto is not switched on for the organisation"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_MODEL_SCOPE_NOT_FOUND"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The department, assistant or person is not in the organisation"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_MODEL_RULE_INVALID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["422"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A rule's settings fail validation; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details.field"]}," names the setting"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_MODEL_MODEL_NOT_ALLOWED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["422"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A picked model the organisation or assistant does not allow; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details.models"]}," lists them"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_MODEL_EFFORT_RANGE_EMPTY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["422"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The effort range does not overlap the inherited one"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_MODEL_LOOSENS_ENFORCED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["403"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An assistant editor tries to loosen an enforced limit or lock; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details.locked_by"]}," names the layer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_MODEL_CHOICE_LOCKED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["409"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A person's or chat's priority while a rule decides it; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details.locked_by"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details.reason"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_MODEL_PRIMARY_DEPARTMENT_INVALID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["422"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The member is not in that department"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_MODEL_POOL_EMPTY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["422"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A turn with no model left; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details.rule"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details.why"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_MODEL_ROUTE_NOT_FOUND"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No Auto choice is recorded for that message (or it expired after 90 days)"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Another organisation in the path answers the platform's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 ORGANIZATION_ACCESS_DENIED"]},", the same as every organisation endpoint."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-resources","__idx":9},"children":["Related Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/documentation/core-concepts/auto-model"},"children":["Auto Model concept"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/models/list"},"children":["List models"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/responses/create"},"children":["Create a response"]}]}]}]},"headings":[{"value":"Auto model","id":"auto-model","depth":1},{"value":"Availability","id":"availability","depth":2},{"value":"Endpoints","id":"endpoints","depth":2},{"value":"Rules (organisation admins, assistant editors)","id":"rules-organisation-admins-assistant-editors","depth":3},{"value":"People","id":"people","depth":3},{"value":"Analytics","id":"analytics","depth":3},{"value":"In other endpoints","id":"in-other-endpoints","depth":3},{"value":"Objects","id":"objects","depth":2},{"value":"Error codes","id":"error-codes","depth":2},{"value":"Related Resources","id":"related-resources","depth":2}],"frontmatter":{"title":"Auto model","seo":{"title":"Auto model"}},"lastModified":"2026-10-28T03:16:48.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/api-reference/auto-model/introduction","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}