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
          maxLength: 128
          pattern: '^[A-Za-z0-9._-]+$'
          description: Durable session ID to continue. The session must already exist; successful continuation returns the same ID.
        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: Existing directory associated with session metadata. The daemon executes tools from its startup working directory; it never performs a process-wide chdir per request.
        agent:
          type: string
          description: Named Hawk agent persona to apply. Continuations inherit the persisted persona when omitted.

    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 active record for a durably persisted 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
        agent:
          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
        agent:
          type: string
        cwd:
          type: string
        name:
          type: string
        message_count:
          type: integer
        tool_calls:
          type: integer

    GraphScope:
      type: object
      properties:
        tenant_id:
          type: string
        project_id:
          type: string
        repository_id:
          type: string

    GraphRef:
      type: object
      required: [kind, id]
      properties:
        kind:
          type: string
          enum: [system, knowledge, execution, policy, quality, operations]
        id:
          type: string

    GraphArtifactRef:
      type: object
      required: [uri]
      properties:
        uri:
          type: string
        digest:
          type: string
        media_type:
          type: string

    GraphProvenance:
      type: object
      required: [producer]
      properties:
        producer:
          type: string
        version:
          type: string
        source_id:
          type: string
        evidence:
          type: array
          items:
            $ref: "#/components/schemas/GraphArtifactRef"

    GraphNode:
      type: object
      required: [id, kind, created_at, provenance]
      properties:
        id:
          type: string
        kind:
          type: string
          enum: [system, knowledge, execution, policy, quality, operations]
        scope:
          $ref: "#/components/schemas/GraphScope"
        created_at:
          type: string
          format: date-time
        effective_at:
          type: string
          format: date-time
        provenance:
          $ref: "#/components/schemas/GraphProvenance"
        attributes:
          type: object
          additionalProperties:
            type: string

    GraphEdge:
      type: object
      required: [id, kind, from, to, created_at, provenance]
      properties:
        id:
          type: string
        kind:
          type: string
          enum: [contains, depends_on, references, produced, governed_by, validated_by]
        from:
          $ref: "#/components/schemas/GraphRef"
        to:
          $ref: "#/components/schemas/GraphRef"
        scope:
          $ref: "#/components/schemas/GraphScope"
        created_at:
          type: string
          format: date-time
        effective_at:
          type: string
          format: date-time
        provenance:
          $ref: "#/components/schemas/GraphProvenance"
        attributes:
          type: object
          additionalProperties:
            type: string

    GraphEvent:
      type: object
      required: [id, type, subject, occurred_at, provenance]
      properties:
        id:
          type: string
        type:
          type: string
          enum: [created, updated, transitioned, observed, deleted]
        subject:
          $ref: "#/components/schemas/GraphRef"
        scope:
          $ref: "#/components/schemas/GraphScope"
        occurred_at:
          type: string
          format: date-time
        correlation_id:
          type: string
        causation_id:
          type: string
        idempotency_key:
          type: string
        provenance:
          $ref: "#/components/schemas/GraphProvenance"

    ExecutionGraph:
      type: object
      required: [schema_version, generated_at, scope, nodes, edges, events]
      properties:
        schema_version:
          type: string
          enum: [hawk.graph/v1]
        generated_at:
          type: string
          format: date-time
        scope:
          $ref: "#/components/schemas/GraphScope"
        nodes:
          type: array
          items:
            $ref: "#/components/schemas/GraphNode"
        edges:
          type: array
          items:
            $ref: "#/components/schemas/GraphEdge"
        events:
          type: array
          items:
            $ref: "#/components/schemas/GraphEvent"

    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: graphs
    description: Portable read-only execution graph projections
  - 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 only when a session factory is configured and Eyrie's local
        preflight confirms provider state, catalog, credentials, and model
        selection are ready. Returns 503 with the failed dependency 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.
        Omit `session_id` to create and durably persist a new session. Supply a
        previously returned `session_id` to load its transcript, append a turn,
        and update that same durable session. The returned JSON field and the
        `X-Hawk-Session-ID` header identify a retrievable `/v1/sessions/{id}`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ChatRequest"
      responses:
        "200":
          description: Agent response (or SSE stream)
          headers:
            X-Hawk-Session-ID:
              description: Durable session ID created or continued by this request.
              schema:
                type: string
          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"
        "404":
          description: Requested continuation session does not exist
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "503":
          description: Engine not configured
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /v1/cancel:
    post:
      tags: [agent]
      summary: Cancel an in-flight generation
      description: |
        Aborts the active generation for the given session, if one is running.
        The per-session generation is otherwise serialized (one at a time);
        this endpoint lets a caller stop a long-running response early.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [session_id]
              properties:
                session_id:
                  type: string
      responses:
        "200":
          description: Generation cancelled (or completed before the request was processed)
          content:
            application/json:
              schema:
                type: object
                properties:
                  cancelled:
                    type: boolean
        "400":
          description: Invalid or missing session_id
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "404":
          description: No active generation for the session
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "429":
          description: Rate limit exceeded
          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/sessions/{id}/graph:
    get:
      tags: [graphs]
      summary: Project a persisted session as a portable execution graph
      description: |
        Returns Hawk's privacy-safe, read-only `hawk.graph/v1` projection.
        Prompt text, tool arguments, tool output, and verification details are
        excluded. Explicit Trace checkpoint IDs are additive to authoritative
        Trace session correlation performed by Hawk.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            maxLength: 128
            pattern: '^[A-Za-z0-9._-]+$'
        - name: repository
          in: query
          description: Optional repository scope override.
          schema:
            type: string
            maxLength: 256
        - name: trace_checkpoint
          in: query
          description: Optional 12-character lowercase hexadecimal Trace checkpoint ID. May be repeated up to 64 times.
          schema:
            type: array
            maxItems: 64
            items:
              type: string
              pattern: '^[0-9a-f]{12}$'
          style: form
          explode: true
      responses:
        "200":
          description: Portable execution graph
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ExecutionGraph"
        "400":
          description: Invalid session, repository, or checkpoint input
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "404":
          description: Session not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "503":
          description: Graph projection is not configured
          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/metrics:
    get:
      tags: [stats]
      summary: Daemon metrics in Prometheus exposition format
      description: |
        Returns daemon-level metrics (request counts, concurrency usage,
        active sessions) as Prometheus text exposition format.
        Use `?format=json` for JSON output.
      responses:
        "200":
          description: Metrics output
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: object
        "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"