📚 API DOCUMENTATION

API Reference

Build powerful integrations with the messagespilot API. Comprehensive documentation and examples.

Getting Started

Authentication

Learn how to authenticate your API requests using API keys and OAuth 2.0.

Quickstart

Get started in 5 minutes with our step-by-step quickstart guide.

Webhooks

Receive real-time events about conversations, messages, and more.

Core API Endpoints

GET
/v1/conversations

List all conversations

POST
/v1/conversations

Create a new conversation

GET
/v1/conversations/:id

Get conversation details

POST
/v1/messages

Send a message

GET
/v1/messages

List messages

GET
/v1/teams

List teams

POST
/v1/webhooks

Create a webhook

Code Examples

// Initialize the SDK
import { MessagesPilotClient } from '@messagespilot/sdk';

const client = new MessagesPilotClient({
  apiKey: 'your_api_key_here'
});

// Send a message
const message = await client.messages.send({
  conversationId: 'conv_123',
  text: 'Hello! 👋',
  senderId: 'user_456'
});

// Listen to webhooks
client.webhooks.on('message.received', (event) => {
  console.log('New message:', event.message.text);
});

Official SDKs

JavaScript/TypeScript

npm install @messagespilot/sdk

Python

pip install messagespilot

Go

go get github.com/messagespilot/go-sdk

Ruby

gem install messagespilot

PHP

composer require messagespilot/php-sdk

Java

Add to maven or gradle

Start Building Today

Get your API keys and start integrating messagespilot into your application.