Skip to Content
API ReferenceAttemptPOST /chat_get

POST /attempt/chat_get

Chat Get

Get hydrated resources for chat bundle customization.

Request Body (GetChatRequest)

FieldTypeRequiredDescription
idstringNoChat entry ID
chat_entry_idstringNoLegacy alias for the chat entry ID
attempt_idstringNoAttempt ID
draft_idstringNoDraft ID
snapshot_keystringNoCache snapshot key for consistent reads
namesapp__infra__attempt__chat__types__SectionFilterNo—
descriptionsapp__infra__attempt__chat__types__SectionFilterNo—
flagsapp__infra__attempt__chat__types__SectionFilterNo—
departmentsapp__infra__attempt__chat__types__SectionFilterNo—
personasapp__infra__attempt__chat__types__SectionFilterNo—
documentsapp__infra__attempt__chat__types__SectionFilterNo—
parameter_fieldsapp__infra__attempt__chat__types__SectionFilterNo—
scenariosapp__infra__attempt__chat__types__SectionFilterNo—
fieldsapp__infra__attempt__chat__types__SectionFilterNo—
questionsapp__infra__attempt__chat__types__SectionFilterNo—
optionsapp__infra__attempt__chat__types__SectionFilterNo—
videosapp__infra__attempt__chat__types__SectionFilterNo—
imagesapp__infra__attempt__chat__types__SectionFilterNo—
problem_statementsapp__infra__attempt__chat__types__SectionFilterNo—
objectivesapp__infra__attempt__chat__types__SectionFilterNo—

Response (GetChatResponse)

FieldTypeRequiredDescription
actor_namestringNoDisplay name of the authenticated user
chat_existsbooleanNoWhether the chat template exists
can_editbooleanNoWhether the current user can edit this draft
disabled_reasonstringNoHuman-readable reason if editing is disabled
group_idstringNoGroup ID for generation and draft correlation
show_ai_generatebooleanNoWhether AI generation is available
profile_has_accessbooleanNoCompatibility flag for current chat pages
simulation_namestringNoOptional simulation name for UI display
chat_entry_idstringNoChat entry ID
attempt_idstringNoAttempt ID
namesChatNameResource[]No—
descriptionsChatDescriptionResource[]No—
flagsChatFlagResource[]No—
departmentsChatDepartmentResource[]No—
personasChatPersonaResource[]No—
documentsChatDocumentResource[]No—
parameter_fieldsChatParameterFieldResource[]No—
scenariosChatScenarioResource[]No—
fieldsChatFieldResource[]No—
questionsChatQuestionResource[]No—
optionsChatOptionResource[]No—
videosChatVideoResource[]No—
imagesChatImageResource[]No—
problem_statementsChatProblemStatementResource[]No—
objectivesChatObjectiveResource[]No—
name_idsstring[]No—
description_idsstring[]No—
flag_idsstring[]No—
department_idsstring[]No—
persona_idsstring[]No—
document_idsstring[]No—
parameter_field_idsstring[]No—
scenario_idsstring[]No—
field_idsstring[]No—
question_idsstring[]No—
option_idsstring[]No—
video_idsstring[]No—
image_idsstring[]No—
problem_statement_idsstring[]No—
objective_idsstring[]No—
Last updated on