Skip to main content
Docs/IDE Integration & API/API Reference Overview

CodePus API Reference Overview

CodePus offers an official AI gateway compatible with the OpenAI protocol. Free and trial allowances are available only within the CodePus IDE, with no external API access; accounts with an active paid subscription can also use the issued API Key (prefix cpk_) from the IDE or third-party programs.

Quick Start

  1. Create an API Key: go to API Key Management and generate a key starting with cpk_.
  2. Configure the Base URL: see Proxy Base URL to point your client at the CodePus gateway.
  3. Make a request: follow the OpenAI-Compatible API protocol.

Core Docs

Authentication

All requests must carry the HTTP header:

Authorization: Bearer cpk_xxxxxxxxxxxxxxxx

Need Help?

See IDE Integration Troubleshooting or go to Contact Support.