Converse Stream

POST

/converse/stream

Converse

NB Use this endpoint to get a streaming response | response type: text/event-stream

This endpoint enables users to engage in a conversation with i-Claim.
This endpoint can also be used to get information (ICD codes, Tariff Codes), review claims further, information
on processing claims.

Beta: Not ready for production

Request Parameters Information

NB: This should be provided in JSON format eg [ {your json data goes here} ], provide full histroy of chat for
i-Claim to understand you.

Request

Body Params application/json

array of:

role

enum<string>

Role

required

Used to determine conversation state. if role is system then this is a response sent by i-Claim else if its user then this is a request sent by the user

Allowed values:

usersystem

content

string

Content

required

contains response from system or request from user

Example

[
  {
    "role": "user",
    "content": "string"
  }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/converse/stream' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "role": "user",
        "content": "string"
    }
]'

Responses

🟢200OK

application/json

Successful Response

Body

No schema defined

Example

null

🟠422Parameter Error

Modified at 2024-12-07 17:10:47

Converse General

Get Schema