CatalogueResponse

  • data
    Type: object · Catalogue
    required
    • capabilities
      Type: array string[]
      required

      Open derived capability identifiers. Ignore unknown values and enable only capabilities your client understands.

    • id
      Type: string Format: uuid
      required

      Catalogue unique identifier

    • name
      Type: string
      required

      Catalogue name

    • processingFeatures
      Type: object · CatalogueProcessingFeatures
      required

      Immutable per-catalogue processing selection. At least one value must be true. semanticTextIndexing builds text vectors but does not grant search.text until a semantic query API is available.

    • provisioningStatus
      Type: string enum
      read-only
      required

      Infrastructure provisioning lifecycle. Catalogue operations require ready.

      values
      • provisioning
      • ready
      • failed
    • clientId
      Type: string Format: uuid

      Client ID associated with the catalogue

    • createdAt
      Type: string Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • deletedAt
      Type: string | null Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • description
      Type: string | null
    • enabled
      Type: boolean
    • languages
      Type: array string[] · CatalogueLanguage[] 1…5 unique!enum

      Unique supported language codes; English (en) is mandatory when aiProcessing is enabled.

    • purgedAt
      Type: string | null Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • updatedAt
      Type: string Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • success
    enum
    const:  
    true
    required
    values
    • true