Start a conversation

POST

/v2/health-navigator/users/{userId}/conversations

curl --request POST \
  --url https://client-api.abi.ai/v2/health-navigator/users/abi1234/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "context": { "policy": "standard", "age": 30 } }'

• Abi Client API

Create a Health Navigator chat session for the user. Supply optional partner-approved context that matches the schema agreed for the configured journey; retain the returned conversation identifier for subsequent requests.

Authorizations

• bearerAuth

Parameters

Path Parameters

userId

required

string

The Abi identifier of the user account.

Example

abi1234

Request Body^required

Media typeapplication/json

Start a conversation with optional partner-approved context. The context shape is configured per partner and must match the agreed journey schema.

object

context

Partner-approved context supplied when the conversation begins.

object

key

additional properties

One of:

string

string

number

number

boolean

boolean

Example

{
  "context": {
    "policy": "standard",
    "age": 30
  }
}

Responses

201

Conversation started. The response contains the conversation identifier and its initial status.

Media typeapplication/json

object

userId

Abi user identifier for the conversation.

string

conversationInfo

object

id

Conversation identifier.

string

status

Current conversation lifecycle status.

string

Allowed values: OPEN WAITING_FOR_RESPONSE RESOLVED CLOSED

Example

{
  "userId": "abi12345",
  "conversationInfo": {
    "id": "01HK8GGQ123456789ABCDEFGHI",
    "status": "OPEN"
  }
}

400

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}

404

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}