Skip to content
Tiptree Systems Tiptree Systems Tiptree Systems Docs

API Overview

The Platform API is a RESTful API that allows you to interact with the Platform. It provides endpoints for managing messages and conversations between platform users and AI assistants.

Authentication

Section titled “Authentication”

The Platform API uses API keys to authenticate requests. See the Authentication Guide for details on obtaining and using API keys.

(Coming Soon) You can manage your API keys in the Platform Dashboard.

Quick Start

Section titled “Quick Start”

Here are some common operations you can perform with the API. Replace YOUR_API_KEY with your actual API key.

Send a Message

Section titled “Send a Message”
Terminal window
curl -X POST "https://platform.tiptreesystems.com/v1/message/receive" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "platform_user_id": "user123",
    "message": "Hello, assistant!"
  }'

Get Unread Messages

Section titled “Get Unread Messages”
Terminal window
curl "https://platform.tiptreesystems.com/v1/messages/unread?platform_user_id=user123" \
  -H "Authorization: Bearer YOUR_API_KEY"

Get Message History

Section titled “Get Message History”
Terminal window
curl "https://platform.tiptreesystems.com/v1/messages/all?platform_user_id=user123" \
  -H "Authorization: Bearer YOUR_API_KEY"

Send Assistant Message

Section titled “Send Assistant Message”
Terminal window
curl -X POST "https://platform.tiptreesystems.com/v1/message/send" \
  -H "Content-Type: application/json" \
  -d '{
    "platform_user_id": "user123",
    "message": {
      "payload": {
        "content": "How can I help you today?",
        "sender": "assistant"
      },
      "agent_session_id": "session123"
    }
  }'

Core Concepts

Section titled “Core Concepts”

Messages

Section titled “Messages”

Messages are the primary way users interact with the platform. Each message:

  • Has a unique identifier
  • Contains content and metadata
  • Can be sent by either users or AI assistants
  • Maintains read/unread status

Sessions

Section titled “Sessions”

Messages are organized into sessions that:

  • Group conversations between users and AI assistants
  • Maintain conversation context and history
  • Handle message routing and delivery

Available Endpoints

Section titled “Available Endpoints”

The API provides endpoints for:

  • Sending messages from platform users
  • Receiving messages from AI assistants
  • Retrieving unread messages
  • Accessing message history

For detailed endpoint specifications, request/response formats, and data models, see the API Reference.

Rate Limits

Section titled “Rate Limits”

Currently, the Platform API is rate limited to 300 requests per hour. This limit is applied to all endpoints. We’ll be increasing this limit over time.

Getting Help

Section titled “Getting Help”

If you need help with the API: