Quickstart
Authenticate with your Seqlense API key, make your first call, and learn the conventions every endpoint shares.
Make your first call to the Seqlense Monitoring API in under a minute.
Base URL
Every endpoint lives under:
https://monitoring.seqlense.com/api/v1Authentication
Send your API key as a bearer token in the Authorization header. Keys start
with sq_ and are created from Settings → Developer on
monitoring.seqlense.com, or through the
API keys endpoints.
GET https://monitoring.seqlense.com/api/v1/hello
Authorization: Bearer sq_YOUR_API_KEYThe key decides everything about scope: every request is automatically limited to the organization that owns it, and to the workspace (production or development) the key was created for. You never pass an organization ID.
An API key has the same reach as your organization. Keep it server-side, never ship it in browser or mobile code, and revoke it as soon as it leaks.
Say hello
Call the endpoint
curl -H "Authorization: Bearer sq_YOUR_API_KEY" \
"https://monitoring.seqlense.com/api/v1/hello"Read the response
A 200 OK confirms the API is reachable and your key is valid. The message
names the organization the key belongs to:
{
"message": "Hello, member of acme!"
}A missing, unknown or expired key returns 401 instead:
{ "error": "Unauthorized" }Conventions
These hold for every endpoint, so they are worth knowing before you go further.
| Topic | Rule |
|---|---|
| Format | Request and response bodies are JSON. Timestamps are ISO 8601 / RFC 3339 in UTC. |
| IDs | Entities (identities, wallets, alerts, ...) are identified by UUID v4, passed as ?id= on reads and deletes, or as id in the body on writes. |
| Paths | Copy them exactly, trailing slash included: /v1/identity/ and /v1/identity are different routes, and only the first exists. |
| Bodies | A POST or PUT must carry a JSON body, even when the action needs no fields. Send {} in that case: an empty body is not routed and answers 404. |
| Size | Request bodies are capped at 2 MB. |
| Pagination | List endpoints take page (from 1) and limit, and return the total so you can page to the end. Each endpoint documents its own limit cap. |
| Deletes | Identities and wallets are soft-deleted: they move to a trash you can list and restore from. |
Errors
Errors always have the same shape:
{ "error": "A human-readable reason" }| Status | Meaning |
|---|---|
400 | The request is invalid; error says which field and why. |
401 | No valid API key. |
403 | The key is valid but the action is not allowed: it needs an admin (see Permissions) or a signed-in session. |
404 | Unknown route, unknown entity, or a POST/PUT sent without a JSON body. |
500 | The server could not complete the call (for example a write that did not land). Safe to retry. |
503 | Temporarily unavailable. Retry after a short wait (Retry-After when present). |