Appwrite Embeddings API
Embedding generation used by VectorsDB similarity search, metered in embedding tokens per model. 1 operations across 1 paths in the Appwrite 2.0.0 OpenAPI.
Embedding generation used by VectorsDB similarity search, metered in embedding tokens per model. 1 operations across 1 paths in the Appwrite 2.0.0 OpenAPI.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/appwrite-embeddings-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 2.0.0
title: Appwrite Embeddings API
description: Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to https://appwrite.io/docs
termsOfService: https://appwrite.io/policy/terms
contact:
name: Appwrite Team
url: https://appwrite.io/support
email: team@appwrite.io
license:
name: BSD-3-Clause
url: https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE
servers:
- url: https://cloud.appwrite.io/v1
description: Appwrite Cloud endpoint.
- url: https://{region}.cloud.appwrite.io/v1
description: Appwrite Cloud regional endpoint. Replace `{region}` with your project region.
variables:
region:
default: fra
description: Appwrite Cloud region.
tags:
- name: Embeddings
description: ''
paths:
/embeddings/text:
post:
summary: Create text embeddings
operationId: embeddingsCreateTextEmbeddings
tags:
- Embeddings
description: Generate vector embeddings for an array of text using the selected embedding model. Use the returned vectors to power semantic search and similarity queries against your vector collections.
responses:
'200':
description: Embedding list
content:
application/json:
schema:
$ref: '#/components/schemas/embeddingList'
deprecated: false
x-appwrite:
group: embeddings
demo: embeddings/create-text-embeddings.md
rate-limit: 120
rate-time: 60
rate-key: ip:{ip},method:{method},url:{url},userId:{userId}
scope: embeddings.write
platforms:
- console
- server
packaging: false
public: true
methods:
- name: createTextEmbeddings
namespace: embeddings
platforms:
- console
- server
desc: Create Text Embedding
auth:
console:
Project: []
server:
Project: []
Key: []
parameters:
- texts
- model
required:
- texts
responses:
- code: 200
model: '#/components/schemas/embeddingList'
description: 'Generate vector embeddings for an array of text using the selected embedding model. Use the returned vectors to power semantic search and similarity queries against your vector collections.
'
demo: embeddings/create-text-embeddings.md
public: true
auth:
console:
Project: []
server:
Project: []
Key: []
security:
- Project: []
Key: []
JWT: []
requestBody:
content:
application/json:
schema:
type: object
properties:
texts:
description: Array of text to generate embeddings.
type: array
items:
type: string
model:
description: The embedding model to use for generating vector embeddings.
type: string
default: nomic-embed-text
example: nomic-embed-text
title: EmbeddingModel
oneOf:
- type: string
enum:
- nomic-embed-text
title: nomic-embed-text
- type: string
enum:
- all-minilm
title: all-minilm
required:
- texts
components:
schemas:
embeddingList:
description: Embedding list
type: object
properties:
total:
type: integer
description: Total number of embeddings that matched your query.
format: int32
example: 5
embeddings:
type: array
description: List of embeddings.
items:
$ref: '#/components/schemas/embedding'
example: []
required:
- total
- embeddings
example:
total: 5
embeddings: ''
embedding:
description: Embedding
type: object
properties:
model:
type: string
description: Embedding model used to generate embeddings.
example: nomic-embed-text
dimension:
type: integer
description: Number of dimensions for each embedding vector.
format: int32
example: 768
embedding:
type: array
description: Embedding vector values. If an error occurs, this will be an empty array.
items:
type: number
format: double
example:
- 0.01
- 0.02
- 0.03
error:
type: string
description: Error message if embedding generation fails. Empty string if no error.
example: Error message
required:
- model
- dimension
- embedding
- error
example:
model: nomic-embed-text
dimension: 768
embedding:
- 0.01
- 0.02
- 0.03
error: Error message
securitySchemes:
Project:
type: apiKey
name: X-Appwrite-Project
description: Your project ID
in: header
x-appwrite:
platforms:
- client
- server
- console
demo: <YOUR_PROJECT_ID>
ProjectPath:
type: apiKey
name: project
description: Your project ID
in: query
x-appwrite:
location: path
param: project_id
platforms:
- client
- server
- console
demo: <YOUR_PROJECT_ID>
JWT:
type: apiKey
name: X-Appwrite-JWT
description: Your secret JSON Web Token
in: header
x-appwrite:
platforms:
- client
- server
- console
demo: <YOUR_JWT>
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: The OAuth access token to authenticate with
x-appwrite:
platforms:
- client
- server
- console
Locale:
type: apiKey
name: X-Appwrite-Locale
description: ''
in: header
x-appwrite:
platforms:
- client
- server
- console
demo: en
Session:
type: apiKey
name: X-Appwrite-Session
description: The user session to authenticate with
in: header
x-appwrite:
platforms:
- client
- server
- console
DevKey:
type: apiKey
name: X-Appwrite-Dev-Key
description: Your secret dev API key
in: header
x-appwrite:
platforms:
- client
- server
- console
Cookie:
type: apiKey
name: Cookie
description: The user cookie to authenticate with. Used by SDKs that forward an incoming Cookie header in server-side runtimes.
in: header
x-appwrite:
platforms:
- client
- server
- console
ImpersonateUserId:
type: apiKey
name: X-Appwrite-Impersonate-User-Id
description: Impersonate a user by ID
in: header
x-appwrite:
platforms:
- client
- server
- console
ImpersonateUserEmail:
type: apiKey
name: X-Appwrite-Impersonate-User-Email
description: Impersonate a user by email
in: header
x-appwrite:
platforms:
- client
- server
- console
ImpersonateUserPhone:
type: apiKey
name: X-Appwrite-Impersonate-User-Phone
description: Impersonate a user by phone
in: header
x-appwrite:
platforms:
- client
- server
- console
Key:
type: apiKey
name: X-Appwrite-Key
description: Your secret API key
in: header
x-appwrite:
platforms:
- server
- console
- manager
demo: <YOUR_API_KEY>
Organization:
type: apiKey
name: X-Appwrite-Organization
description: Your organization ID
in: header
x-appwrite:
platforms:
- server
- console
demo: <YOUR_ORGANIZATION_ID>
ForwardedUserAgent:
type: apiKey
name: X-Forwarded-User-Agent
description: The user agent string of the client that made the request
in: header
x-appwrite:
platforms:
- server
Mode:
type: apiKey
name: X-Appwrite-Mode
description: ''
in: header
x-appwrite:
platforms:
- console
demo: ''
Platform:
type: apiKey
name: X-Appwrite-Platform
description: The platform type (Appwrite or Imagine)
in: header
x-appwrite:
platforms:
- console
externalDocs:
description: Full API docs, specs and tutorials
url: https://appwrite.io/docs