Skip to main content

FileResolutionConfig

Configuration for resolving CONTENT_PART_TYPE_FILE_ID parts to fresh signed URLs before requests are sent to LLM providers. Keeps stable file references in message history while generating ephemeral URLs only when needed.

Omitting the file-resolution failure mode uses FILE_RESOLUTION_FAILURE_MODE_SKIP_CONTENT, which silently drops an unresolvable part. A resolved URL can also expire before a later attempt; a fresh URL on every attempt is not guaranteed. With FILE_RESOLUTION_FAILURE_MODE_FAIL_GENERATION, an unresolvable required part fails the run before the provider call. This can happen after asynchronous send acceptance; inspect the correlated run outcome rather than expecting the initial HTTP response to report the later failure. Verify that the report was actually available before presenting its summary.

Usage profiles​

UsageFields and validation
In requestsView fields
In responsesView fields
In webhook payloadsView fields

In requests​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
failureModestring (FILE_RESOLUTION_FAILURE_MODE_FAIL_GENERATION, FILE_RESOLUTION_FAILURE_MODE_SKIP_CONTENT) or integer (int32)OptionalAction to take when a file cannot be resolved. If omitted, skip unresolved file content and use the remaining content.

Values of failureMode​

How generation handles a content part whose file identifier cannot be resolved.

ValueNo.FormMeaning
FILE_RESOLUTION_FAILURE_MODE_FAIL_GENERATION1CanonicalFail generation when a file content part cannot be resolved.
FILE_RESOLUTION_FAILURE_MODE_SKIP_CONTENT2CanonicalSkip the unresolved content part and continue with the remaining content.

In responses​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
failureModestring (FILE_RESOLUTION_FAILURE_MODE_FAIL_GENERATION, FILE_RESOLUTION_FAILURE_MODE_SKIP_CONTENT) or integer (int32)OptionalAction to take when a file cannot be resolved. If omitted, skip unresolved file content and use the remaining content.

Values of failureMode​

How generation handles a content part whose file identifier cannot be resolved.

ValueNo.FormMeaning
FILE_RESOLUTION_FAILURE_MODE_FAIL_GENERATION1CanonicalFail generation when a file content part cannot be resolved.
FILE_RESOLUTION_FAILURE_MODE_SKIP_CONTENT2CanonicalSkip the unresolved content part and continue with the remaining content.

In webhook payloads​

Webhook JSON uses protobuf field names (snake_case).

FieldTypePresenceMeaning
failure_modestring (FILE_RESOLUTION_FAILURE_MODE_FAIL_GENERATION, FILE_RESOLUTION_FAILURE_MODE_SKIP_CONTENT) or integer (int32)OptionalAction to take when a file cannot be resolved. If omitted, skip unresolved file content and use the remaining content.

Values of failure_mode​

How generation handles a content part whose file identifier cannot be resolved.

ValueNo.FormMeaning
FILE_RESOLUTION_FAILURE_MODE_FAIL_GENERATION1CanonicalFail generation when a file content part cannot be resolved.
FILE_RESOLUTION_FAILURE_MODE_SKIP_CONTENT2CanonicalSkip the unresolved content part and continue with the remaining content.

Where used​

ReferenceRelationship
Create an agent profilePOST /api/v1/agent-profiles/create
Import a prompt libraryPOST /api/v1/agent-profiles/import
Update an agent profilePOST /api/v1/agent-profiles/update
Append a message without generatingPOST /api/v1/llm/append-message
Create a new conversation threadPOST /api/v1/llm/create-thread
Send a message to a conversationPOST /api/v1/llm/send-message
Send a message and wait for the resultPOST /api/v1/llm/send-message-sync
Update context management settingsPOST /api/v1/llm/update-context-management-settings
Update default generation configPOST /api/v1/llm/update-default-generation-config
Update the caller's default generation configPOST /api/v1/enduser/update-generation-config
Get an agent profilePOST /api/v1/agent-profiles/get
List agent profilesPOST /api/v1/agent-profiles/list
Withdraw your rating on a messagePOST /api/v1/llm/delete-message-rating
Get full conversation statePOST /api/v1/llm/conversation-state
Rate an assistant messagePOST /api/v1/llm/rate-message
Submit client-side tool results and wait for the next segmentPOST /api/v1/llm/submit-client-tool-results-sync
Get the caller's end-user profilePOST /api/v1/enduser/get
Generation configurationAPI JSON uses JSON field names (camelCase).
llm.generation_startedWebhook JSON uses protobuf field names (snake_case).
llm.message_publishedWebhook JSON uses protobuf field names (snake_case).
GenerationConfigNested in model
GenerationConfigNested in model
GenerationConfigNested in model

Download the public reference contract.

Document: DOC-API-MODEL-file-resolution-config.