Image Embeddings

Generate image embeddings based on the given image input.

POST /api/ai/v1/embedding/image

cURL

Basic Request

curl --request POST \
  --url https://{subdomain}.domo.com/api/ai/v1/embedding/image \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "image": {
    "data": "<base64 string>",
    "type": "base64",
    "mediaType": "image/png"
  }
}
'

200

{
  "embeddings": [
    [
      0.1,
      0.2,
      0.3,
      0.4,
      0.5
    ]
  ],
  "modelId": "domo.domo_ai.domo-embed-text-multilingual-v1:cohere"
}

Authorizations

X-DOMO-Developer-Token · string · header · required

Body

application/json

Image Embedding AI Service request.

Text Embedding AI Service Request.

input · object[]

The input images to embed.

Show child attributes

model · string

The ID of the model to use for Image Embedding. The specified model must be configured for the Image Embedding AI Service by an Admin.

dimensions · integer<int32>

modelConfiguration · object

Additional model-specific configuration parameter key-value pairs.

Show child attributes

requestId · string<uuid>

Response

200

application/json

EmbeddingAIResponse The generated embeddings and model token usage information.

embeddings · number<double>[][]

modelId · string

modelProviderUsage · object

Show child attributes