Skip to documentation
On this page
GearDex DocsPlatform API

Authentication

Every Studio API request uses a scoped bearer key tied to one GearDex account and integration.

Studio APIv1Updated August 2026
A moonlit passage between Joshua Tree granite formations
GearDex LogoGearDex
Last used 2m ago

Credentials

Production sync key

Production sync

Created Aug 2, 2026

API key

gdx_live_4F8X••••••••2K9Q

Expires

Nov 1, 2026

Requests

1,284

Granted scopes

gear:read
shoots:read
maintenance:read
analytics:read

Bearer authentication

Send your key in the Authorization header on every request. GearDex validates the key, subscription access, expiration, revocation status, rate limit, requested scope, and resource ownership before returning Studio data.

Create a key

  1. Open Settings → API & Agents.
  2. Choose a name that identifies the service using the key.
  3. Select the minimum required scopes.
  4. Set an expiration date appropriate for the integration.
  5. Copy the key once and store it in your secret manager.

Request example

The bearer token belongs in the header—not in a query string or JSON body.

Request (cURL)

curl -X GET "https://www.geardex.app/api/studio-agent/v1/gear?limit=3" \
  -H "Authorization: Bearer gdx_live_your_key_here" \
  -H "Accept: application/json"

Request (JavaScript)

const response = await fetch("https://www.geardex.app/api/studio-agent/v1/gear?limit=3", {
  headers: {
    Authorization: `Bearer ${process.env.GEARDEX_STUDIO_API_KEY}`,
    Accept: "application/json",
  },
})

if (!response.ok) {
  throw new Error(`GearDex request failed: ${response.status}`)
}

const payload = await response.json()

Key lifecycle

  • Use one key per application, agent host, or automation.
  • Prefer short, explicit expiration windows.
  • Rotate secrets without changing the integration's scope model.
  • Revoke a key immediately when a machine or service is retired.
  • Review activity logs for unexpected endpoints or request volume.

Authentication errors

GearDex authentication error responses
NameTypeDescription
401 missing_authorizationauthenticationThe request did not include a Bearer authorization header.
401 key_not_foundauthenticationThe key is invalid, unknown, or no longer available.
401 key_revokedauthenticationThe Studio owner revoked this integration key.
401 key_expiredauthenticationThe key passed its configured expiration date.
403 insufficient_scopeauthorizationThe key is valid but cannot perform the requested operation.
429 rate_limitedrate limitBack off and respect the Retry-After response header.