Generate Text Response

Blocks and returns a text response for a given assistant and prompt.

You can find your assistant ID and version under: Assistant > Advanced.

Using the home alias: When authenticating with an act-as-user API key
you can pass home as the assistant_id to automatically resolve the calling
user's personal home assistant. In that case pass 1 for version — the
current published version is always used regardless of the value supplied.

Path Params
string
required

The assistant ID (KSUID) to target. You can find this under Assistant > Advanced. When using an "act as user" API key you may also pass the special value home to target the calling user's personal home agent.

integer
required
≥ 1

The published version of the assistant to use. When assistant_id is home the version is ignored and the current published version is used automatically — pass 1.

Body Params
string
required
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json