openapi.yaml

openapi: "3.1.0"
info:
  title: Hawk Daemon API
  description: |
    HTTP API served by the hawk daemon on port 4590.
    Used by hawk-sdk-go, hawk-sdk-python, and external integrations.
    The daemon must be running (`hawk daemon start`) before calling these endpoints.

    This spec is kept in lockstep with the registered routes in
    internal/daemon; the daemon test suite fails if they drift.
  version: "0.1.0"
  license:
    name: MIT
    url: https://github.com/GrayCodeAI/hawk/blob/main/LICENSE
  contact:
    url: https://github.com/GrayCodeAI/hawk

servers:
  - url: http://localhost:4590
    description: Local daemon (default port)

security:
  - ApiKeyAuth: []
  - BearerAuth: []

components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    BearerAuth:
      type: http
      scheme: bearer

  schemas:
    ChatRequest:
      type: object
      required: [prompt]
      properties:
        prompt:
          type: string
          description: The user prompt to send to the agent
        session_id:
          type: string
          description: Reserved for session continuation (currently ignored; every chat creates a fresh engine session)
        model:
          type: string
          description: Optional model override
        max_turns:
          type: integer
          description: Cap on agent turns for this request
        autonomy:
          type: string
          description: Autonomy preset controlling non-interactive permission approval
        cwd:
          type: string
          description: Working directory for the agent session
        agent:
          type: string
          description: Named agent persona to run

    ChatResponse:
      type: object
      properties:
        session_id:
          type: string
        response:
          type: string
        tokens_in:
          type: integer
        tokens_out:
          type: integer
        turns_taken:
          type: integer
        duration:
          type: string
          description: Wall-clock duration, e.g. "1.234s"

    Session:
      type: object
      description: Lightweight in-memory record of a daemon chat session.
      properties:
        id:
          type: string
        created_at:
          type: string
          format: date-time
        last_used:
          type: string
          format: date-time
        turns:
          type: integer
        cwd:
          type: string

    SessionDetail:
      type: object
      description: Persisted session detail loaded from session storage.
      properties:
        id:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        model:
          type: string
        provider:
          type: string
        cwd:
          type: string
        name:
          type: string
        message_count:
          type: integer
        tool_calls:
          type: integer

    Message:
      type: object
      properties:
        role:
          type: string
          enum: [user, assistant, tool]
        content:
          type: string
        tool_use: {}
        tool_results: {}

    PaginatedMessages:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Message"
        total:
          type: integer
        offset:
          type: integer
        limit:
          type: integer
        has_more:
          type: boolean

    HealthResponse:
      type: object
      properties:
        status:
          type: string
          example: ok
        version:
          type: string
        uptime:
          type: string
        active_sessions:
          type: integer
        started_at:
          type: string

    ReadyResponse:
      type: object
      properties:
        ready:
          type: boolean
        reason:
          type: string
          description: Why the daemon is not ready (omitted when ready)
        uptime:
          type: string

    Stats:
      type: object
      properties:
        total_sessions:
          type: integer
        total_messages:
          type: integer
        total_tool_calls:
          type: integer
        total_cost_usd:
          type: number
        active_days:
          type: integer
        models:
          type: array
          items:
            $ref: "#/components/schemas/ModelStat"

    ModelStat:
      type: object
      properties:
        model:
          type: string
        requests:
          type: integer
        cost_usd:
          type: number

    ReviewRequest:
      type: object
      required: [sha]
      properties:
        sha:
          type: string
          description: Hex git SHA (7-40 chars) to review
        background:
          type: boolean
        model:
          type: string
        concerns:
          type: string

    ReviewResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
        sha:
          type: string
        status:
          type: string
        message:
          type: string

    ReviewStatusResponse:
      type: object
      properties:
        status:
          type: string
          description: Output of `hawk review status`

    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
        details:
          type: string

tags:
  - name: system
    description: Health and readiness
  - name: agent
    description: Agent chat
  - name: sessions
    description: Session management
  - name: messages
    description: Message history
  - name: stats
    description: Usage statistics
  - name: review
    description: Code review

paths:
  /v1/health:
    get:
      tags: [system]
      summary: Health check
      security: []
      responses:
        "200":
          description: Daemon is running
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HealthResponse"

  /v1/ready:
    get:
      tags: [system]
      summary: Readiness probe
      description: |
        Returns 200 when the daemon can serve chat (engine configured),
        503 with a reason otherwise.
      security: []
      responses:
        "200":
          description: Daemon is ready
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ReadyResponse"
        "503":
          description: Daemon is not ready
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ReadyResponse"

  /v1/chat:
    post:
      tags: [agent]
      summary: Send a prompt to the agent
      description: |
        Non-streaming: returns the full response in one JSON object.
        Streaming: send `Accept: text/event-stream` to receive Server-Sent Events.
        Each request creates a new agent session; there is no standalone
        session-creation endpoint.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ChatRequest"
      responses:
        "200":
          description: Agent response (or SSE stream)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ChatResponse"
            text/event-stream:
              schema:
                type: string
        "400":
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "503":
          description: Engine not configured
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /v1/sessions:
    get:
      tags: [sessions]
      summary: List active daemon sessions
      responses:
        "200":
          description: Array of session records (no pagination envelope)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Session"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /v1/sessions/{id}:
    get:
      tags: [sessions]
      summary: Get a persisted session
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Session detail
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SessionDetail"
        "404":
          description: Session not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    delete:
      tags: [sessions]
      summary: Delete a session
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Session deleted
        "400":
          description: Invalid session id
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "404":
          description: Session not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /v1/sessions/{id}/messages:
    get:
      tags: [messages]
      summary: Get session messages with pagination
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: limit
          in: query
          schema:
            type: integer
        - name: offset
          in: query
          schema:
            type: integer
      responses:
        "200":
          description: Paginated message list
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PaginatedMessages"
        "404":
          description: Session not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /v1/stats:
    get:
      tags: [stats]
      summary: Aggregated usage statistics
      responses:
        "200":
          description: Usage stats
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Stats"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /v1/review:
    post:
      tags: [review]
      summary: Trigger an asynchronous code review of a commit
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ReviewRequest"
      responses:
        "200":
          description: Review accepted
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ReviewResponse"
        "400":
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /v1/review/status:
    get:
      tags: [review]
      summary: Get current review status
      responses:
        "200":
          description: Review status text
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ReviewStatusResponse"
        "500":
          description: Status command failed
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"