Creed Chatbot API

openapi: 3.2.0
info:
  title: Creed Chatbot API
  description: Creed API - Christian AI Chatbot
  version: 1.0.0
tags:
- name: Chatbot
paths:
  /api/chatbot:
    post:
      tags:
      - Chatbot
      summary: Chatbot Endpoint
      operationId: chatbot_endpoint_api_chatbot_post
      security:
      - HTTPBearer: []
      parameters:
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/chatbot/stream:
    post:
      tags:
      - Chatbot
      summary: Chatbot Stream Endpoint
      description: 'Streamed variant of /chatbot: emits the reply as SSE paragraph events so

        the first bubble renders as soon as the first paragraph is generated. The

        buffered /chatbot endpoint is unchanged and remains the fallback for old

        app versions and for client-side retry.


        Events: meta {conversation_id, protocol} → paragraph {index, text}* →

        done {conversation_id, paragraphs, sources, bible_verses} | error {code,

        message, paragraphs_emitted}. Comment lines (": ping") are heartbeats.


        Mid-stream provider failure emits an error event and persists nothing —

        the client discards the partial bubbles and retries fresh.


        request.sendAudio is deliberately ignored here: voiceover for streamed

        replies is fetched separately by the client (/tts), since audio for a

        reply that is still generating can''t be inlined into the SSE stream.'
      operationId: chatbot_stream_endpoint_api_chatbot_stream_post
      security:
      - HTTPBearer: []
      parameters:
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/chats:
    post:
      tags:
      - Chatbot
      summary: Create Chat
      description: 'Start a fresh, empty chat for the current user.


        Used by "reset conversation": the device adopts this id so the next sync

        doesn''t pull the old transcript back from the server.'
      operationId: create_chat_api_chats_post
      security:
      - HTTPBearer: []
      parameters:
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Chatbot
      summary: Get User Chats
      description: Get all chats for the current authenticated user
      operationId: get_user_chats_api_chats_get
      security:
      - HTTPBearer: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 20
          title: Limit
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/chats/{chat_id}/messages:
    get:
      tags:
      - Chatbot
      summary: Get Chat Messages
      description: 'Get messages for a specific chat


        Args:

        chat_id: The chat ID

        current_user: Authenticated user from dependency injection

        recent: If True, returns the most recent N messages. If False (default), returns oldest N messages.

        limit: Maximum number of messages to return (default 100)

        after: ISO timestamp; only messages newer than this are returned (used by the app to sync incrementally)'
      operationId: get_chat_messages_api_chats__chat_id__messages_get
      security:
      - HTTPBearer: []
      parameters:
      - name: chat_id
        in: path
        required: true
        schema:
          type: string
          title: Chat Id
      - name: recent
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Recent
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 100
          title: Limit
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: After
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/auth/test:
    get:
      tags:
      - Chatbot
      summary: Test Auth
      description: Test endpoint to verify authentication is working
      operationId: test_auth_api_auth_test_get
      security:
      - HTTPBearer: []
      parameters:
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/public/test:
    get:
      tags:
      - Chatbot
      summary: Test Public
      description: Public test endpoint that doesn't require authentication
      operationId: test_public_api_public_test_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/chat/suggestions:
    get:
      tags:
      - Chatbot
      summary: Get Chat Suggestions
      description: 'Get chat suggestions for the Christian companion app in user''s preferred language.


        If conversation_id is provided and has messages, returns contextual suggestions.

        Otherwise returns static suggestions.'
      operationId: get_chat_suggestions_api_chat_suggestions_get
      security:
      - HTTPBearer: []
      parameters:
      - name: conversation_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Conversation Id
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuggestionsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/chatbot/compact:
    post:
      tags:
      - Chatbot
      summary: Compact Conversation
      description: Trigger conversation compaction inline. Called after a successful chat message.
      operationId: compact_conversation_api_chatbot_compact_post
      security:
      - HTTPBearer: []
      parameters:
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompactRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompactResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ChatRequest:
      properties:
        message:
          type: string
          title: Message
          default: ''
        conversation_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Conversation Id
        sendAudio:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Sendaudio
          default: false
        newUser:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Newuser
          default: false
        promptKey:
          anyOf:
          - type: string
          - type: 'null'
          title: Promptkey
          description: Used alongside daily topic quest
        image_ids:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Image Ids
        message_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Message Id
        retriedFromStream:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Retriedfromstream
          description: 'Set by the client when re-sending a message whose streamed attempt failed. The stream route already saved the user message and counted the quota, so the buffered route must not do either again. Contract: the client sets this ONLY after receiving the stream''s meta event — meta is emitted after the save/increment phase, so it is the signal that both actually happened. A stream that failed before meta (HTTP error, dropped connection) persisted nothing and must be retried WITHOUT this flag.'
          default: false
      type: object
      title: ChatRequest
    CompactResponse:
      properties:
        success:
          type: boolean
          title: Success
        messages_compacted:
          type: integer
          title: Messages Compacted
          default: 0
        skipped:
          type: boolean
          title: Skipped
          default: false
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
      type: object
      required:
      - success
      title: CompactResponse
    ChatResponse:
      properties:
        reply:
          anyOf:
          - type: string
          - type: 'null'
          title: Reply
        conversation_id:
          type: string
          title: Conversation Id
        bible_verses:
          items:
            type: string
          type: array
          title: Bible Verses
          default: []
        sources:
          anyOf:
          - items:
              $ref: '#/components/schemas/Source'
            type: array
          - type: 'null'
          title: Sources
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        audio_base64:
          anyOf:
          - type: string
          - type: 'null'
          title: Audio Base64
        message_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Message Id
        reply_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Reply Id
      type: object
      required:
      - conversation_id
      title: ChatResponse
    Source:
      properties:
        title:
          type: string
          title: Title
        url:
          type: string
          title: Url
        snippet:
          anyOf:
          - type: string
          - type: 'null'
          title: Snippet
        favicon:
          anyOf:
          - type: string
          - type: 'null'
          title: Favicon
        domain:
          anyOf:
          - type: string
          - type: 'null'
          title: Domain
      type: object
      required:
      - title
      - url
      title: Source
    CompactRequest:
      properties:
        conversation_id:
          type: string
          title: Conversation Id
      type: object
      required:
      - conversation_id
      title: CompactRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SuggestionsResponse:
      properties:
        suggestions:
          items:
            type: string
          type: array
          title: Suggestions
      type: object
      required:
      - suggestions
      title: SuggestionsResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Supabase JWT token
x-provenance:
  method: harvested
  publisher: Creed
  source: https://api.usecreed.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)