API Reference

The MyGPTAssistants API allows you to programmatically interact with your AI assistants, manage conversations, and integrate chat functionality into your applications. REST API

API Endpoints

Authentication Learn how to authenticate API requests

Chat API Send messages and receive responses

Webhooks Receive real-time notifications

Base URL

All API requests should be made to:

https://api.mygptassistants.com/api/v1

Quick Start Example

JavaScript

const response = await fetch('https://api.mygptassistants.com/api/v1/bot/YOUR_BOT_ID', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    message: 'Hello, what can you help me with?',
    sessionId: 'optional-session-id'
  }),
});

const data = await response.json();
console.log(data.response);

Python

import requests

response = requests.post(
    'https://api.mygptassistants.com/api/v1/bot/YOUR_BOT_ID',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    json={
        'message': 'Hello, what can you help me with?',
        'sessionId': 'optional-session-id'
    }
)

data = response.json()
print(data['response'])

cURL

curl -X POST 'https://api.mygptassistants.com/api/v1/bot/YOUR_BOT_ID' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"message": "Hello, what can you help me with?", "sessionId": "optional-session-id"}'

API Features

Chat Messaging

Send messages to your AI assistants and receive responses.

Conversation Management

Create, retrieve, and manage conversation sessions.

Webhook Events

Real-time

Receive notifications for new messages and events.

Contact API

Manage CRM contacts programmatically.

Rate Limits

Standard Limits

Endpoint Type	Limit
Chat endpoints	100 requests/minute
Data endpoints	1000 requests/hour
Webhook endpoints	500 requests/minute

Rate Limit Headers

Header	Description
X-RateLimit-Limit	Maximum requests allowed
X-RateLimit-Remaining	Requests remaining
X-RateLimit-Reset	Unix timestamp when limit resets

Need Higher Limits?

Contact support if you need higher rate limits for your use case. Enterprise plans include custom rate limits.

Response Format

Success Response

{
  "success": true,
  "data": {
    "response": "Hello! I can help you with...",
    "conversationId": "conv_123abc",
    "messageId": "msg_456def"
  },
  "error": null
}

Error Response

{
  "success": false,
  "data": null,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Please try again later."
  }
}

Error Codes

Code	Description	Solution
RATE_LIMIT_EXCEEDED	Too many requests	Implement backoff, wait and retry
INVALID_API_KEY	API key invalid	Check key in dashboard
BOT_NOT_FOUND	Bot ID doesn’t exist	Verify bot ID
INVALID_REQUEST	Malformed request	Check request body
INTERNAL_ERROR	Server error	Contact support if persists

Best Practices

• Always check the success field before processing data
• Implement exponential backoff for rate limit errors
• Cache responses when appropriate to reduce API calls
• Use webhooks instead of polling for real-time updates

Getting Started

1. Get your API key

   Navigate to Settings → API in your dashboard to generate a key.

2. Choose your endpoint

   Determine which API endpoints you need for your integration.

3. Make your first request

   Use the Quick Start examples above to test the connection.

4. Set up webhooks

   Configure webhooks for real-time event notifications.

5. Go to production

   Replace test keys with production keys when ready.

SDKs & Libraries Coming Soon

Official SDKs for popular languages are in development:

JavaScript/TypeScript

NPM package for Node.js and browser.

Python

PyPI package with async support.

PHP

Composer package for Laravel and more.

Related Topics

Authentication API key setup and usage

Chat API Message endpoints reference

Webhooks Event notifications setup

Integrations Platform connections