Search Foundation Models

Embed text, images, audio, video or PDFs as dense vectors.

model selects the request shape as well as the model: each one below lists the inputs and options it accepts.

post/v1/embeddings

Request

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "embedding_type": "float",
  "input": [
    "A beautiful sunset over the beach",
    "Jina AI - Your Search Foundation - Supercharged"
  ],
  "model": "jina-embeddings-v2-base-en",
  "normalized": true,
  "truncate": false
}

Response

Successful Response

modelstring required

The model used to generate the embeddings.

objectstring

Object type, always list.

Changes

    • breaking

      removed from the request body oneOf list

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 400

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 401

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 403

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 404

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 409

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 429

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 500

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 503

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 504

    • breaking

      response property errors list-of-types was widened by adding types null to media type application/json of response 422

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 400

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 401

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 403

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 404

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 409

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 429

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 500

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 503

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 504

    • info

      removed elser-v2 mapping keys from the request discriminator

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      added jina-embeddings-v5-omni-small jina-embeddings-v5-omni-nano mapping keys to the request discriminator

    • info

      added to the /// request property anyOf list

    • info

      added to the / request property anyOf list

    • info

      added the new jina-embeddings-v5-omni-nano enum value to the request property /

    • info

      added the new jina-embeddings-v5-omni-small enum value to the request property /

    • info

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

    • info

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