Platform
GraphQL schema reference · API guide · SDKs
Server info, capabilities, network status, and global object lookup by ID.
Types used by more than one domain are on Shared types.
Queries
Section titled “Queries”Query.capabilities
Section titled “Query.capabilities”What the current tenant can use, built only from gates the platform enforces. Describes enforcement; it never grants access itself.
capabilities: Capabilities!Returns: Capabilities! (Capabilities)
SDK
| Operation | TypeScript | Go | Python |
|---|---|---|---|
| GetCapabilities | GetCapabilitiesDocument | GetCapabilities | get_capabilities |
Query.networkStatus
Section titled “Query.networkStatus”Public network status: cluster topology, node counts, peer connections. No tenant data exposed. Part of public allowlist.
networkStatus: NetworkStatusReturns: NetworkStatus (NetworkStatus)
SDK
| Operation | TypeScript | Go | Python |
|---|---|---|---|
| GetNetworkStatus | GetNetworkStatusDocument | GetNetworkStatus | get_network_status |
Query.node
Section titled “Query.node”Fetch a single node by its global ID.
node( id: ID!): NodeReturns: Node (Node)
Arguments
id:ID!— The global ID of the node.
SDK
| Operation | Selects | TypeScript | Go | Python |
|---|---|---|---|---|
| GetInfrastructureNodeMetrics1hConnection | node.InfrastructureNode.metrics1hConnection | GetInfrastructureNodeMetrics1hConnectionDocument | GetInfrastructureNodeMetrics1hConnection | get_infrastructure_node_metrics_1_h_connection |
| GetInfrastructureNodeMetricsConnection | node.InfrastructureNode.metricsConnection | GetInfrastructureNodeMetricsConnectionDocument | GetInfrastructureNodeMetricsConnection | get_infrastructure_node_metrics_connection |
| GetNode | node | GetNodeDocument | GetNode | get_node |
Query.serverInfo
Section titled “Query.serverInfo”Platform release and shipped product features. Readable without authentication so clients can detect what this server supports before signing in.
serverInfo: ServerInfo!Returns: ServerInfo! (ServerInfo)
SDK
| Operation | TypeScript | Go | Python |
|---|---|---|---|
| ServerInfo | ServerInfoDocument | ServerInfo | server_info |
Capabilities
Section titled “Capabilities”object
Enforced gates for the current tenant. Each section is read from the service that enforces it and cached per tenant for 30 seconds. When that service is unavailable, the last cached section is returned; without one the section is null and the response carries an error.
- tenant:
TenantCapabilities(TenantCapabilities) - clusters:
[ClusterCapabilities!](ClusterCapabilities) - observedAt:
Time!(Time) — When the oldest returned section was read from its source.
ClusterCapabilities
Section titled “ClusterCapabilities”object
A cluster the tenant is entitled to route to.
- clusterId:
String! - clusterName:
String! - role:
String!— preferred, official, or subscribed. - accessLevel:
String!— Access level of the tenant’s grant (shared, dedicated, priority). - media:
ClusterMediaCapabilities!(ClusterMediaCapabilities)
ClusterMediaCapabilities
Section titled “ClusterMediaCapabilities”object
Media verbs a cluster accepts for the tenant now. Each is true only when the capacity owner’s consent permits it and at least one active edge node reported the capability within the health freshness window, so it can lag by up to that window.
- ingest:
Boolean! - playback:
Boolean! - storage:
Boolean! - processing:
Boolean!
NetworkClusterStatus
Section titled “NetworkClusterStatus”object
- clusterId:
String! - name:
String! - region:
String! - latitude:
Float! - longitude:
Float! - nodeCount:
Int! - healthyNodeCount:
Int! - peerCount:
Int! - status:
String! - clusterType:
String! - shortDescription:
String - currentStreams:
Int! - currentViewers:
Int! - egressMbps:
Int! - egressCapacityMbps:
Int! - ingressMbps:
Int! - services:
[String!]!
NetworkNode
Section titled “NetworkNode”object
- nodeId:
String! - name:
String! - nodeType:
String! - latitude:
Float! - longitude:
Float! - status:
String! - clusterId:
String!
NetworkPeerConnection
Section titled “NetworkPeerConnection”object
- sourceCluster:
String! - targetCluster:
String! - connected:
Boolean! - connectionType:
String!
NetworkServiceInstance
Section titled “NetworkServiceInstance”object
- instanceId:
String! - serviceId:
String! - clusterId:
String! - nodeId:
String - status:
String! - healthStatus:
String!
NetworkStatus
Section titled “NetworkStatus”object
- clusters:
[NetworkClusterStatus!]!(NetworkClusterStatus) - peerConnections:
[NetworkPeerConnection!]!(NetworkPeerConnection) - nodes:
[NetworkNode!]!(NetworkNode) - serviceInstances:
[NetworkServiceInstance!]!(NetworkServiceInstance) - totalNodes:
Int! - healthyNodes:
Int! - updatedAt:
Time!(Time)
RecordingRetentionCap
Section titled “RecordingRetentionCap”object
Recording retention bound from the tenant’s billing tier.
- capped:
Boolean!— Whether a maximum applies. - maxDays:
Int— Maximum retention in days when capped.
ServerInfo
Section titled “ServerInfo”object
Release and shipped feature set of this server.
- version:
String!— Platform release version, for example v0.3.11. - features:
[String!]!— Sorted slugs of shipped product features in the platform feature registry.
TenantCapabilities
Section titled “TenantCapabilities”object
Tenant-wide gates.
- platformOperator:
Boolean!— Whether the caller holds the platform operator grant. - recordingRetention:
RecordingRetentionCap!(RecordingRetentionCap) — Upper bound on recording retention the tenant can set. - processingCustomizable:
Boolean!— Whether the tenant may override the tier’s processing profiles. - customSubdomain:
Boolean!— Whether the tenant’s custom subdomain alias is published. - customDomain:
Boolean!— Whether the tenant’s custom domain is published.