Answers

Get answer to a question

get/answers

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/answers
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Query parameters

questionstring required
Example:What did we discuss about the project yesterday?

The question text

workspace_idstring required
Example:wksp_123456789

The workspace ID to search in

channel_idsstring[]

The channel IDs to search in (can be a single ID or array of IDs)

[
  "fsdfasdfsdafasdf"
]

Response

textstring required

The answer text

message_idsstring[] required

List of message IDs that were used to generate the answer

channel_idsstring[] required

List of channel IDs that were searched

workspace_idstring required

The workspace ID that was searched

Example response

{
  "text": "Based on the conversation, you discussed the project timeline and agreed to complete the first phase by next Friday.",
  "message_ids": [
    "msg_123",
    "msg_456",
    "msg_789"
  ],
  "channel_ids": [
    "asdfasdfsdfsdf"
  ],
  "workspace_id": "wksp_123456789"
}

Changes

No recorded changes to this operation across all 1 revision of this API.