Writing
URL to Markdown API
GET request to /v1/url-to-markdown, returning json in the standard envelope.
GET
/v1/url-to-markdown40 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 |
|---|---|---|---|
| urlrequired | string | — | Page URL to render and convert to Markdown, e.g. https://example.com. |
Example request
curl "https://api.toolsxpo.com/v1/url-to-markdown?url=https%3A%2F%2Fexample.com" \
-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": 40 }
}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 URL → Markdown API
Render a page in a real browser and get clean Markdown of its main content back in data.markdown — ideal for feeding pages into an LLM, a RAG index, or a content pipeline without shipping a headless browser yourself.
Bashcurl "https://api.toolsxpo.com/v1/url-to-markdown?url=https://example.com" \ -H "Authorization: Bearer $TOOLSXPO_KEY"
Why Markdown (not raw HTML)
- It's already stripped of boilerplate, scripts and styling, so it's far cheaper to send to a model.
- Headings, lists, links and code blocks survive, so structure is preserved for chunking and retrieval.
Pairs well with
text-summarizer— summarise the Markdown you just extracted.text-embeddings— embed each section for semantic search.
Tips & gotchas
- Single-page apps that render everything client-side work here (unlike a plain
fetch), because a real browser executes the JS first. data.lengthgives the character count, handy for budgeting model tokens.