AI Models
The AI model catalog lists the language models an AI assistant can run on. It is global and read-only: use a model's id as ai_model_id when you create or update an AI assistant.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /ai-models | List AI models |
GET | /ai-models/:id | Get an AI model |
The catalog is the same for every organization. Creating, changing or deleting models is reserved to AchieveApex administrators.
The AI model object
json
Fields
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Use it as ai_model_id on assistants. |
provider | string | openai or openrouter. |
model_name | string | Provider model identifier. |
label | string | null | Display name. |
small_description | string | null | Short description. |
intelligence | integer | null | Intelligence rating, 1-5. |
reasoning | integer | null | Reasoning rating, 1-5. |
cost | integer | null | Cost-efficiency rating, 1-5 (5 = cheapest). |
speed | integer | null | Speed rating, 1-5. |
input_price_per_1m_tokens | number | Listed price per 1 million input tokens, in USD. |
output_price_per_1m_tokens | number | Listed price per 1 million output tokens, in USD. |
status | string | visible (shown in model pickers), not_visible_but_supported (hidden from model pickers but still supported) or not_supported. |
active_in_conversations | boolean | Available for conversation assistants. |
active_in_tickets | boolean | Available for support-ticket assistants. |
active_in_ai_chat | boolean | Available for ai-chat assistants. |
active_in_voice | boolean | Available for voice assistants. |
provider_metadata | object | null | Provider details such as context_length and architecture. Provider pricing is removed. |
created_at | string (date-time) | Read-only. Creation timestamp. |
updated_at | string (date-time) | Read-only. Last update timestamp. |
deleted_at | string (date-time) | null | Read-only. Always null in results. |
Pick a model whose status is visible and whose active_in_* flag matches the assistant type.
Related
Report an issue with this documentation
Please log in to report issues with our documentation.