API Documentation

Learn how to use the OpenAssistantGPT API to access your chatbot data programmatically.

API Reference

Learn how to use the API to access your chatbot data programmatically.

Authentication

All API requests must include your API key in the Authorization header.

Authorization: Bearer YOUR_API_KEY

Rate Limiting

The API implements rate limiting to ensure fair usage and system stability. Each API key is limited to 60 requests per minute.

Rate Limit Headers

All API responses include headers that provide information about your current rate limit status:

  • X-RateLimit-Limit: The maximum number of requests allowed per time window
  • X-RateLimit-Remaining: The number of requests remaining in the current time window
  • X-RateLimit-Reset: The time at which the rate limit will reset (ISO format)

Rate Limit Exceeded

If you exceed the rate limit, the API will respond with a 429 Too Many Requests status code and a Retry-After header indicating how many seconds to wait before retrying.

Enter your API key below to use it in the interactive examples.

This is the API key you generated in the settings page. It will not be stored or sent anywhere except to the API endpoints.