Public API

Use Ogma's key-authenticated HTTP API to build integrations and support apps — legacy ticket panels, CRMs, workflow bots, and custom dashboards.

API access is subject to the Developer Terms of Service, including the API access section and Discord's developer terms and policies.

Create an API key

1. Open your server in the Ogma dashboard.
2. Go to Settings → API keys.
3. Select Create key, enter a descriptive name, and pick exactly the scopes the integration needs.
4. Copy the key immediately and store it in your integration's secret manager. Ogma does not show the secret again.

Each key carries its own configurable set of scopes — there are no fixed roles, and you can change a key's scopes at any time without rotating it:

Scope	Grants
tickets:open	Open tickets
tickets:read	List and read tickets, queue, tags, messages, transcripts
tickets:write	Reply, reopen, escalate, claim/unclaim, tag
tickets:close	Close tickets
guild:read	Guild info, staff list, usage, macros
webhooks:manage	Manage webhook subscriptions
knowledge:read	Knowledge Q&A

Authentication

Authorization: Bearer ogma_<keyId>_<secret>

curl https://api.ogma.gg/api/v1/me \
  --header "Authorization: Bearer $OGMA_API_KEY"

Tickets

Method	Path	Scope
GET	/api/v1/tickets	tickets:read
GET	/api/v1/tickets/queue	tickets:read
GET	/api/v1/tickets/tags	tickets:read
GET	/api/v1/tickets/:ticketId	tickets:read
GET	/api/v1/tickets/:ticketId/messages	tickets:read
GET	/api/v1/tickets/:ticketId/transcript	tickets:read
POST	/api/v1/tickets	tickets:open
POST	/api/v1/tickets/:ticketId/messages	tickets:write
POST	/api/v1/tickets/:ticketId/close	tickets:close
POST	/api/v1/tickets/:ticketId/reopen	tickets:write
POST	/api/v1/tickets/:ticketId/escalate	tickets:write
POST	/api/v1/tickets/:ticketId/claim	tickets:write
POST	/api/v1/tickets/:ticketId/unclaim	tickets:write
PATCH	/api/v1/tickets/:ticketId/tags	tickets:write

Open a ticket

curl https://api.ogma.gg/api/v1/tickets \
  --request POST \
  --header "Authorization: Bearer $OGMA_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "ticketTypeId": "customer_support",
    "discordUserId": "189912345678901248",
    "subject": "Billing help",
    "description": "I cannot update my payment method."
  }'

Queue

curl "https://api.ogma.gg/api/v1/tickets/queue?filter=unclaimed" \
  --header "Authorization: Bearer $OGMA_API_KEY"

Filters: all, unclaimed, escalated, awaiting_staff, awaiting_customer, mine (requires assigneeDiscordId).

Claim / reply / close

# Claim (actorDiscordId required — must be staff)
curl https://api.ogma.gg/api/v1/tickets/$TICKET_ID/claim \
  --request POST \
  --header "Authorization: Bearer $OGMA_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{ "actorDiscordId": "189912345678901248" }'

# Reply
curl https://api.ogma.gg/api/v1/tickets/$TICKET_ID/messages \
  --request POST \
  --header "Authorization: Bearer $OGMA_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{ "content": "Looking into this now.", "actorDiscordId": "189912345678901248" }'

# Close
curl https://api.ogma.gg/api/v1/tickets/$TICKET_ID/close \
  --request POST \
  --header "Authorization: Bearer $OGMA_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{ "closeReason": "resolved" }'

Guild

Method	Path	Scope
GET	/api/v1/guild	guild:read
GET	/api/v1/guild/staff	guild:read
GET	/api/v1/guild/usage	guild:read
GET	/api/v1/macros	guild:read

GET /api/v1/guild returns enabled public ticket types. GET /api/v1/guild/staff lists Discord members with staff roles.

Webhooks

Requires a plan that includes webhooks (Plus/Enterprise) and the webhooks:manage scope.

Method	Path
GET	/api/v1/webhooks
POST	/api/v1/webhooks
PATCH	/api/v1/webhooks/:id
DELETE	/api/v1/webhooks/:id

curl https://api.ogma.gg/api/v1/webhooks \
  --request POST \
  --header "Authorization: Bearer $OGMA_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "CRM",
    "url": "https://example.com/ogma-hooks",
    "secret": "your-hmac-secret",
    "events": ["ticket.opened", "ticket.closed", "ticket.escalated"]
  }'

Events: ticket.opened, ticket.escalated, ticket.closed, csat.negative, sla.breach.

Delivery body:

{
  "event": "ticket.opened",
  "guildId": "…",
  "occurredAt": "2026-07-20T12:00:00.000Z",
  "payload": {}
}

When a secret is configured, Ogma sends X-Ogma-Signature: sha256=<hex> — HMAC-SHA256 of the raw request body.

Knowledge

curl https://api.ogma.gg/api/v1/knowledge/ask \
  --request POST \
  --header "Authorization: Bearer $OGMA_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{ "question": "How do I reset my password?" }'

Requires knowledge:read. Returns { question, answer, shouldAnswer, confidence, reasoning }.

Errors

Status	Codes	Meaning
400	invalid_body, invalid_query, invalid_ticket_id	Bad request
401	unauthorized	Missing/invalid/revoked/expired key
402	plan_required	Feature not on current plan
403	missing_scope, actor_not_staff, forbidden	Not allowed
404	ticket_not_found, guild_not_found, webhook_not_found, …	Missing resource
409	ticket_conflict, max_open, categories_full	State conflict
429	rate_limited	Rate limit exceeded
503	bot_not_in_guild, message_failed, …	Discord unavailable

Each key is limited to 60 requests per minute. Ticket opens are limited to 240 per hour per server. Knowledge ask also uses the guild AI completion limit.

Building an app

1. Create a key with the ticket scopes plus guild:read, knowledge:read, and webhooks:manage.
2. Register webhooks for ticket lifecycle events.
3. Poll or push into GET /api/v1/tickets/queue for the inbox.
4. Use claim / messages / close for staff actions; GET /api/v1/guild/staff for assignee pickers.
5. Optionally expose POST /api/v1/knowledge/ask for a docs assistant.