Run Prompt (HTTP/2 Streaming)

POSThttps://api.hyperleapai.com/prompt-runs/async

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

Authenticated with your API key in the x-hl-api-key request header.

Request body

application/json

promptIdstring · uuidrequired

promptVersionIdstring · uuidnullable

objectnullable

JsonNode

streamboolean

Responses

400Bad Requestapplication/json

Array of ModelError

Exception

MethodBase

messageanytruncated

dataanytruncated

innerExceptionanytruncated

helpLinkanytruncated

sourceanytruncated

hResultanytruncated

stackTraceanytruncated

errorMessageanytruncated

Example payload

[
  {
    "exception": {
      "targetSite": {
        "memberType": 1,
        "name": "string",
        "declaringType": {
          "name": null,
          "customAttributes": null,
          "namespace": null,
          "assemblyQualifiedName": null,
          "fullName": null
        }
      }
    }
  }
]

[
  {
    "exception": {
      "targetSite": {
        "memberType": 1,
        "name": "string",
        "declaringType": {
          "name": null,
          "customAttributes": null,
          "namespace": null,
          "assemblyQualifiedName": null,
          "fullName": null
        }
      }
    }
  }
]

500Internal Server Error

No response body.

curl -X POST "https://api.hyperleapai.com/prompt-runs/async" \
  -H "x-hl-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "promptId": "string",
  "promptVersionId": "string",
  "replacements": {
    "key": {
      "options": {
        "propertyNameCaseInsensitive": true
      }
    }
  },
  "stream": true
}'

curl -X POST "https://api.hyperleapai.com/prompt-runs/async" \
  -H "x-hl-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "promptId": "string",
  "promptVersionId": "string",
  "replacements": {
    "key": {
      "options": {
        "propertyNameCaseInsensitive": true
      }
    }
  },
  "stream": true
}'

Request body

Responses

Explore Hyperleap AI