canonical: https://jentic.com/apis/alerty.ai/alerty # Alerty API Jentic publishes the only available OpenAPI specification for Alerty API, keeping it validated and agent-ready. Alerty is a developer monitoring platform that combines logs, metrics, traces, monitors, and incident management with an AI chat interface. The REST API exposes endpoints for organisation and member management, integrations (such as Slack), monitor and incident lifecycle, telemetry queries against logs/metrics/traces, inventory of detected services, and a chat interface for asking questions about observability data. Authentication uses a bearer token; some endpoints also accept a session cookie. ## For AI agents Query logs, metrics, and traces, manage monitors and incidents, and chat with Alerty's AI over your observability data through 52 endpoints. ## Scope Does not handle telemetry ingestion agents, on-call paging escalation, or status page hosting - use for querying Alerty-ingested logs, metrics, traces, and managing incidents and monitors only. ## Capabilities - Run a logs, metrics, or traces query against ingested telemetry via `/query/logs`, `/query/metrics`, and `/query/traces` - Create and manage monitors that watch for conditions in observability data - Open, update, and resolve incidents tied to monitor breaches - Manage organisation membership, invitations, and integrations such as Slack - Start a chat conversation that lets the Alerty AI reason over the workspace's telemetry - List inventoried services and infrastructure detected by Alerty ## Use cases ### AI-assisted incident triage An on-call agent receives an alert and immediately POSTs to /chat to start a conversation with the Alerty AI, then sends follow-up messages via `/chat/{id}/message` asking for a summary of recent error spikes. The chat references underlying logs and metrics, so the engineer gets a contextual triage report without writing query strings by hand. Example prompt: POST /chat to start a conversation, then POST `/chat/{id}/message` with a triage prompt describing the alert and the affected service ### Programmatic log query for SRE automation An SRE pipeline runs nightly checks for error log patterns by POSTing to `/query/logs` with filter expressions and a time range, then writes the result counts to a status board. Because the API returns structured results, the same pipeline can also drive automated rollbacks when error counts cross a threshold. Example prompt: POST `/query/logs` with the service filter and timeframe, parse the count, and trigger the rollback workflow when the threshold is exceeded ### Incident lifecycle automation A deploy pipeline opens an incident in Alerty when a release fails health checks, posts updates from the deploy logs, and closes the incident once the rollback succeeds. The integration uses the incident endpoints alongside monitor lookups so the team has a single timeline of every release event without manual ticket entry. Example prompt: POST to the incident create endpoint with the failing service, PATCH the incident as the rollback progresses, then close it once health checks pass ### Agent-driven observability lookup through Jentic A Jentic agent answers questions like 'what services are deployed in production?' by calling the Alerty inventory endpoint and filtering by environment. The same agent can chain a metrics query if the user asks 'and which one had the highest error rate yesterday?'. The bearer token stays in your Jentic One instance. Example prompt: Search Jentic for 'list services in Alerty inventory', execute the inventory endpoint, then chain POST `/query/metrics` with an error rate expression for the top services ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/query/logs` | Query logs | | POST | `/query/metrics` | Query metrics | | POST | `/chat` | Create a chat conversation | | POST | `/chat/{id}/message` | Send a chat message | | GET | `/integration` | List integrations | | POST | `/integration/{id}/test` | Trigger a test for an integration | | POST | `/organization/{id}/invitation` | Invite a member to an organisation | ## Key resources - **Auth** — Login, logout, refresh, and current user introspection - **Organization** — Manage organisations, members, and invitations - **Integration** — List, create, retrieve, delete, and verify integrations such as Slack - **Monitor** — Define and manage monitors over telemetry - **Incident** — Open, update, and resolve incidents - **Query** — Run logs, metrics, and traces queries against ingested telemetry - **Inventory** — Inspect the services and infrastructure Alerty has detected - **Chat** — Start AI chat conversations and send messages over observability context - **Detect** — Detection workflows for anomalies and patterns ## Why Jentic - **Setup:** Wiring Alerty by hand means setting up its bearer token, posting log and metric queries against api.alerty.ai, and threading incident and monitor calls through your own retry logic. Through Jentic you install once, import the Alerty API from the API Directory, store the bearer token once, and your agent calls it. - **Permission scoping:** Alerty puts the resource id in the URL path (`/chat/{id}/message`, `/integration/{id}/test`, `/organization/{id}/invitation`), so a rule can pin your agent to one chat or integration. You choose the operations it may call, so posting organization invitations is not included unless you add it. - **Credential handling:** Your Alerty bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'query recent error logs' or 'open an incident in Alerty', and Jentic returns the matching Alerty operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Anthropic Messages API** — Use Anthropic Messages alongside Alerty's chat API to add custom reasoning or summarisation outside the Alerty workspace - **OpenAI API** — Pair with Alerty when an agent needs to format observability output for users in natural language - **Hugging Face Inference API** — Use Hugging Face hosted models for log classification when an Alerty subscription is not available ## FAQ ### Why is there no official OpenAPI spec for Alerty API? Alerty does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Alerty API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Alerty API use? Alerty uses an HTTP bearer token in the Authorization header for programmatic access; certain endpoints also accept a __lumos_session cookie for browser flows. Jentic stores the bearer token encrypted in its credential vault and injects it at execution time. ### Can I run a logs query against Alerty programmatically? Yes. POST `/query/logs` with your filter expression, a time range, and any pagination parameters. Alerty returns structured rows you can drive into automation, dashboards, or downstream alerts. ### What are the rate limits for the Alerty API? The OpenAPI spec does not declare rate limits. Alerty enforces them server-side based on workspace plan; throttle long-running query and chat workflows and check for 429 responses. ### How do I start an Alerty AI chat conversation through Jentic? Search Jentic for 'start an alerty chat conversation', execute POST /chat to create the conversation, then POST `/chat/{id}/message` to send the question. Jentic returns the assistant's response without the bearer token leaving the vault. ### Can I open and close incidents with the Alerty API? Yes. The incident endpoints let you create incidents tied to a monitor or service, post updates as the situation evolves, and resolve the incident when the issue is fixed. This lets a deploy pipeline keep an end-to-end timeline in Alerty automatically. ### Can I limit what my agent is allowed to do with the Alerty API? Yes. Because you run Jentic One yourself, your own rules decide which Alerty operations and credentials the agent may use, so you can grant read-only query calls like POST `/query/logs` and POST `/query/metrics` while withholding write operations such as opening incidents or POST `/organization/{id}/invitation.` Since Alerty puts the resource id in the URL path, a rule can pin the agent to a single chat via `/chat/{id}/message` or one integration via `/integration/{id}/test` rather than the whole workspace. Anything you do not explicitly allow, such as inviting new organisation members, stays off limits.