Skip to main content
PUT
/
api
/
user
/
embedding
/
{id}
Update embedding
curl --request PUT \
  --url http://localhost:3000/api/user/embedding/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "metadata": {}
}
'
{
  "success": true,
  "embedding": {
    "_id": "<string>",
    "userId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "type": "<string>",
    "model": "<string>",
    "dimensions": 123,
    "metadata": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

id
string
required

Embedding ID to update

Body

application/json
name
string

Updated name

description
string

Updated description

metadata
object

Updated metadata

Response

Embedding updated successfully

success
boolean
Example:

true

embedding
object