ON THIS PAGE

  • Endpoints
  • Public integration boundary
  • Live introspection
  • Tooling recipes
  • Related reference pages

GraphQL Schema

Use this page when you need the exact schema endpoints, want to inspect the current public GraphQL surface, or need the SDL for tooling and offline analysis.
Jump to:

Endpoints

Use these endpoints for schema inspection:
  • GraphQL endpoint: https://api.cloud.luxonis.com/graphql
  • Control-plane authentication: Authorization: Bearer <your_api_key>
  • Introspection access: available without authentication
  • Public integration root: team { ... }
If you need request-shape basics or GraphQL terminology, continue to About GraphQL.

Public integration boundary

For external integrations, design around the public team { ... } surface and use the official guides and reference pages together with schema inspection.

Live introspection

Introspect the current public schema through the GraphQL endpoint:
Http
1https://api.cloud.luxonis.com/graphql
Introspection can be accessed without authentication. If you are already testing with an authenticated GraphQL client, the same endpoint still works there as well.

Inspect in a GraphQL client

Use a GraphQL client such as Altair when you want to browse types, fields, arguments, and enums interactively.
  • endpoint: https://api.cloud.luxonis.com/graphql
  • best for: checking field names, input object shapes, and enum values before you wire a query or mutation

Minimal introspection request

If you need to verify that introspection is reachable from your environment, send a minimal query like this:
Command Line
1curl -X POST https://api.cloud.luxonis.com/graphql \
2  -H "Content-Type: application/json" \
3  -d '{"query":"{ __schema { queryType { name } mutationType { name } } }"}'

Tooling recipes

Generate typed clients from your checked-in operations

For production applications, prefer generating types from the queries and mutations you actually use instead of browsing the schema manually on every change.With GraphQL Code Generator, point the schema source to:
Yaml
1schema: https://api.cloud.luxonis.com/graphql
2documents: ./src/**/*.graphql
This is the practical workflow:
  • define the queries and mutations your integration needs
  • generate types against the current schema
  • treat generation errors as a signal that the operation or schema contract changed

Choose the inspection path that matches the job

  • Use live introspection when you need to inspect one field, argument, or input shape quickly.
  • Use Queries and Mutations when you already know the kind of operation you are looking for.

Related reference pages