Send a Message as a User Input - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

Send a Message as a User Input

Endpoint: POST /v2.0/endpoint/inject

cURL Example

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/endpoint/inject \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "userId": "user@example.com",
  "text": "inject text",
  "data": {},
  "URLToken": "endpoint-url-token",
  "sessionId": "your-session-id"
}
' 

Python Example

import requests

url = "https://api-trial.cognigy.ai/new/v2.0/endpoint/inject"

payload = {
    "userId": "user@example.com",
    "text": "inject text",
    "data": {},
    "URLToken": "endpoint-url-token",
    "sessionId": "your-session-id"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript (Fetch) Example

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    userId: 'user@example.com',
    text: 'inject text',
    data: {},
    URLToken: 'endpoint-url-token',
    sessionId: 'your-session-id'
  })
};

fetch('https://api-trial.cognigy.ai/new/v2.0/endpoint/inject', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP Example

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-trial.cognigy.ai/new/v2.0/endpoint/inject",
  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([
    'userId' => 'user@example.com',
    'text' => 'inject text',
    'data' => [],
    'URLToken' => 'endpoint-url-token',
    'sessionId' => 'your-session-id'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

Response Codes

• 200: "Message was sent to AI for Flow processing"
• 400: Invalid request.
• 401: Unauthorized.
• 402: Payment required.
• 403: Forbidden.
• 405: Method not allowed.
• 409: Conflict.
• 413: Payload too large.
• 501: Not implemented.
• 502: Bad gateway.
• 503: Service unavailable.
• 504: Gateway timeout.

Example Response

{
  "status": 123,
  "code": 123,
  "type": "<string>",
  "detail": "<string>"
}

Error Response Examples

{
  "type": "Unauthorized",
  "title": "Unauthorized Error",
  "status": 401,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 401,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Payment Required",
  "title": "Payment Required Error",
  "status": 402,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 402,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Forbidden",
  "title": "Forbidden Error",
  "status": 403,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

Authorizations

• X-API-Key: Required in the HTTP header.

Body Parameters

• userId: string<email> (required)
  • Example: "user@example.com"
• text: string (required)
  • Example: "inject text"
• data: object (required)
• URLToken: string (required)
  • Example: "endpoint-url-token"
• sessionId: string (required)
  • Example: "your-session-id"

Response

• 200: Returns success message.
• Type: string.

Last modified on July 8, 2026.