POST
/
chat
/
{agent_id}
cURL
curl --request POST \
  --url https://api.soca.ai/v1/chat/{agent_id} \
  --header 'Content-Type: application/json' \
  --header 'private_key: <api-key>' \
  --data '{
  "prompt": "<string>",
  "session_id": "<string>"
}'
{
  "status": true,
  "data": {
    "status": 123,
    "message": "<string>",
    "data": "<string>"
  }
}

Authorizations

​
private_key
string
header
required

Path Parameters

​
agent_id
string
required

The unique identifier of a Soca AI agent created in the Studio.

Body

application/json

Message payload to be sent to the AI Agent.

​
prompt
string
required

Chat send by users to Soca AI.

​
session_id
string
required

Session ID for this message.

Response

Chat has been sent.

​
status
boolean

Chat has been delivered successfully

​
data
object

Same session ID as in the request.