API Introduction

Plinqx provides two main API interfaces: the MCP Protocol for AI clients and a REST API for administrative operations.

API Overview

The Model Context Protocol (MCP) is the primary interface for AI clients:

MCP is the standard protocol used by ChatGPT, Claude, and other AI platforms to discover and call tools.

The REST API provides administrative operations:

Include your API key in requests:

Authorization: Bearer plinqx_xxxxxxxxxxxxxxxxxxxx

Or as a query parameter:

?api_key=plinqx_xxxxxxxxxxxxxxxxxxxx

For admin portal operations, use session cookies (handled automatically by the browser).

API rate limits vary by endpoint and plan:

Check your plan details for specific rate limits. Rate limits are also configurable via Policies.

All APIs return standard HTTP status codes:

Error responses include details:

{
  "error": {
    "message": "Description of the error",
    "code": "ERROR_CODE",
    "details": []
  }
}