openapi: 3.2.0
info:
  title: Hook Pulse API
  version: 1d751aaf
  description: Monitor scheduled tasks and receive alerts for missing check-ins. Read GET /api/ for the API index.
servers:
- url: https://hookpulse.net
tags:
- name: HookPulse
paths:
  /api/:
    get:
      operationId: api_index
      summary: 'Self-describing index: the whole API surface, with quota and quickstart'
      description: 'Returns: { name, description, build, base_url, docs, conventions, auth, endpoints, quota, mcp, mcp_tools, quickstart }'
      security: []
      responses:
        '200':
          description: '{ name, description, build, base_url, docs, conventions, auth, endpoints, quota, mcp, mcp_tools, quickstart }'
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                    description: Product name.
                  description:
                    type: string
                    description: What the product does, in one sentence.
                  build:
                    type: string
                    description: Deployed commit.
                  base_url:
                    type: string
                    description: Origin this API is serving from.
                  docs:
                    type: object
                    description: Links to llms.txt, llms-full.txt, openapi.json, MCP and the UI.
                  conventions:
                    type: object
                    description: Error format, CORS, x402 and the UI↔API parity rule.
                  auth:
                    type: object
                    description: Each authentication mode and how to obtain it.
                  endpoints:
                    type: array
                    items:
                      type: object
                    description: Every endpoint with method, path, auth, absolute URL and what it returns.
                  quota:
                    type: object
                    description: What is free, what costs and how to pay — before you spend a call.
                  mcp:
                    type: object
                    description: Address and transport of the MCP server.
                  mcp_tools:
                    type: array
                    items:
                      type: string
                    description: Name of each MCP tool.
                  quickstart:
                    type: array
                    items:
                      type: string
                    description: The calls that take you from zero to the first monitor.
                required:
                - name
                - description
                - build
                - base_url
                - docs
                - conventions
                - auth
                - endpoints
                - quota
                - mcp
                - mcp_tools
                - quickstart
      tags:
      - HookPulse
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Guest token (`POST /api/guest`) in `X-Guest-Token: hp_…` or `Authorization: Bearer hp_…`. A signed-in account (cookie) also works and takes precedence.'
    globalAccount:
      type: apiKey
      in: cookie
      name: __Host-mm-auth
      description: Global session in the product's HttpOnly cookie; writes require exact Origin and X-CSRF-Token.
    contaChaveApi:
      type: http
      scheme: bearer
      bearerFormat: mmk_…
      description: 'Account API key: `Authorization: Bearer mmk_…` or `X-Api-Key: mmk_…`. Created on the account page (API keys), valid only in the product where it was created; it acts as the account (or the organization that owns it).'
    carteiraAgente:
      type: http
      scheme: bearer
      bearerFormat: mmw_…
      description: 'Wallet credential of an agent without an account (`Authorization: Bearer mmw_…`, 30 days, this product only): POST /api/auth/wallet/agent/start, sign the message with the wallet, POST /api/auth/wallet/agent/token. The owner is `x402:<address>`.'
x-service-info:
  categories:
  - monitoring
  - cron
  - devops
  docs:
    homepage: https://hookpulse.net/
    apiReference: https://hookpulse.net/developers
    llms: https://hookpulse.net/llms.txt