GearDex DocsPlatform API

OpenAPI specification

Use the live GearDex contract with API clients, collection importers, schema validators, and code generators.

Studio APIv1Updated August 2026

GearDexStudio console

Schema valid

OpenAPI 3.1

Live contract explorer

api/studio-agent/v1

Paths

GET/gear

POST/gear

GET/shoots

PATCH/shoots/{id}

GET/documents

GearItem schema

type: object

required:

- id

- type

- brand

properties:

status: string

purchase_price: number

Live specification

GearDex serves its v1 Studio contract as OpenAPI JSON. The document is public so tooling can read endpoint schemas before you provide a key for authenticated requests.

GET/api/studio-agent/openapi

Download

Download OpenAPI JSON

curl -L "https://www.geardex.app/api/studio-agent/openapi" \
  -H "Accept: application/json" \
  -o geardex-openapi.json

The endpoint does not require a Studio API key. Generated clients must still send a scoped bearer key when they call protected v1 resources.

Client generation

Most OpenAPI-compatible generators can consume the live URL directly. Keep generated clients behind a server boundary so credentials never enter browser code.

Generate TypeScript types

npx openapi-typescript "https://www.geardex.app/api/studio-agent/openapi" \
  --output src/generated/geardex-api.d.ts

Generate types or a client during development or CI.
Review contract changes before updating application code.
Inject the Studio key at server runtime.
Preserve response status and error bodies for debugging.

Coverage

OpenAPI resource coverage
Name	Type	Description
`Gear`	collection + detail	List, create, update, and delete inventory records.
`Shoots`	collection + detail	List, create, update, and delete shoot plans.
`Maintenance`	collection + detail	List, create, update, and delete service records.
`Documents`	collection	Read document and warranty metadata.
`Analytics`	summary	Read aggregate Studio metrics.
`Profile`	resource	Read account and Studio profile metadata.