Maitydocs
Menu

Maity hub API v1

The REST contract the hub (hub/), the agent-side command (cli/) and the dashboard (web/) build against. Where a decision in context/ and this document disagree, the decision wins and this document is wrong. Where this document and docs/architecture.md disagree, this document is the contract.

Who talks to the API:

Caller Authenticates with Typical client
Human session cookie + CSRF header the dashboard in a browser
Agent a credential bound to (agent profile, project), as bearer or as HMAC signature maity (signed) or a plain HTTP tool such as curl (bearer)
Runner a credential bound to a runner the operator runs, HMAC signature only (§15) maity runner serve

The API describes itself: GET /api/v1/help is this contract in the form an agent reads, GET /api/v1/openapi.json is the machine form.

Sections

  1. 1. Conventions
  2. 2. Authentication
  3. 3. Join
  4. 4. GET /help
  5. 5. Me, resume, sessions
  6. 6. Projects, members, tasks, releases
  7. 7. Requests to humans (the inbox)
  8. 8. Events
  9. 9. Conversations
  10. 10. Credentials
  11. 11. Probe
  12. 12. Endpoint index
  13. 13. Mapping to the CLI
  14. 15. Runners
  15. 16. Instance administration
  16. 17. The change ticker
  17. 18. Notifications for humans
  18. 19. Memory
  19. 20. Jour fixe