Agent Personas

Draft a persona from the setup answers

Changed on

Returns the builtin tools the answers call for, and a name, description and system prompt written for them with the persona draft model. Saves nothing: create the persona with POST /personas. 403 when the answers call for a tool the caller's tier may not use; 502 when the model returns nothing usable.

post/api/v0/agent/personas/draft

Request

Request body

takes_filesboolean required

People drop files into the chat for it to work on.

sourcesstring[]

What else it reads: knowledge-base documents, drawings, a knowledge graph, or a system connected over MCP.

records_factsboolean

It may write entities, relations and facts back to the knowledge graph. Ignored unless sources holds knowledge_graph.

deliverable'chat' | 'filled_file' | 'new_file' | 'notebook' required

What it hands back: an answer in the chat, the file it was given filled in, a new spreadsheet or document, or a notebook.

value_source'page' | 'lookup' required

page: every value is read off the page or file itself; lookup: a retrieved answer is enough.

delegatesboolean

It may hand work to other personas.

answer_language'user' | 'en' | 'ja' required

The language the persona answers in: user means whatever language the person writes in.

locale'en' | 'ja' required

The UI language of the person creating the persona. The name, description and prompt are written in answer_language, or in this when answer_language is user.

briefstring

The job, in the person's own words.

Response

Successful Response

namestring required

The suggested name.

descriptionstring required

The suggested description.

promptstring required

The suggested system prompt.

builtin_tool_idsstring[] required

The builtin tools the answers call for.

is_roamingboolean required

True iff one of those tools requires a workspace.

Changes