Appearance
API keys
Use API keys when you need RemoteGPU access outside the signed-in console.
The two main use cases are:
- calling the Inference API
- using
kubectlwith RemoteGPU Kubernetes namespaces
If you only work in the console UI, you usually do not need an API key.
Open in the console
| Task | Console page |
|---|---|
| Create, rotate, or revoke API keys | Settings / API Keys |
Before you create a key
| Question | Recommendation |
|---|---|
| Do you only use the console UI? | Do not create a key unless you need automation. |
| Do you call the Image API? | Create an Inference key. |
Do you use kubectl or CI against RemoteGPU Kubernetes namespaces? | Create a Kubernetes exec key. |
| Do you need both from one automation? | Create an All key only if you cannot split responsibilities. |
Create an API key in the console
From the console:
- Open Settings / API Keys
- Click
Create API key - Enter a name
- Choose the scope you need
- Optionally set an expiration
- Save the key value somewhere secure
The full key is only shown when it is created. After that, the console only shows the key prefix.
Choose the right scope
| Scope | Use it for | Typical caller | Notes |
|---|---|---|---|
Inference | Image generation requests | Application server, script, backend job | Sends the key in the x-api-key header |
Kubernetes exec | kubectl against a RemoteGPU namespace | Local shell, CI, platform operator | Can be scoped to selected namespaces or all namespaces in the account |
All | Combined automation | Admin automation | Use only when one workflow genuinely needs both surfaces |
Common key workflows
Use an Inference key when your application needs to call the Image API.
Typical flow:
- Create a key with the
Inferencescope. - Store it in your application secret manager or runtime environment.
- Send it in the
x-api-keyheader.
Inference requests send the key in the x-api-key header.
bash
curl -X POST "https://api.remotegpu.ai/v1/inference/image" \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_API_KEY" \
-d '{
"model": "black-forest-labs/FLUX.1-dev",
"prompt": "a cinematic portrait of an astronaut cat"
}'Continue with Image inference for the full request flow.
Operational guidance
| Practice | Why it matters |
|---|---|
| Use separate keys for separate systems | Limits blast radius when one system changes or leaks |
Prefer Inference over All when possible | Keeps application clients away from Kubernetes access |
| Prefer namespace-scoped Kubernetes exec keys | Reduces accidental cross-namespace access |
| Set expirations for temporary automation | Makes cleanup predictable |
| Revoke leaked or unused keys immediately | Removes stale credentials from circulation |
Common outcomes
| Status code | Meaning |
|---|---|
401 | The key is missing, invalid, revoked, or expired |
403 | The key is valid but does not allow the requested product flow |
400 | The scope payload or expiration is invalid while creating or editing a key |
