API And Metrics
API And Metrics
Section titled “API And Metrics”Weaver gives you three integration surfaces: a GraphQL API at /graphql, a WebSocket GraphQL endpoint at /graphql/ws, and a Prometheus-compatible metrics endpoint at /metrics.
What This Page Is For
Section titled “What This Page Is For”Use this page to understand the Weaver surfaces available to trusted integrations and monitoring tools.
GraphQL API
Section titled “GraphQL API”The web UI uses GraphQL for queue, history, settings, RSS, servers, and system state. External integrations should use API keys created in Settings > Security.
Use the narrowest API key scope that fits your integration.
Metrics Endpoint
Section titled “Metrics Endpoint”The metrics endpoint is intended for monitoring systems such as Prometheus. Keep it private unless your deployment intentionally exposes it through a protected monitoring path.
Common Uses
Section titled “Common Uses”- Read queue state from GraphQL.
- Manage jobs through an integration-scoped API key.
- Scrape throughput, queue pressure, and error counters from
/metrics. - Pair Weaver and Scryer on the same internal network.
Operational Notes
Section titled “Operational Notes”- Put authentication and network boundaries in front of public deployments.
- Keep API keys out of logs and issue reports.
- Keep metrics private if they expose operational details about your instance.