Run Prompt (SSE Streaming)

post

https://api.hyperleap.ai/prompts/sse

Run a specific prompt based on the Prompt ID and Prompt Version ID passed in. The results will be streamed using SSE. Not recommended when creating classifiers to make decisions, since full response is not available for decision making.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

A prompt run request consisting of the prompt, specific version (if any) to be run. Replacements are required if the prompt demands.

Request model for running a prompt

promptId

uuid

required

The ID of the Prompt to run. If no version is specified, the default version is used.

promptVersionId

uuid | null

The Version ID of the Prompt to run

replacements

object | null

The replacements to use when running the prompt. These replacements are used if there are variables that need to be replaced in the prompt text at run time.

Headers

x-hl-api-key

string

required

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

500

Server Error

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success

400Bad Request