Helper
API Reference

Send Message

Sends a message to Helper and receives a streaming response

POST
/api/chat

Authorization

AuthorizationRequiredBearer <token>

JWT token obtained from the Session API

In: header

Request Body

application/jsonRequired
messageRequiredobject

The message to send to Helper

conversationSlugRequiredstring

Slug of the conversation to send the message to

curl -X POST "https://helper.ai/api/chat" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "message": {
      "role": "user",
      "content": "How can I update my shipping address?",
      "id": "msg_1234"
    },
    "conversationSlug": "abc123def456"
  }'

Streaming response with AI-generated reply

{
  "summary": "Streamed Response",
  "value": "data: {\"type\":\"text\",\"value\":\"Hello! I'd be happy to help you update your shipping address. \"}\ndata: {\"type\":\"text\",\"value\":\"You can change your shipping address by following these steps:\"}\ndata: {\"type\":\"text\",\"value\":\"\\n\\n1. Log into your account\\n2. Go to 'Account Settings'\\n3. Select 'Addresses'\\n4. Click 'Edit' next to your existing address or 'Add New Address'\\n5. Update the information and save your changes\"}\ndata: {\"type\":\"text\",\"value\":\"\\n\\nIs there anything else you need help with today?\"}\ndata: {\"type\":\"messageAnnotation\",\"value\":{\"id\":\"12345\",\"traceId\":\"trace_abc123\"}}"
}

Previous

Create Session POST

Next

Tools Overview