Commands

The /commands endpoint allows you to execute various utility commands including those used to manage embeddings.

Embeddings

Get Embeddings Status

Endpoint: /commands/embeddings/<EMBEDDING_TYPE>/status

Method: GET

Headers

Header	Value
`Authorization`	`Bearer <YOUR_JWT_TOKEN>`

Path Parameters

Parameter	Description
EMBEDDING_TYPE	The type of embedding. Can be `text`, `image`, or `properties`.

Example Request

curl -X GET \
  'https://zeno-server-production.api.becomposable.com/api/v1/commands/embeddings/text/status' \
  -H 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Example Response

{
  "status": "idle",
  "embeddingRunsInProgress": 0,
  "totalRunsInProgress": 0,
  "totalIndexableObjects": 10,
  "embeddingsModels": [
    "text-embedding-ada-002"
  ],
  "objectsWithEmbeddings": 10,
  "vectorIndex": {
    "status": "READY",
    "name": "vsearch_text",
    "type": "hnsw"
  }
}

Code Examples

Get Embeddings Status

curl -X GET \
  'https://zeno-server-production.api.becomposable.com/api/v1/commands/embeddings/text/status' \
  -H 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Activate Embeddings

Endpoint: /commands/embeddings/<EMBEDDING_TYPE>/enable

Method: POST

Headers

Header	Value
`Authorization`	`Bearer <YOUR_JWT_TOKEN>`

Path Parameters

Parameter	Description
EMBEDDING_TYPE	The type of embedding. Can be `text`, `image`, or `properties`.

Input Parameters

Parameter	Data Type	Description
environment	string	The ID of the environment to use for generating embeddings.
max_tokens	number	The maximum number of tokens to use for generating embeddings.
dimensions	number	The number of dimensions to use for the embedding vectors.
model	string	The ID of the model to use for generating embeddings.

Example Request

{
  "environment": "<ENVIRONMENT_ID>",
  "max_tokens": 500,
  "dimensions": 1536,
  "model": "text-embedding-ada-002"
}

Example Response

{
  "status": "success",
  "message": "Embeddings enabled"
}

Code Examples

Activate Embeddings

curl -X POST \
  'https://zeno-server-production.api.becomposable.com/api/v1/commands/embeddings/text/enable' \
  -H 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "environment": "<ENVIRONMENT_ID>",
  "max_tokens": 500,
  "dimensions": 1536,
  "model": "text-embedding-ada-002"
}'

Deactivate Embeddings

Endpoint: /commands/embeddings/<EMBEDDING_TYPE>/disable

Method: POST

Headers

Header	Value
`Authorization`	`Bearer <YOUR_JWT_TOKEN>`

Path Parameters

Parameter	Description
EMBEDDING_TYPE	The type of embedding. Can be `text`, `image`, or `properties`.

Example Request

curl -X POST \
  'https://zeno-server-production.api.becomposable.com/api/v1/commands/embeddings/text/disable' \
  -H 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Example Response

{
  "status": "success",
  "message": "Embeddings disabled"
}

Code Examples

Deactivate Embeddings

curl -X POST \
  'https://zeno-server-production.api.becomposable.com/api/v1/commands/embeddings/text/disable' \
  -H 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Recalculate Embeddings

Endpoint: /commands/embeddings/<EMBEDDING_TYPE>/recalculate

Method: POST

Headers

Header	Value
`Authorization`	`Bearer <YOUR_JWT_TOKEN>`

Path Parameters

Parameter	Description
EMBEDDING_TYPE	The type of embedding. Can be `text`, `image`, or `properties`.

Example Request

curl -X POST \
  'https://zeno-server-production.api.becomposable.com/api/v1/commands/embeddings/text/recalculate' \
  -H 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Example Response

{
  "status": "success",
  "message": "Embeddings recalculation started"
}

Code Examples

Recalculate Embeddings

curl -X POST \
  'https://zeno-server-production.api.becomposable.com/api/v1/commands/embeddings/text/recalculate' \
  -H 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Onboarding

Initialize Samples

Endpoint: /commands/onboarding/init-samples

Method: POST

Headers

Header	Value
`Authorization`	`Bearer <YOUR_JWT_TOKEN>`

Example Request

curl -X POST \
  'https://studio-server-production.api.becomposable.com/api/v1/commands/onboarding/init-samples' \
  -H 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Example Response

{
  "status": "success",
  "message": "Samples initialized"
}

Code Examples

Initialize Samples

curl -X POST \
  'https://studio-server-production.api.becomposable.com/api/v1/commands/onboarding/init-samples' \
  -H 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Namespaces

Check Namespace Availability

Endpoint: /commands/namespaces/<NAMESPACE>/is_available

Method: GET

Headers

Header	Value
`Authorization`	`Bearer <YOUR_JWT_TOKEN>`

Path Parameters

Parameter	Description
NAMESPACE	The namespace to check.

Example Request

curl -X GET \
  'https://studio-server-production.api.becomposable.com/api/v1/commands/namespaces/my-namespace/is_available' \
  -H 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Example Response

{
  "available": true
}

Code Examples

Check Namespace Availability

curl -X GET \
  'https://studio-server-production.api.becomposable.com/api/v1/commands/namespaces/my-namespace/is_available' \
  -H 'Authorization: Bearer <YOUR_JWT_TOKEN>'