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.
  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: [message]
      properties:
        message:
          type: string
          description: The user message to send to the agent
        model:
          type: string
          description: Optional model override
        session_id:
          type: string
          description: Continue an existing session (omit to start a new one)
        stream:
          type: boolean
          default: false
          description: Use SSE streaming for the response

    ChatResponse:
      type: object
      properties:
        session_id:
          type: string
        response:
          type: string
        model:
          type: string
        tokens_in:
          type: integer
        tokens_out:
          type: integer

    Session:
      type: object
      properties:
        id:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        message_count:
          type: integer
        model:
          type: string

    Message:
      type: object
      properties:
        id:
          type: string
        session_id:
          type: string
        role:
          type: string
          enum: [user, assistant, tool]
        content:
          type: string
        created_at:
          type: string
          format: date-time

    Stats:
      type: object
      properties:
        total_sessions:
          type: integer
        active_sessions:
          type: integer
        total_messages:
          type: integer
        tokens_in:
          type: integer
        tokens_out:
          type: integer

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

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

paths:
  /v1/health:
    get:
      tags: [system]
      summary: Health check
      security: []
      responses:
        "200":
          description: Daemon is running
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok

  /v1/version:
    get:
      tags: [system]
      summary: Version information
      security: []
      responses:
        "200":
          description: Version details
          content:
            application/json:
              schema:
                type: object
                properties:
                  version:
                    type: string

  /v1/chat:
    post:
      tags: [agent]
      summary: Send a message to the agent
      description: |
        Non-streaming: returns the full response in one JSON object.
        Streaming: set `stream: true` to receive Server-Sent Events.
      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
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /v1/sessions:
    get:
      tags: [sessions]
      summary: List all sessions
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            default: 20
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
      responses:
        "200":
          description: Paginated session list
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessions:
                    type: array
                    items:
                      $ref: "#/components/schemas/Session"
                  total:
                    type: integer

  /v1/sessions/{id}:
    get:
      tags: [sessions]
      summary: Get a specific session
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Session details
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Session"
        "404":
          description: Session not found
    delete:
      tags: [sessions]
      summary: Delete a session and all its messages
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        "204":
          description: Deleted

  /v1/sessions/{id}/messages:
    get:
      tags: [messages]
      summary: Get messages for a session
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
      responses:
        "200":
          description: Paginated message list
          content:
            application/json:
              schema:
                type: object
                properties:
                  messages:
                    type: array
                    items:
                      $ref: "#/components/schemas/Message"
                  total:
                    type: integer

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