Continue (HTTP/2 Streaming)

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

Send a user message and continue an existing Conversation. Streams response using HTTP/2 (recommended).

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

GenAiChatChoice

finish_reasonstringnullable

indexinteger · int32

GenAiChatMessage

GenAiContentModerationResult

GenAiUsage

prompt_tokensinteger · int32

completion_tokensinteger · int32

total_tokensinteger · int32read-only

messageIdstring · uuid

runIdstring · uuid

Citation[]nullable

linkstringnullable

indexstringnullable

documentIdstringnullable

fileIdstringnullable

sourceContentTypestringnullable

sourceNamestringnullable

sourceUrlstringnullable

Partition[]nullable

Example payload

{
  "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
        }
      ]
    }
  ]
}

{
  "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-http2" \
  -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-http2" \
  -H "x-hl-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "string"
}'

Example response · 200

{
  "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
        }
      ]
    }
  ]
}

{
  "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
        }
      ]
    }
  ]
}

Path parameters

Request body

Responses

Explore Hyperleap AI