Threads - AUI

A thread is one conversation between an end user and your agent. Threads are created automatically when you send a message without a thread_id — the created id comes back in the response, and you pass it on subsequent messages to continue the conversation.

Coming from an earlier integration? Threads are what used to be called tasks, and there is no longer a separate “create task” step.

Read a thread’s transcript

cURL

curl "https://api-v3.aui.io/apollo-api/messaging/v1/threads/{threadId}/messages" \
  -H "Authorization: Bearer <access_token>"

GET `/messaging/v1/threads/{threadId}/messages`

Returns the thread’s full transcript in chronological order — one entry per message, both the user’s and the agent’s.

[
  {
    "id": "507f1f77bcf86cd799439011",
    "created_at": "2026-07-13T14:02:11Z",
    "text": "I want to dispute a charge from May 30th",
    "sender": { "id": "my-user-123", "type": "user" },
    "cards": [],
    "followup_suggestions": []
  },
  {
    "id": "507f1f77bcf86cd799439012",
    "created_at": "2026-07-13T14:02:14Z",
    "text": "I can help with that. Our dispute window is 8 days...",
    "sender": { "type": "agent" },
    "cards": [],
    "followup_suggestions": ["What other options do I have?"]
  }
]

Welcome message

Open your conversation UI with the agent’s configured greeting — before any message has been sent:

cURL

curl "https://api-v3.aui.io/apollo-api/messaging/v1/welcome-message" \
  -H "Authorization: Bearer <access_token>"

GET `/messaging/v1/welcome-message`

Returns the welcome message of your agent’s live version:

200

{ "welcome_message": "Hi! How can I help you today?" }

Follow-up suggestions

Generate suggested next prompts from a context you provide — useful for offering the end user quick next questions:

cURL

curl -X POST "https://api-v3.aui.io/apollo-api/messaging/v1/followup-suggestions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access_token>" \
  -d '{ "context": { "topic": "order tracking" } }'

POST `/messaging/v1/followup-suggestions`

context

object

The context the suggestions are generated from — any JSON object describing where the user is in your product or conversation.

200

{
  "suggestions": [
    "Where is my order?",
    "Can I change the delivery address?"
  ]
}

The agent’s replies also carry followup_suggestions inline — this endpoint is for generating suggestions outside a turn, e.g. when the user lands on a page.

Managing threads

Listing, filtering, renaming, and auditing threads across your organization live on the management surface — see Management → Threads.

​Read a thread’s transcript

​GET /messaging/v1/threads/{threadId}/messages

​Welcome message

​GET /messaging/v1/welcome-message

​Follow-up suggestions

​POST /messaging/v1/followup-suggestions

​Managing threads

Read a thread’s transcript

GET `/messaging/v1/threads/{threadId}/messages`

Welcome message

GET `/messaging/v1/welcome-message`

Follow-up suggestions

POST `/messaging/v1/followup-suggestions`

Managing threads