Authentication
Create an API key, send it with every request, and manage access.
The Vega API uses API keys created in the Vega app. A key is tied to your user and can read every organization your user has been approved for.
Create a key
- Sign in at app.vega.space. New here? Sign up first.
- Open Settings → API keys, give the key a name, and create it.
- Copy the key. It is shown once; Vega stores only a hash. If you lose it, revoke it and create another.
Keys start with vgk_. You can hold up to 10 active keys.
Lifetime
- A key expires one year after it is created, or earlier if you set a date when creating it.
- A key unused for 90 days is revoked automatically. You get an email a week before, and any request with the key resets the clock.
- Revocation is immediate; requests with a revoked or expired key return
401.
Send it
Put the key in the Authorization header as a bearer token:
Authorization: Bearer vgk_…curl https://admin.vega.space/api/v1/frontend/organization_requests/approved_organizations \
-H "Authorization: Bearer $VEGA_API_KEY"No email, password, or login call is involved. The key is the credential.
What a key can see
- Read-only. Keys cannot create, edit, or delete anything.
- Your organizations only. A key sees the organizations your user has been approved for. Request access to your organization from the Organizations page in the app; a Vega admin approves it.
- Demo Org. Every user is automatically a member of Vega's Demo Org, so a brand-new key returns live forecast data before any approval.
Revoke a key
Delete it from Settings → API keys. If a key may have leaked, revoke it first and create a new one second; every request made with a key is logged, so contact support with the key's name if you need to know what it accessed.
Status codes you will see
| Code | Meaning |
|---|---|
401 | Missing, revoked, or expired key |
403 | The call needs write access, which keys do not have |
404 | The organization does not exist, or your user is not approved for it. The two are deliberately indistinguishable |
429 | Rate limit exceeded. See Rate limits |
Building a COSMOS integration? The OpenC3 COSMOS
plugin takes this same key: paste it into
the Timeline widget, or store it as the VEGA_API_KEY secret for background polling.