Start Chat Session

Start a new chat session for creating a sender profile.

Initiates a conversational interface that guides users through creating a comprehensive sender profile.

Returns: Initial chat message with session ID

POST /api/v1/sender-profile-chat/start

Start Chat Session

cURL

curl --request POST \
  --url https://api.example.com/api/v1/sender-profile-chat/start \
  --header 'Authorization: Bearer <token>'

200

{
  "session_id": "<string>",
  "message": {
    "role": "<string>",
    "content": "<string>",
    "id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "metadata": {}
  },
  "is_complete": false,
  "collected_data": {},
  "next_field": "<string>",
  "suggestions": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

Successful Response

Response model for chat interactions.

session_id · string · required

message · ChatMessage · object · required

Represents a single message in the chat conversation.

Show child attributes

is_complete · boolean · default: false

Whether profile collection is complete

collected_data · Collected Data · object

All collected profile data so far

next_field · string | null

The field we're expecting next

suggestions · string[] | null

Suggested responses or examples