Skip to main content

GraphQL

Lumio provides a GraphQL endpoint for flexible data querying.

Endpoint

POST /v1/gql

Base URLs

EnvironmentURL
Staginghttps://lumio.api.staging.zaflun.dev/v1/gql
Production Previewhttps://lumio.api.prod.zaflun.dev/v1/gql
Productioncoming soon — official domain not yet assigned

Interactive Explorer

GraphiQL is available at /v1/graphiql when the API is running (gated behind graphql.playground = true in config). Use it to explore the schema, build queries, and test mutations.

Schema Download

Download the GraphQL SDL schema:

curl -o schema.graphql https://lumio.api.staging.zaflun.dev/v1/schema

Example Query

query {
overlays {
id
name
key
width
height
}
}

Real-time Updates

Lumio does not expose a GraphQL Subscription type. For real-time updates (events, chat, overlay changes), use the channel-based WebSocket at /v1/ws — see WebSocket.