Skip to main content
POST
/
api
/
v1
/
enrichment-chat
/
message
Send Enrichment Message
curl --request POST \
  --url https://api.example.com/api/v1/enrichment-chat/message \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_id": "<string>",
  "message": "<string>",
  "context": {}
}
'
{
  "session_id": "<string>",
  "message": {
    "role": "<string>",
    "content": "<string>",
    "id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "metadata": {}
  },
  "action": "<string>",
  "suggested_fields": [
    "<string>"
  ],
  "processing_status": {},
  "credits_estimated": 123,
  "rate_limit_remaining": 123,
  "response_time_ms": 123
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Request model for enrichment chat interactions with enhanced validation.

​
session_id
string
required

Unique session identifier

Minimum string length: 1
​
message
string
required

User's message

Required string length: 1 - 10000
​
context
Context · object

Current conversation context including uploaded file info

Response

Successful Response

Enhanced response model for enrichment chat interactions.

​
session_id
string
required

Session identifier

​
message
EnrichmentChatMessage · object
required

Assistant's response message

​
action
string | null

Action to trigger in frontend (e.g., 'requestUpload', 'startProcessing')

​
suggested_fields
string[] | null

Suggested fields to enrich based on user query

​
processing_status
Processing Status · object

Status of ongoing enrichment processing

​
credits_estimated
integer | null

Estimated credits required for suggested operations

​
rate_limit_remaining
integer | null

Remaining rate limit for user

​
response_time_ms
integer | null

Response time in milliseconds