Collections

Describe collection features

Changed on

List feature addresses and metadata available in this collection

get/v1/collections/{collection_identifier}/features

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/collections/{collection_identifier}/features
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

collection_identifierstring required

The ID or name of the collection to describe

Response

Successful Response

Example response

{
  "features": [
    {
      "feature_extractor_name": "text_extractor",
      "inputs": [
        {
          "path": "text",
          "type": "string"
        }
      ],
      "outputs": [
        {
          "dim": 1024,
          "path": "features.text_embedding",
          "type": "vector"
        }
      ],
      "version": "v1"
    }
  ]
}

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5f0afa859e1eRevision changes
    • info

      added the required property // to the response with the status