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": {}
}
'
import requests

url = "https://api.example.com/api/v1/enrichment-chat/message"

payload = {
    "session_id": "<string>",
    "message": "<string>",
    "context": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({session_id: '<string>', message: '<string>', context: {}})
};

fetch('https://api.example.com/api/v1/enrichment-chat/message', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/enrichment-chat/message",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'session_id' => '<string>',
    'message' => '<string>',
    'context' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/enrichment-chat/message"

	payload := strings.NewReader("{\n  \"session_id\": \"<string>\",\n  \"message\": \"<string>\",\n  \"context\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/enrichment-chat/message")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"session_id\": \"<string>\",\n  \"message\": \"<string>\",\n  \"context\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/enrichment-chat/message")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"session_id\": \"<string>\",\n  \"message\": \"<string>\",\n  \"context\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "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
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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 | null

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 | null

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