HireAlpha Public API

Version

1.0.0

Description

Public, unauthenticated surface of HireAlpha. The product's per-user data (calendar, mail, body metrics, actions) is auth-gated and not exposed here. These endpoints let agents and integrators read product metadata and join the waitlist.

Contact

• Name: HireAlpha
• Email: hello@hirealpha.chat
• URL: https://hirealpha.chat/contact

Servers

• Production: https://hirealpha.chat

Paths

/healthz

GET

• Operation ID: healthCheck
• Summary: Liveness probe
• Description: Returns the literal string ok when the service is up. No authentication required.
• Responses:
  • 200:
    • Description: Service is healthy.
    • Content:
      • text/plain:
        • Schema:
          • Type: string
          • Example: "ok"

/api/public/info

GET

• Operation ID: getPublicInfo
• Summary: Product metadata
• Description: Returns the product name, tagline, pricing, and links to agent-facing resources (llms.txt, sitemap, OpenAPI).
• Responses:
  • 200:
    • Description: Product metadata.
    • Content:
      • application/json:
        • Schema:
          • $ref: "#/components/schemas/PublicInfo"

/api/public/personas

GET

• Operation ID: listPersonas
• Summary: List the three personas
• Description: Returns the Friend, Coworker, and Cofounder personas with a description of what each one does.
• Responses:
  • 200:
    • Description: The persona catalog.
    • Content:
      • application/json:
        • Schema:
          • Type: array
          • Items:
            • $ref: "#/components/schemas/Persona"

/api/waitlist

POST

• Operation ID: joinWaitlist
• Summary: Join the waitlist
• Description: Records an email address on the waitlist. Idempotent per email.
• Request Body:
  • Required: true
  • Content:
    • application/json:
      • Schema:
        • Type: object
        • Required: ["email"]
        • Properties:
          • email:
            • Type: string
            • Format: email
            • Description: The address to add.
• Responses:
  • 200:
    • Description: Email recorded.
    • Content:
      • application/json:
        • Schema:
          • Type: object
          • Properties:
            • ok:
              • Type: boolean
  • 400:
    • Description: Missing or invalid email.
    • Content:
      • application/json:
        • Schema:
          • $ref: "#/components/schemas/Error"
  • 503:
    • Description: Storage unavailable.
    • Content:
      • application/json:
        • Schema:
          • $ref: "#/components/schemas/Error"

Components

Schemas

PublicInfo

• Type: object
• Properties:
  • name:
    • Type: string
    • Example: "HireAlpha"
  • tagline: { "type": "string" }
  • pricing:
    • Type: object
    • Properties:
      • perPersonaMonthlyUsd:
        • Type: integer
        • Example: 19
  • resources:
    • Type: object
    • Properties:
      • llmsTxt: { "type": "string" }
      • openapi: { "type": "string" }
      • sitemap: { "type": "string" }
      • developers: { "type": "string" }

Persona

• Type: object
• Properties:
  • id:
    • Type: string
    • Enum: ["friend", "coworker", "cofounder"]
  • name: { "type": "string" }
  • description: { "type": "string" }

Error

• Type: object
• Properties:
  • error: { "type": "string" }