REST API Overview

The Hype Doc REST API lets you create, read, update, and delete wins, spaces, and tags programmatically.

Base URL

https://app.myhypedoc.com/api/v1

All requests require a Bearer token in the Authorization header:

GET /api/v1/wins HTTP/1.1
Host: app.myhypedoc.com
Authorization: Bearer hdoc_xxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

Generate tokens in Settings → API Tokens. See Authentication for details.

Send JSON with Content-Type: application/json. All request bodies use a root key matching the resource name:

{
  "win": {
    "body": "Shipped the feature",
    "space_id": 1
  }
}

All responses return JSON. Successful responses return the resource directly (or an array for list endpoints). Error responses return an error key:

{
  "error": "Not found"
}

List endpoints support pagination via query parameters:

Parameter	Default	Range	Description
`page`	`1`	1+	Page number
`per_page`	`25`	1–100	Items per page

Pagination metadata is returned in response headers:

See Pagination for more details.

Every response includes rate limit headers:

Header	Description
`X-RateLimit-Limit`	Max requests per window
`X-RateLimit-Remaining`	Requests remaining
`X-RateLimit-Reset`	Unix timestamp when the window resets

See Rate Limits for limits per endpoint.

All API responses include:

Cache-Control: private, no-store
Vary: Authorization, Accept

API responses are never cached by intermediaries.