jan/docs/openapi/specs/threads.yaml

components:
  schemas:
    ThreadObject:
      type: object
      properties:
        id:
          type: string
          description: |
            "The identifier of the thread, defaults to foldername."

            <span style="color:#0ca47c">OpenAI compatible</span>
          example: thread_....
        object:
          type: string
          description: |
            "Type of the object, defaults to thread."

            <span style="color:#0ca47c">OpenAI compatible</span>
          example: thread
        title:
          type: string
          description: | 
            "A brief summary or description of the thread, defaults to an empty string."

            <span style = "color: #fec928"> Jan </span>
          example: "funny physics joke"
        assistants:
          type: array
          description: | 
            <span style = "color: #fec928"> Jan </span>
          items:
            properties:
              assistant_id:
                type: string
                description: |
                  The identifier of assistant, defaults to "jan"

                  <span style = "color: #fec928"> Jan </span>
                example: jan
              model:
                type: object
                properties:
                  id:
                    type: string
                    description: |
                      <span style = "color: #fec928"> Jan </span>
                    example: ...
                  settings: 
                    type: object
                    description: |
                      Defaults to and overrides assistant.json's "settings" (and if none, then model.json "settings")

                      <span style = "color: #fec928"> Jan </span>
                  parameters:
                    type: object
                    description: |
                      Defaults to and overrides assistant.json's "parameters" (and if none, then model.json "parameters")

                      <span style = "color: #fec928"> Jan </span>
        created:
          type: integer
          format: int64
          description: |
            "Unix timestamp representing the creation time of the thread, defaults to file creation time."

            <span style="color:#0ca47c">OpenAI compatible</span>
          example: 1231231
        metadata:
          type: object
          description: |
            "Metadata associated with the thread, defaults to an empty object."

            <span style="color:#0ca47c">OpenAI compatible</span>
          example: {}

    GetThreadResponse:
      type: object
      properties:
        id:
          type: string
          description: "The identifier of the thread."
          example: thread_abc123
        object:
          type: string
          description: "Type of the object"
          example: thread
        created_at:
          type: integer
          format: int64
          description: "Unix timestamp representing the creation time of the thread."
          example: 1699014083
        assistants:
          type: array
          items:
            type: string
          description: "List of assistants involved in the thread."
          example: ["assistant-001"]
        metadata:
          type: object
          description: "Metadata associated with the thread."
          example: {}
        messages:
          type: array
          items:
            type: string
          description: "List of messages within the thread."
          example: []

    CreateThreadResponse:
      type: object
      properties:
        id:
          type: string
          description: "The identifier of the newly created thread."
          example: thread_abc123
        object:
          type: string
          description: "Type of the object, indicating it's a thread."
          example: thread
        created_at:
          type: integer
          format: int64
          description: "Unix timestamp representing the creation time of the thread."
          example: 1699014083
        metadata:
          type: object
          description: "Metadata associated with the newly created thread."
          example: {}

    ThreadMessageObject:
      type: object
      properties:
        role:
          type: string
          description: |
            "Role of the sender, either 'user' or 'assistant'."

            <span style="color:#0ca47c">OpenAI compatible</span>
          enum: ["user", "assistant"]
        content:
          type: string
          description: |
            "Text content of the message."

            <span style="color:#0ca47c">OpenAI compatible</span>
        file_ids:
          type: array
          items:
            type: string
          description: |
            "Array of file IDs associated with the message, if any."
            
            <span style="color:#0ca47c">OpenAI compatible</span>

    ModifyThreadResponse:
      type: object
      properties:
        id:
          type: string
          description: |
            "The identifier of the modified thread."
          example: thread_abc123
        object:
          type: string
          description: "Type of the object, indicating it's a thread."
          example: thread
        created_at:
          type: integer
          format: int64
          description: "Unix timestamp representing the creation time of the thread."
          example: 1699014083
        metadata:
          type: object
          description: "Metadata associated with the modified thread."
          example: {}

    DeleteThreadResponse:
      type: object
      properties:
        id:
          type: string
          description: "The identifier of the deleted thread."
          example: thread_abc123
        object:
          type: string
          description: "Type of the object, indicating the thread has been deleted."
          example: thread.deleted
        deleted:
          type: boolean
          description: "Indicates whether the thread was successfully deleted."
          example: true