Skip to Content

POST /persona/get

Get Persona

Get persona information using the canonical shared persona operation.

Request Body (GetPersonaApiRequest)

FieldTypeRequiredDescription
idstringNoUUID of the persona to retrieve
draft_idstringNoUUID of the draft to load instead of published state
snapshot_keystringNoCache snapshot key for consistent reads across related requests
namesapp__infra__persona__types__SectionFilterNoFilter options for names section
descriptionsapp__infra__persona__types__SectionFilterNoFilter options for descriptions section
colorsapp__infra__persona__types__SectionFilterNoFilter options for colors section
iconsapp__infra__persona__types__SectionFilterNoFilter options for icons section
instructionsapp__infra__persona__types__SectionFilterNoFilter options for instructions section
departmentsapp__infra__persona__types__SectionFilterNoFilter options for departments section
examplesapp__infra__persona__types__SectionFilterNoFilter options for examples section
parameter_fieldsapp__infra__persona__types__SectionFilterNoFilter options for parameter fields section
voicesapp__infra__persona__types__SectionFilterNoFilter options for voices section

Response (GetPersonaApiResponse)

FieldTypeRequiredDescription
actor_namestringNoDisplay name of the authenticated user
persona_existsbooleanNoWhether the requested persona exists
can_editbooleanNoWhether the current user has edit permission
disabled_reasonstringNoHuman-readable reason if editing is disabled
group_idstringNoGeneration group UUID for AI operations
draft_namestringNoImmutable draft label from the active draft entry, when a draft_id was supplied. None for non-draft fetches. The FE uses this to show the draft name in the SaveToolbar trigger.
show_ai_generatebooleanNoWhether AI generation is available
namesPersonaNameResource[]NoName resources with selected/suggested flags
descriptionsPersonaDescriptionResource[]NoDescription resources with selected/suggested flags
colorsPersonaColorResource[]NoColor resources with selected/suggested flags
iconsPersonaIconResource[]NoIcon resources with selected/suggested flags
instructionsPersonaInstructionResource[]NoInstruction resources with selected/suggested flags
flagsPersonaFlagResource[]NoFlag resources (one per flags_resource row, value=true/false)
departmentsPersonaDepartmentResource[]NoDepartment resources with selected/suggested flags
parameter_fieldsPersonaParameterFieldResource[]NoParameter field resources with selected/suggested flags
examplesPersonaExampleResource[]NoExample resources with selected/suggested flags
parametersany[]NoParameter resources
voicesPersonaVoiceResource[]NoVoice resources with selected/suggested flags
fieldsGetFieldResponse[]NoAll available field definitions (computed, never saved)
resolved_parameter_idsstring[]NoParameter IDs derived from saved parameter_fields
Last updated on