DOC-API-MODEL-schema-1gkqaobt3t#overview
TimeAwareConfig
Configuration for time-aware LLM generation. Controls injection of temporal context (current time, message timestamps, file timestamps) into the LLM context during generation.
include_message_timestamps and include_file_timestamps default to false. The timezone is an IANA timezone name and defaults to UTC.
timestamp_format accepts empty text, friendly, iso8601 or date_only. The default friendly format includes a human-readable date, time and zone; iso8601 uses an ISO timestamp, and date_only includes only the date. An unrecognized value uses friendly formatting.
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-1gkqaobt3t#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#request-field-includecurrenttimeincludeCurrentTime | boolean | Optional | When enabled, include the current date and time in the per-turn volatile context attached to the current user message, using the configured timezone and timestamp format. |
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#request-field-includemessagetimestampsincludeMessageTimestamps | boolean | Optional | Include timestamps on messages in the model context to provide chronological context. Requires the message timestamp to be populated. Default: false. |
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#request-field-includefiletimestampsincludeFileTimestamps | boolean | Optional | Include upload/modification timestamps when resolving FILE_ID content. When true, resolved file references include "[Uploaded: <timestamp>]" annotations. Default: false |
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#request-field-timezonetimezone | string | Optional | Timezone for formatting (IANA format, e.g., "America/Los_Angeles"). Default: "UTC" Maximum length: 50. |
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#request-field-timestampformattimestampFormat | string (``, friendly, iso8601, date_only) | Optional | Format pattern for timestamps. "friendly" (default): "Jan 2, 2026 at 3:04 PM MST" "iso8601": "2026-01-02T15:04:00-08:00" "date_only": "2026-01-02" Maximum length: 50. |
Request validation
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#request-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
timezone | Maximum length | 50 |
timestampFormat | Maximum length | 50 |
timestampFormat | Allowed values | ``, friendly, iso8601, date_only |
In responses
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#field-includecurrenttimeSection ID: DOC-API-MODEL-schema-1gkqaobt3t#response-field-includecurrenttimeincludeCurrentTime | boolean | Optional | When enabled, include the current date and time in the per-turn volatile context attached to the current user message, using the configured timezone and timestamp format. |
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#field-includemessagetimestampsSection ID: DOC-API-MODEL-schema-1gkqaobt3t#response-field-includemessagetimestampsincludeMessageTimestamps | boolean | Optional | Include timestamps on messages in the model context to provide chronological context. Requires the message timestamp to be populated. Default: false. |
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#field-includefiletimestampsSection ID: DOC-API-MODEL-schema-1gkqaobt3t#response-field-includefiletimestampsincludeFileTimestamps | boolean | Optional | Include upload/modification timestamps when resolving FILE_ID content. When true, resolved file references include "[Uploaded: <timestamp>]" annotations. Default: false |
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#field-timezoneSection ID: DOC-API-MODEL-schema-1gkqaobt3t#response-field-timezonetimezone | string | Optional | Timezone for formatting (IANA format, e.g., "America/Los_Angeles"). Default: "UTC" |
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#field-timestampformatSection ID: DOC-API-MODEL-schema-1gkqaobt3t#response-field-timestampformattimestampFormat | string | Optional | Format pattern for timestamps. "friendly" (default): "Jan 2, 2026 at 3:04 PM MST" "iso8601": "2026-01-02T15:04:00-08:00" "date_only": "2026-01-02" |
DOC-API-MODEL-schema-1gkqaobt3t#validation
Request validation
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#response-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
timezone | Maximum length | 50 |
timestampFormat | Maximum length | 50 |
timestampFormat | Allowed values | ``, friendly, iso8601, date_only |
Where used
Section ID: DOC-API-MODEL-schema-1gkqaobt3t#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-1gkqaobt3t