GetAPI documentation
GetAPI documentation and integration guides
Start with setup, then choose integration, model and media, migration, security, billing, or troubleshooting guidance for your task.
Documentation index
Choose the task you need
Get started
- GetAPI.ONE API quickstart: API key and first requestA complete path from account creation and model selection to a scoped API key, client configuration, and a working first connection.
- Create and access a GetAPI.ONE accountRegister with username, password, and email verification; sign in safely; recognize success; and recover from common account errors.
- Create and protect a GetAPI.ONE API keyCreate a named, scoped key; select a group, expiry, and quota; store it outside source code; verify it; and revoke it safely.
Build an integration
- Python API integration with GetAPI.ONE: OpenAI SDK and ResponsesInstall the official OpenAI Python SDK, point it at the ONE base URL, make a controlled Responses request, and verify the result without putting credentials in source code.
- Call GetAPI.ONE from Node.jsUse the official OpenAI JavaScript SDK on a trusted Node.js runtime with the ONE base URL, an environment credential, and an exact catalog model.
- Send a GetAPI.ONE API requestChoose a declared protocol, use a key from an environment variable, replace the model placeholder, inspect the HTTP result, and handle failures without making unsupported endpoint assumptions.
- Stream Responses from GetAPI.ONEConsume a server-sent event stream, append only text deltas, and treat completed, failed, and incomplete events as distinct terminal outcomes.
- Codex CLI with GetAPI.ONE: API key and custom provider setupInstall Codex CLI from the official source, keep the ONE key in an environment variable, configure a Responses-compatible custom provider, and verify the active connection.
- Configure Codex in CCSwitch for GetAPI.ONEAdd GetAPI.ONE as an OpenAI-compatible provider for a compatible Codex target in CCSwitch, then verify the connection.
Choose models and media workflows
- Generate images with GetAPI.ONESelect an image model from the live catalog, send the smallest declared request to the ONE image route, validate the response shape, and store output safely.
- Generate video with the ONE task APISubmit an OpenAI-shaped video task, preserve its public task ID, poll the exact ONE status route to a terminal state, and fetch content only after completion.
- Choose a model for your taskFilter the current catalog by declared endpoint and task, run a small evaluation with your own examples, and choose from measured quality, latency, and live cost evidence.
Operate safely
- Migrate an OpenAI SDK integration to GetAPI.ONEInventory the existing request contract, change credentials and base URL behind configuration, map an exact ONE catalog model, canary both paths, and retain rollback.
- Secure a GetAPI.ONE integrationKeep API keys on trusted servers, issue bounded credentials, validate user-controlled requests, minimize sensitive logs, and prepare an evidence-based response to exposure.
- Understand GetAPI.ONE pricing and usageIdentify the pricing mode, endpoint, unit, and group before use; read current values from Live pricing; then reconcile an actual request against account records.
- Troubleshoot GetAPI.ONE connectionsA symptom-first checklist for keys, URLs, endpoints, models, groups, quota, client configuration, network failures, and safe escalation.
- GetAPI support channels and safe reportingContact us through QQ or Telegram for help with your account, API connection or usage. Never share your API key or password.