AppResponse

  • files
    Type: array object[] · Files
    required

    The files associated with this app

    • description
      Type: string · Description
      required

      A description of the file

    • display_name
      Type: string · Display Name
      required

      The display name of the file

    • file_key
      Type: string · File Key
      required

      The key/name of the file

    • file_type
      Type: string · File Type
      required

      The type of file (e.g. PDF)

    • module
      Type: string · Module
      required

      The module this file belongs to

    • object_id
      Type: string · Object Id
      required

      The object identifier for this file

    • size
      Type: integer · Size
      required

      The size of the file in bytes

    • variable_name
      Type: string · Variable Name
      required

      The variable name associated with this file

    • variable_type
      Type: string · Variable Type
      required

      The type of variable this file represents

    • file_id
      Type: string · File Id

      The unique identifier for this file

    • type_id
      Type: string · Type Id

      The type identifier for this file

  • name
    Type: string · Name
    required

    The name of the app

  • prompt_sections
    Type: array object[] · Prompt Sections
    required

    The prompt sections associated with this app

    • body
      Type: string · Body
      required
    • position
      Type: integer · Position
      required

      Integer numbers.

  • user_inputs
    Type: array object[] · User Inputs
    required

    The user inputs associated with this app

    • description
      Type: string · Description
      required

      A description of this input field

    • display_name
      Type: string · Display Name
      required

      The display name shown to users

    • object_id
      Type: string · Object Id
      required

      The unique object identifier for this input

    • position
      Type: integer · Position
      required

      The position/order of this input field

    • required
      Type: boolean · Required
      required

      Whether this input is required

    • variable_name
      Type: string · Variable Name
      required

      The variable name used internally

    • variable_type
      Type: string · Variable Type
      required

      The type of input (e.g. short_answer)

  • constants
    Type: array object[] · Constants

    The constants associated with this app

    • display_name
      Type: string · Display Name
      required

      The display name shown to users

    • object_id
      Type: string · Object Id
      required

      The unique object identifier for this constant

    • value
      Type: string · Value
      required

      The value of this constant

    • variable_name
      Type: string · Variable Name
      required

      The variable name used internally

    • variable_type
      enum
      const:  
      text
      required

      The type of constant (only 'text' supported)

      values
      • text
    • description
      Type: string · Description nullable

      A description of this constant

  • default_model
    Type: string · Default Model

    The default AI model to use

  • description
    Type: string · Description nullable

    The description of the app