OpenAPI specification

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

StudioThe Studio API, webhooks, and MCP adapter are included with the Studio plan.Compare plans

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/openapiOpenAPI 3.1 · GearDex Studio Agent API 1.0.0

Open the live OpenAPI JSON

Download

bashDownload 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.

bashGenerate 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
Resource	Shape	Operations
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.
Loans	collection + detail	List loans, check gear out and in, extend, and cancel.
Flags and availability	collection + query	Read, raise, and resolve gear issues; check an item's availability for dates.
Kits	collection + detail	List, create, update, and delete rigs and kits.
Incidents and stock	collection + detail	Report lost and stolen gear, log shutter counts, and adjust consumables.
Insurance	collection + detail	Read policies and certificates with the gear they cover.
Rentals and packing lists	collection + detail	Track rented gear, and pack gear for a shoot.