ToolsXpo

AI & ML

AI Text Embeddings API

GET request to /v1/text-embeddings, returning json in the standard envelope.

GET/v1/text-embeddings3 credits / call Paid

Authentication

Send your API key as a bearer token. Create one free in the dashboard.

Authorization: Bearer $TOOLSXPO_KEY

Parameters

Sent as query-string parameters. The values below are the examples used throughout this page.

NameExample value
texthello

Example request

curl "https://api.toolsxpo.com/v1/text-embeddings?text=hello" \
  -H "Authorization: Bearer $TOOLSXPO_KEY"

Response

Every endpoint answers with the same envelope. The result is in data (json); meta.credits reports what the call cost.

{
  "ok": true,
  "data": { /* json */ },
  "meta": { "credits": 3 }
}

Errors

Failures use the same envelope with ok: false and a machine-readable code.

StatusCodeMeaning
400invalid_inputA parameter failed validation. `details` lists which.
401unauthorizedMissing or invalid API key.
402quota_exceededOut of credits on this workspace.
404not_foundNo such tool.
429rate_limitedToo many requests. Retry after `Retry-After` seconds.
503service_unavailableTemporarily disabled by an administrator.

How to use the Text Embeddings API

Turn text into a numeric embedding vector for semantic search, clustering, deduplication or RAG. Send text; get the vector in data.embedding and its size in data.dimensions.

Bash
curl "https://api.toolsxpo.com/v1/text-embeddings?text=How%20do%20I%20reset%20my%20password" \
  -H "Authorization: Bearer $TOOLSXPO_KEY"

Using the vector

  • Store each vector alongside its source text in a vector store (or a plain array for small sets).
  • Compare two vectors with cosine similarity — closer to 1 means more semantically similar.
  • Always embed your query with the same model you used for the documents, or the distances are meaningless.

Tips & gotchas

  • Keep each input focused (a sentence, a paragraph, a chunk) rather than a whole document — chunk long text first.
  • data.dimensions tells you the vector size to provision in your store.
  • Paid tool. One vector per call.