Skip to main content

Embeddings API Documentation

GET: Retrieve Embeddings​

Description​

This route is used to retrieve the Embeddings for a specific Agent.

Method​

GET

Response​

  • Returns a JSON response with the Embeddings or an error message.

Status Codes​

  • 200 OK: Embeddings retrieved successfully.
  • 500 Internal Server Error: Error listing Embeddings.

Throws​

  • An error if request validation or embeddings retrieval fails.

Example cURL​

curl --location 'https://app.ai12z.net/api/Agents/{AgentId}/settings/embeddings' \
--header 'Authorization: Bearer <YOUR_KEY>' \
--data-urlencode 'sort=name' \
--data-urlencode 'page=1' \
--data-urlencode 'limit=10'

PUT: Update a Embeddings​

Description​

This route is used to update an existing Embeddings.

Method​

PUT

Request Body​

Example request body:

{
  "embeddings": "embeddings Name"
}

Response​

  • Returns the updated embeddings.

Status Codes​

  • 200 OK: Embeddings updated successfully.
  • 500 Internal Server Error: Error updating the Embeddings.

Throws​

  • An error if request validation or embeddings update fails.

Example cURL​

curl --location --request PUT 'https://app.ai12z.net/api/Agents/{AgentId}/settings/embeddings' \
--header 'Authorization: Bearer <YOUR_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
            "embeddings": "embeddings Name"
}'
Last updated on