Sign in

v1

latestOpenAPI 3.0.02026-07-228239173.7 KB
Client API v2

Generate embeddings for one or more input texts.

post/api/v2/embeddings

Headers

Accept'application/json' required

Request body

modelstring required

The embedding model to use. Available models can be retrieved via the GET /api/v1/client/models endpoint.

return_result_in_responseboolean nullable

If true, the embedding result will be returned directly in the response instead of only download url. Optional parameter.

webhook_urlstring uri nullable

Optional HTTPS URL to receive webhook notifications for job status changes (processing, completed, failed). Must be HTTPS. Max 2048 characters. See Webhook Documentation for payload structure and authentication details.

webhook_secretstring nullable

Optional per-request HMAC secret (min. 32 chars) used to sign the webhook callback. When present, overrides the account-default webhook secret. Requires webhook_url to also be set.

Example request

{
  "input": "This is a sample text for embedding generation.",
  "model": "Bge_M3_FP16",
  "webhook_url": "https://your-server.com/webhooks/deapi",
  "webhook_secret": "a1b2c3d4e5f60708091a2b3c4d5e6f7081920a1b2c3d4e5f60708091a2b3c4d5"
}

Response

ID of the inference request.

Example response

{
  "data": {
    "request_id": "c08a339c-73e5-4d67-a4d5-231302fbff9a"
  }
}