ToolsXpo
ToolsXpo

AI & ML

AI Text Summarizer API

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

GET/v1/text-summarizer8 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 (or a JSON body with POST). Fields marked required must be present; everything else has a sensible default.

NameTypeDefaultDescription
modelstring—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.
aiInstructionsstring—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.
textrequiredstring1–…—The text to summarize.
maxLengthinteger20–2000256Approximate maximum length of the summary, in tokens.

Example request

curl "https://api.toolsxpo.com/v1/text-summarizer?text=hello&maxLength=256" \
  -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": 8 }
}

meta fields (every tool)

FieldTypeDescription
meta.toolstringThe tool id that ran.
meta.authstringHow the call authenticated — `key` for an API key.
meta.creditsnumberEverything this call cost, in credits (both currencies together).
meta.baseCreditsnumberThe tool's own price — the compute-credit part of `credits`.
meta.aiCreditsnumberAI credits spent on a model step. Present only when non-zero.
meta.billedFromstringWhich 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.meterUnitstringMetered tools: what is counted (e.g. `megapixel`).
meta.pricing.creditsPerUnitnumberMetered tools: credits per unit counted.
meta.quota.limitnumberYour plan's allowance for the current period.
meta.quota.usednumberAllowance used so far this period.
meta.quota.remainingnumberAllowance left this period.
meta.quota.resetsAtstring (ISO 8601)When the allowance resets.
meta.quota.creditBalancenumberPurchased credits remaining, used after the allowance.
meta.quota.scopestringWhat the quota belongs to — `account` (your workspace) for API keys.
meta.quota.planstringYour plan id.

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 Summarizer API

Condense long text into a short summary with a Workers AI model. Send the text in text; get the summary in data.summary.

JAVASCRIPT
const res = await fetch("https://api.toolsxpo.com/v1/text-summarizer", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.TOOLSXPO_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ text: longArticle, maxLength: 200 }),
});
const { data } = await res.json();
console.log(data.summary);

Options

  • maxLength — approximate upper bound on the summary length (in tokens). Lower it for a one-liner, raise it for a paragraph.

Tips & gotchas

  • Feed it clean prose. If you're summarising a web page, run url-to-markdown first.
  • It's abstractive AI — it can rephrase and, rarely, drop a nuance. Don't rely on it for legally exact wording.
  • Paid tool (real inference). Cost is per successful call.