Quickstart

Make your first API call in Python, TypeScript, or cURL
View as Markdown

You’ll need your Auxiliar API key. Send it as a bearer token on every request to https://api.auxiliar.ai, and call each tool using its own native API.

Auxiliar splits across two subdomains: accounts.auxiliar.ai handles authentication (sign up and sign in), and panel.auxiliar.ai is your dashboard — where you manage keys and credits.

1

Sign up — free, no card

Create an account at accounts.auxiliar.ai/sign-up. It’s free and takes no credit card. Sign-up sits behind bot protection, so it may require a real browser — if an AI agent reaches this step, hand it off to a human via accounts.auxiliar.ai/sign-up?source=agent_onboarding.

2

Grab your Default key

A Default API key is minted for you automatically the moment you sign up — no extra setup. Find, copy, or rotate it any time at panel.auxiliar.ai/keys.

3

Use it in the call below

Set your Default key as the AUXILIAR_API_KEY environment variable, then run one of the calls below.

Make your first call

This runs a Google search through Serper. Export your key once, then run any of these:

$export AUXILIAR_API_KEY=... # paste your Auxiliar API key
1import os
2import requests
3
4response = requests.post(
5 "https://api.auxiliar.ai/serper/search",
6 headers={"Authorization": f"Bearer {os.environ['AUXILIAR_API_KEY']}"},
7 json={"q": "apple inc"},
8)
9print(response.json())

What success looks like: a 200 response whose body is Serper’s own JSON — an organic array of search results — returned to you unchanged, exactly as the provider sent it. If you see that, your key works and you’re through the gateway.

Keep your API key in an environment variable rather than hardcoding it. A 401 response means the key is missing or unrecognized — see Authentication.

Call any other tool

Every tool uses the same base URL and bearer token; only the path and payload change. Here’s a representative call for each:

ToolExample call
ApifyPOST /apify/v2/acts/{actorId}/run-sync-get-dataset-items — run an actor
Brave SearchGET /brave/web/search?q=coffee — Brave web results
Bright DataPOST /brightdata — Web Unlocker / SERP request
BrowserbasePOST /browserbase/v1/sessions — create a browser session
CrawlbaseGET /crawlbase?url=https://example.com — crawl a page
DataForSEOPOST /dataforseo/v3/serp/google/organic/live/advanced — live SERP
ElevenLabsPOST /elevenlabs/v1/text-to-speech/{voice_id} — text to speech
ExaPOST /exa/search — neural search
FirecrawlPOST /firecrawl/v2/scrape — scrape a URL to markdown
JinaGET /jina/reader/https://example.com — read a URL as markdown
LinkupPOST /linkup/search — AI search
OxylabsPOST /oxylabs — Web Scraper API (realtime)
ParallelPOST /parallel/search — AI search
ScraperAPIGET /scraperapi?url=https://example.com — scrape a page
ScrapflyGET /scrapfly?url=https://example.com — scrape a page
ScrapingBeeGET /scrapingbee?url=https://example.com — scrape a page
SearchAPI.ioGET /searchapi?engine=google&q=coffee — search results
SerpApiGET /serpapi?engine=google&q=coffee — search results
SerperPOST /serper — Google search, images, news, and more
SpiderPOST /spider/scrape — scrape a URL
TavilyPOST /tavily/search — AI web search
You.comGET /youcom/search?query=coffee — search results
ZenRowsGET /zenrows?url=https://example.com — scrape a page
ZytePOST /zyte — scrape / extract

See each tool’s page for its full set of endpoints and parameters.