Continue (SSE Streaming)

PATCHhttps://api.hyperleapai.com/conversations/{conversationId}/chat-sse

Send a user message and continue an existing Conversation. Streams response using SSE.

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

Path parameters

conversationIdstring · uuidrequired

Request body

application/json

messagestringrequired

Responses

200OKapplication/json

Streams Server-Sent Events. Each event arrives as a data: line holding one JSON chunk — read the response as a stream instead of awaiting a single body.

data: {"choice":{"finish_reason":"string","index":0,"message":{"role":"string","content":"string","toolCallId":"string","name":"string"},"moderation_results":{"categoryResults":[{"category":null,"severity":null}]}},"usage":{"prompt_tokens":0,"completion_tokens":0,"total_tokens":0},"messageId":"string","runId":"string","citations":[{"link":"string","index":"string","documentId":"string","fileId":"string","sourceContentType":"string","sourceName":"string","sourceUrl":"string","partitions":[{"text":null,"tags":null}]}]}

data: {"choice":{"finish_reason":"string","index":0,"message":{"role":"string","content":"string","toolCallId":"string","name":"string"},"moderation_results":{"categoryResults":[{"category":null,"severity":null}]}},"usage":{"prompt_tokens":0,"completion_tokens":0,"total_tokens":0},"messageId":"string","runId":"string","citations":[{"link":"string","index":"string","documentId":"string","fileId":"string","sourceContentType":"string","sourceName":"string","sourceUrl":"string","partitions":[{"text":null,"tags":null}]}]}

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 PATCH "https://api.hyperleapai.com/conversations/{conversationId}/chat-sse" \
  -H "x-hl-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "string"
}'

curl -X PATCH "https://api.hyperleapai.com/conversations/{conversationId}/chat-sse" \
  -H "x-hl-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "string"
}'

Path parameters

Request body

Responses

Explore Hyperleap AI