Update persona
Partially updates a workspace-level persona. System personas cannot be modified.
https://api.futureagi.com/simulate/api/personas/{persona_id}/ Authentication
Path parameters
The UUID of the persona to update. The persona must be a workspace-level (custom) persona that belongs to your organization. System (prebuilt) personas cannot be modified through this endpoint. You can retrieve persona IDs from the List personas endpoint.
Request body
A new name for the persona. Must be unique within your workspace and must not conflict with system persona names (case-insensitive comparison). Maximum 255 characters. Only the fields you include in the request body will be updated; omitted fields retain their current values.
An updated description explaining the persona’s role, behavior, and characteristics. Must be a non-empty string if provided.
Updated gender characteristics. Accepted values: male, female. Replaces the existing gender list entirely when provided.
Updated age range brackets. Accepted values: 18-25, 25-32, 32-40, 40-50, 50-60, 60+. Replaces the existing age group list entirely when provided.
Updated geographic locations. Accepted values: United States, Canada, United Kingdom, Australia, India. Replaces the existing location list entirely when provided.
Updated personality traits. Accepted values: Friendly and cooperative, Professional and formal, Cautious and skeptical, Impatient and direct, Detail-oriented, Easy-going, Anxious, Confident, Analytical, Emotional, Reserved, Talkative. Replaces the existing personality list entirely when provided.
Updated communication style descriptors. Accepted values: Direct and concise, Detailed and elaborate, Casual and friendly, Formal and polite, Technical, Simple and clear, Questioning, Assertive, Passive, Collaborative. Replaces the existing communication style list entirely when provided.
Updated accent options for voice simulations. Accepted values: American, Australian, Indian, Canadian, Neutral. Replaces the existing accent list entirely when provided.
Enables or disables multi-language support. When set to true, the language field must also be provided with at least one language.
Updated language options. Accepted values: English, Hindi. Required when multilingual is true.
Updated keywords or tags for the persona. Used for search and categorization in the dashboard. Replaces the existing keywords list entirely when provided.
Updated key-value metadata. Both keys and values must be non-empty strings. Replaces the existing custom properties object entirely when provided.
Updated free-form behavioral instructions passed to the simulation engine.
Updated tone setting. Accepted values: formal, casual, neutral.
Updated punctuation style. Accepted values: clean, minimal, expressive, erratic.
Updated slang usage level. Accepted values: none, moderate, heavy, light.
Updated typo frequency. Accepted values: none, rare, occasional, frequent.
Updated regional language mix level. Accepted values: none, moderate, heavy, light.
Updated emoji usage frequency. Accepted values: never, light, regular, heavy.
Updated response length preference. Accepted values: brief, balanced, detailed.
Response
200 OKIndicates the outcome of the request. Returns "success" when the persona is updated successfully.
The full updated persona object, including all current attribute values (both changed and unchanged fields), along with the id, persona_type, created_at, and updated_at timestamps reflecting the update.
Errors
The request payload contains invalid field values. This can occur when the name conflicts with an existing persona in your workspace or a system persona, when field values are outside the allowed choices, or when multilingual is true but language is missing. Review the response body for specific validation errors.
Authentication credentials were not provided or are invalid. Ensure that both X-Api-Key and X-Secret-Key headers are included in your request and contain valid, non-expired keys. Verify your API keys in the Dashboard under Settings.
The specified persona is a system-level (prebuilt) persona and cannot be modified. Only workspace-level personas created by your team can be updated through this endpoint. To customize a system persona, use the Duplicate persona endpoint to create a workspace-level copy first.
The persona with the specified UUID could not be found. Verify that the persona_id is correct and that the persona has not been deleted. You can retrieve valid persona IDs from the List personas endpoint.
An unexpected error occurred on the server while processing the request. This is not caused by your input. If this error persists, contact Future AGI support with the request details and timestamp for investigation.