Billie Connect Converse API V2 Specification

Last updated
Save as PDF

Overview

[Describe what this topic is about. In Aria application documentation, include a link to the corresponding API documentation for the same feature, and vice versa.

Example: This article provides the steps for creating a plan.]

Base URL

POST https://{api-gateway-domain}/api/v2/converse

Authentication

Headers Required:

Authorization: Bearer {jwt_token}
Content-Type: application/json

Request Body:

{
  "message_id": "string",
  "conversation_id": "string",
  "timestamp": "string",
  "response_preferences": {
    "include_textual_summary": boolean,
    "response_format": "STRUCTURED" | "TEXT" | "BOTH"
  },
  "content": {
    "text": "string",
    "type": "QUERY" | "ACTION_REQUEST" | "ERROR",
    "structured_data": {
      "response_type": "string",
      "data": {},
      "schema_version": "string"
    }
  },
  "metadata": {
    "source_agent": "string",
    "target_agent": "string",
    "in_reply_to_message_id": "string",
    "sequence_num": number,
    "source_message_id": "string",
    "source_conversation_id": "string"
  }
}

Response:

{
  "message_id": "string",
  "conversation_id": "string",
  "timestamp": "string",
  "content": {
    "text": "string",
    "type": "RESPONSE" | "ACTION_RESULT" | "ERROR",
    "structured_data": {
      "response_type": "ACCOUNT_INFO" | "BILLING_INFO" | "INVOICE_INFO" | "ORDER_INFO" | "PRODUCT_INFO" | "ERROR_DETAILS" | "ACTION_RESULT" | "OPENDATA",
      "data": {},
      "schema_version": "string"
    }
  },
  "metadata": {
    "source_agent": "string",
    "target_agent": "string",
    "in_reply_to_message_id": "string",
    "sequence_num": number,
    "source_message_id": "string",
    "source_conversation_id": "string",
  }
}

Status Codes:

200 OK: Message processed successfully

400 Bad Request: Invalid request format

401 Unauthorized: Invalid auth token, Unauthorized request

404 Not Found: Requested resource not found

500 Internal Server Error: Server error

403 Forbidden: Billie not enabled