Skip to content
shuffl
Get started

Searches the public product guides only. Nothing from a workspace is read, and questions are not saved.

Reference

Mello conversations API

5 operations. Generated from the OpenAPI document, so this page always matches the API.

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

assistant.conversations

List your conversations with Mello

POST/api/v1/manage/assistant/conversations

const result = await shuffl.assistant.conversations();
Request fields (none)

This operation takes no input.

Response object[]
  • channel "slack" | "web" required
  • expiresAt string (date-time) required
  • id string required
  • slackUrl null | string required
  • title string required
  • updatedAt string (date-time) required

assistant.history

Read the messages in one of your conversations with Mello

POST/api/v1/manage/assistant/history

const result = await shuffl.assistant.history({
  "id": "<id>"
});
Request fields (1)
  • id string required
Response object
  • expiresAt string (date-time) required
  • messages object[] required
    • citations object[] required
      • href string required
      • kind "directory" | "knowledge" | "manager" | "playbook" optional
      • passageId string required
      • quote string required
      • sourceId string required
      • title string required
      • versionId string required
    • id string required
    • kind null | "answer" | "clarification" | "unavailable" required
    • notice null | "sources_unavailable" required
    • role "assistant" | "system" | "user" required
    • text string required
  • turns object[] required
    • id string required
    • leaseUntil null | string (date-time) required
    • status "cancelled" | "completed" | "failed" | "processing" | "queued" required

assistant.delete

Delete one of your conversations with Mello

POST/api/v1/manage/assistant/delete

const result = await shuffl.assistant.delete({
  "id": "<id>",
  "requestKey": "a-new-unique-key"
});
Request fields (2)
  • id string required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • deleted boolean required

assistant.send

Ask Mello a question in a conversation

POST/api/v1/manage/assistant/send

const result = await shuffl.assistant.send({
  "conversationId": "<conversationId>",
  "requestId": "<requestId>",
  "text": "<text>",
  "requestKey": "a-new-unique-key"
});
Request fields (4)
  • conversationId string required
  • requestId string required
  • text string required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • requestId string required
    • status string required

assistant.stop

Stop an answer Mello is still writing

POST/api/v1/manage/assistant/stop

const result = await shuffl.assistant.stop({
  "requestId": "<requestId>",
  "requestKey": "a-new-unique-key"
});
Request fields (2)
  • requestId string required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • stopped boolean required