Skip to main content
POST
Read one prompt field's full text

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tenant
string
required

Tenant whose agents you are managing. Discover the tenants your credentials cover with listMyClaudiaProjects. A tenant your credentials do not cover is indistinguishable from one that does not exist.

id
string
required

Assistant to operate on, as returned by listAssistants (assistant_id field).

Query Parameters

role
enum<string>
required

Deployment the assistant lives in: supervisor (orchestrator agents) or react (specialist agents), plus qna for knowledge-base Q&A agents. Read them with that role; they are CREATED through proposeAssistantCreate as deployment: react with graphId: qna_agent, and the platform derives the qna role from the graph. listAssistants returns it as deployment_role on each row — pass that value back here verbatim.

Available options:
supervisor,
react,
qna

Body

application/json

Which field to read, in full.

path
string
required

Field to read: config.<key> for a config value — the same keys getAssistant stubs out, e.g. config.system_prompt, config.tone_of_voice_prompt, or any other config.<key> ending in _prompt — or the top-level name/description.

Example:

"config.system_prompt"

Response

The field's full text.

The full text of one field.

path
string
required

The path this text came from, echoed back.

Example:

"config.system_prompt"

text
string
required

The field's full value, verbatim.

length
integer<int32>
required

Character count of text.

Example:

4213