AI & ML
AI Text Embeddings API
GET request to /v1/text-embeddings, returning json in the standard envelope.
GET
/v1/text-embeddings3 credits / call PaidAuthentication
Send your API key as a bearer token. Create one free in the dashboard.
Authorization: Bearer $TOOLSXPO_KEYParameters
Sent as query-string parameters (or a JSON body with POST). Fields marked required must be present; everything else has a sensible default.
| Name | Type | Default | Description |
|---|---|---|---|
| model | string | — | Model to use: a model id, a model name, or a tier ("economy", "balanced", "premium"). Ignored if your plan does not include it, in which case the tool's default model runs and the response reports which one answered. |
| aiInstructions | string | — | Your own instructions, added on top of ours — tone, format, domain rules. Charged as input tokens on every call, so a long instruction raises the cost of each request. |
| textrequired | string1–… | — | Text to convert into an embedding vector. |
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 in data, what the call cost and your standing in meta.
{
"ok": true,
"data": { /* json */ },
"meta": { "credits": 3 }
}meta fields (every tool)
| Field | Type | Description |
|---|---|---|
| meta.tool | string | The tool id that ran. |
| meta.auth | string | How the call authenticated — `key` for an API key. |
| meta.credits | number | Everything this call cost, in credits (both currencies together). |
| meta.baseCredits | number | The tool's own price — the compute-credit part of `credits`. |
| meta.aiCredits | number | AI credits spent on a model step. Present only when non-zero. |
| meta.billedFrom | string | Which balance paid: the plan allowance or the purchased credit balance. |
| meta.pricing.mode | "flat" | "metered" | Flat price per call, or metered by usage. |
| meta.pricing.meterUnit | string | Metered tools: what is counted (e.g. `megapixel`). |
| meta.pricing.creditsPerUnit | number | Metered tools: credits per unit counted. |
| meta.quota.limit | number | Your plan's allowance for the current period. |
| meta.quota.used | number | Allowance used so far this period. |
| meta.quota.remaining | number | Allowance left this period. |
| meta.quota.resetsAt | string (ISO 8601) | When the allowance resets. |
| meta.quota.creditBalance | number | Purchased credits remaining, used after the allowance. |
| meta.quota.scope | string | What the quota belongs to — `account` (your workspace) for API keys. |
| meta.quota.plan | string | Your plan id. |
Errors
Failures use the same envelope with ok: false and a machine-readable code.
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_input | A parameter failed validation. `details` lists which. |
| 401 | unauthorized | Missing or invalid API key. |
| 402 | quota_exceeded | Out of credits on this workspace. |
| 404 | not_found | No such tool. |
| 429 | rate_limited | Too many requests. Retry after `Retry-After` seconds. |
| 503 | service_unavailable | Temporarily 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.
Bashcurl "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
1means 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.dimensionstells you the vector size to provision in your store.- Paid tool. One vector per call.