Section ID:
DOC-API-MODEL-schema-1ga4tjqqg1#overview
ModelRoutingFilter
ModelRoutingFilter defines metadata-based criteria for filtering model candidates. All filters are ANDed — a model must pass every specified filter.
Unset or zero fields do not filter that dimension. Unknown maximum-output metadata currently passes a minimum-output filter, while an empty modality list fails a required-modality check. A passing metadata check is not proof the provider will honor the eventual request.
maxPromptCost and maxCompletionCost compare per-token catalog prices; unknown/unparseable prices currently pass. They do not cap total tokens, tool costs, retries or aggregate provider spend. Before sending paid traffic, confirm which spending limits are actually enforced for your account. Metadata-based capability filters also do not prove that a provider will honor a parameter on the eventual request.
Type-reference view: API Schema 9frhv4euve, API Schema 9ftjkkjhfa. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#request-field-mincontextlengthminContextLength | string (int64) | Optional | Minimum context window (tokens). Models below this are excluded. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#request-field-minmaxcompletiontokensminMaxCompletionTokens | string (int64) | Optional | Minimum max completion tokens. Models below this are excluded. Models reporting 0 (unknown) pass through (permissive). Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#request-field-requiredinputmodalitiesrequiredInputModalities | Array of string | Optional | Required input modalities (e.g., ["image", "audio"]). Model must support ALL listed. Models with empty input_modalities are filtered out (strict). |
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#request-field-requiredoutputmodalitiesrequiredOutputModalities | Array of string | Optional | Required output modalities (e.g., ["image"]). Model must support ALL listed. Models with empty output_modalities are filtered out (strict). |
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#request-field-maxpromptcostmaxPromptCost | number (double) or string (NaN, Infinity, -Infinity) | Optional | Maximum cost per prompt token (e.g., 0.000003). 0 = no limit. Unparseable pricing strings pass through (permissive). |
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#request-field-maxcompletioncostmaxCompletionCost | number (double) or string (NaN, Infinity, -Infinity) | Optional | Maximum cost per completion token. 0 = no limit. Unparseable pricing strings pass through (permissive). |
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#request-field-excludemoderatedexcludeModerated | boolean | Optional | Exclude models with content moderation enabled. |
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#request-field-requiredparametersrequiredParameters | Array of string | Optional | Required supported parameters (e.g., ["tools", "response_format"]). Model must support ALL listed. |
In responses
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#field-mincontextlengthSection ID: DOC-API-MODEL-schema-1ga4tjqqg1#response-field-mincontextlengthminContextLength | string (int64) | Optional | Minimum context window (tokens). Models below this are excluded. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#field-minmaxcompletiontokensSection ID: DOC-API-MODEL-schema-1ga4tjqqg1#response-field-minmaxcompletiontokensminMaxCompletionTokens | string (int64) | Optional | Minimum max completion tokens. Models below this are excluded. Models reporting 0 (unknown) pass through (permissive). Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#field-requiredinputmodalitiesSection ID: DOC-API-MODEL-schema-1ga4tjqqg1#response-field-requiredinputmodalitiesrequiredInputModalities | Array of string | Optional | Required input modalities (e.g., ["image", "audio"]). Model must support ALL listed. Models with empty input_modalities are filtered out (strict). |
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#field-requiredoutputmodalitiesSection ID: DOC-API-MODEL-schema-1ga4tjqqg1#response-field-requiredoutputmodalitiesrequiredOutputModalities | Array of string | Optional | Required output modalities (e.g., ["image"]). Model must support ALL listed. Models with empty output_modalities are filtered out (strict). |
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#field-maxpromptcostSection ID: DOC-API-MODEL-schema-1ga4tjqqg1#response-field-maxpromptcostmaxPromptCost | number (double) or string (NaN, Infinity, -Infinity) | Optional | Maximum cost per prompt token (e.g., 0.000003). 0 = no limit. Unparseable pricing strings pass through (permissive). |
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#field-maxcompletioncostSection ID: DOC-API-MODEL-schema-1ga4tjqqg1#response-field-maxcompletioncostmaxCompletionCost | number (double) or string (NaN, Infinity, -Infinity) | Optional | Maximum cost per completion token. 0 = no limit. Unparseable pricing strings pass through (permissive). |
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#field-excludemoderatedSection ID: DOC-API-MODEL-schema-1ga4tjqqg1#response-field-excludemoderatedexcludeModerated | boolean | Optional | Exclude models with content moderation enabled. |
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#field-requiredparametersSection ID: DOC-API-MODEL-schema-1ga4tjqqg1#response-field-requiredparametersrequiredParameters | Array of string | Optional | Required supported parameters (e.g., ["tools", "response_format"]). Model must support ALL listed. |
Where used
Section ID: DOC-API-MODEL-schema-1ga4tjqqg1#where-used
| Reference | Relationship |
|---|---|
| Create an agent profile | POST /api/v1/agent-profiles/create |
| Get an agent profile | POST /api/v1/agent-profiles/get |
| Import a prompt library | POST /api/v1/agent-profiles/import |
| List agent profiles | POST /api/v1/agent-profiles/list |
| Update an agent profile | POST /api/v1/agent-profiles/update |
| Withdraw your rating on a message | POST /api/v1/llm/delete-message-rating |
| Get full conversation state | POST /api/v1/llm/conversation-state |
| Rate an assistant message | POST /api/v1/llm/rate-message |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| Update context management settings | POST /api/v1/llm/update-context-management-settings |
| Update default generation config | POST /api/v1/llm/update-default-generation-config |
| Get the caller's end-user profile | POST /api/v1/enduser/get |
| Append a message without generating | POST /api/v1/llm/append-message |
| Create a new conversation thread | POST /api/v1/llm/create-thread |
| Send a message to a conversation | POST /api/v1/llm/send-message |
| Update the caller's default generation config | POST /api/v1/enduser/update-generation-config |
| ReceiveMessageRequest | API JSON uses JSON field names (camelCase). |
| ClientToolDispatch | API JSON uses JSON field names (camelCase). |
Models containing this value
| Model | Relationship |
|---|---|
| GenerationConfig | Nested in model |
| GenerationConfig | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1ga4tjqqg1