Quickstart
Get an API key and call your first tool via SDK or REST in minutes.
Choose SDK (TypeScript) or REST (curl). Account signup, plans, and API keys are in the ToolYour dashboard. Create a free account if needed. Agents: MCP quickstart — same key and quota.
Prerequisites
- ToolYour account with verified email
- Active plan (Free tier: 500 credits/month)
- API key from Dashboard → API Keys
Base URL:
https://api.toolyour.comStep 1 — Get your API key
- Sign in at toolyour.com
- Open Dashboard → API Keys
- Create a key and copy the secret (starts with
ty_)
Store it securely — never commit it or expose it in browser code.
Step 2a — Call a tool with the SDK (recommended for Node/TS)
npm install @toolyour/sdkimport { ToolYour } from "@toolyour/sdk";
const ty = ToolYour({ apiKey: process.env.TOOLYOUR_API_KEY! });
// Text utility
const result = await ty.text.textCaseConverter({
text: "hello world",
case: "uppercase",
});
// SEO
const meta = await ty.seo.metaTagsAnalyzer({
url: "https://example.com",
});Full tool list: SDK Tool Map. Details: TypeScript SDK.
Step 2b — Call a tool with REST (curl)
Text case converter:
curl -X POST "https://api.toolyour.com/api/v1/text-utilities/text-case-converter" \
-H "Content-Type: application/json" \
-H "X-Api-Key: ty_YOUR_KEY_HERE" \
-d '{"text":"hello world","case":"uppercase"}'Document conversion (returns presigned downloadUrl):
curl -X POST "https://api.toolyour.com/api/v1/documents/docx-to-pdf" \
-H "X-Api-Key: ty_YOUR_KEY_HERE" \
-F "[email protected]"Download the file:
curl -L -o report.pdf "DOWNLOAD_URL_FROM_RESULT"Step 3 — Monitor usage
Dashboard → Overview or API Keys — all keys share account quota. See Usage & Plans.
Next steps
- TypeScript SDK · SDK Tool Map
- Calling Tools — JSON vs multipart, file responses
- MCP quickstart
- Tool APIs — categories
- OpenAPI sidebar — schemas for every endpoint