Skip to content
Reference SurfaceDocsDocumentation, policies, and product reference material.
Reference Surface

The current RoseTech API contract.

The API separates safe discovery responses from authenticated write operations. Tokens, API keys, and signing secrets are never included in this public reference.

Reference areas4
API, bot operations, service policies, and platform policy routes.
Service policies6
Each listed service has direct links to its existing policy documents.
GET · Public

Uptime discovery

GET /uptime returns the service name, supported heartbeat method, bot identifier sources, and configured bot keys. HEAD returns 204.

POST · Token

Heartbeat ingestion

POST /uptime accepts bot, timestamp or ts, shard, database state, guild count, and additional status fields. Authenticate with X-Uptime-Token or a Bearer token.

POST · API key

Ticket transcript intake

POST /tickets requires X-RoseTech-Api-Key and JSON fields for token, guild, ticket, thread, opener, category, timestamps, closer, plain text, and HTML. A successful response returns the public transcript URL.

Errors

Response behavior

JSON errors use the appropriate HTTP status: 400 for invalid payloads, 401 for failed authentication, 404 for unknown bot identifiers, and 405 for unsupported methods.

Focus

Highlights

  • Send application/json for write endpoints.
  • Use Unix seconds for timestamps; heartbeat ingestion also normalizes millisecond timestamps.
  • Treat returned transcript tokens as public-view identifiers and never as API credentials.