Skip to content

Models - Embedding


List all embedding models

GET
/api/v1/provider/models/embedding

Retrieve a list of all configured embedding models

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)
or
BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Responses

Successful response

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"models": [
{
"uuid": "string",
"name": "string",
"description": "string",
"requester": "string",
"requester_config": {
},
"api_keys": [
{
}
],
"extra_args": {
},
"created_at": "string",
"updated_at": "string"
}
]
}
}

Playground

Server
Authorization

Samples


Create a new embedding model

POST
/api/v1/provider/models/embedding

Create and configure a new embedding model

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)
or
BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Request Body

application/json
JSON
{
"name": "string",
"description": "string",
"requester": "string",
"requester_config": {
},
"api_keys": [
{
}
],
"extra_args": {
}
}

Responses

Model created successfully

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"uuid": "string"
}
}

Playground

Server
Authorization
Body

Samples


Get a specific embedding model

GET
/api/v1/provider/models/embedding/{model_uuid}

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)
or
BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Parameters

Path Parameters

model_uuid*

Model UUID

Typestring
Required
Format"uuid"

Responses

Successful response

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"model": {
"uuid": "string",
"name": "string",
"description": "string",
"requester": "string",
"requester_config": {
},
"api_keys": [
{
}
],
"extra_args": {
},
"created_at": "string",
"updated_at": "string"
}
}
}

Playground

Server
Authorization
Variables
Key
Value

Samples


Update an embedding model

PUT
/api/v1/provider/models/embedding/{model_uuid}

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)
or
BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Parameters

Path Parameters

model_uuid*

Model UUID

Typestring
Required
Format"uuid"

Request Body

application/json
JSON
{
"name": "string",
"description": "string",
"requester_config": {
},
"api_keys": [
{
}
],
"extra_args": {
}
}

Responses

Model updated successfully

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
}
}

Playground

Server
Authorization
Variables
Key
Value
Body

Samples


Delete an embedding model

DELETE
/api/v1/provider/models/embedding/{model_uuid}

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)
or
BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Parameters

Path Parameters

model_uuid*

Model UUID

Typestring
Required
Format"uuid"

Responses

Model deleted successfully

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
}
}

Playground

Server
Authorization
Variables
Key
Value

Samples


Test an embedding model

POST
/api/v1/provider/models/embedding/{model_uuid}/test

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)
or
BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Parameters

Path Parameters

model_uuid*

Model UUID

Typestring
Required
Format"uuid"

Request Body

application/json
JSON
{
}

Responses

Model test successful

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
}
}

Playground

Server
Authorization
Variables
Key
Value
Body

Samples


Powered by VitePress OpenAPI