Getting Started

The YourGPT API gives you programmatic access to everything you can do in the dashboard. Automate your workflows, build custom integrations, or manage your chatbot infrastructure from your own code.

Every endpoint follows the same conventions — POST requests with JSON bodies and a consistent response format. If you can make an HTTP request, you can use this API.

Two types of API access

YourGPT provides two distinct API types for different use cases:

	Platform APIs	Project Integration APIs
Auth	API Token (`api-v1-...`)	API Key (`apk-...`)
Scope	Organization-wide, multi-project	Single project only
Created in	Organization Settings → API Tokens	Project → Integrations → API Integration
Plans	Advanced, Agency, Enterprise	Professional and above
Use case	Full platform access — organization management, multi-project operations, training, contacts, analytics, and more	Common integration use cases — conversations, voice calls, knowledgebase search

Platform APIs

Organization-wide APIs — manage projects, training, contacts, and more.

Project Integration APIs

Project-level APIs — conversations, voice calls, and knowledgebase search.

Base URLs

Scope	Base URL
Project-level	`https://api.yourgpt.ai/chatbot/v1`
Organization-level	`https://api.yourgpt.ai/api/v1`

Project-level endpoints operate on a specific chatbot (identified by project_uid). Organization-level endpoints operate across your account — the organization is inferred from your token.

Prerequisites

A YourGPT account — Professional+ for Project Integration APIs, Advanced+ for Platform APIs
At least one chatbot project

Response format

Every response includes a type field that tells you what happened.

Success:

{
  "type": "RXSUCCESS",
  "message": "Data Fetched Successfully!",
  "data": { ... }
}

Error:

{
  "type": "RXERROR",
  "message": "Description of what went wrong"
}

List endpoints also return a total field for pagination.