> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pramaan.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> From an API key to your first capability call in three commands.

Sign in to the Pramaan dashboard and copy your API key (`sk_live_...`). New accounts get a
one-time \$1 starter credit, enough to try a few dozen calls.

```bash theme={null}
export PRAMAAN_API_KEY="sk_live_..."
npm install @pramaan/sdk
node --input-type=module -e 'import { Pramaan } from "@pramaan/sdk"; const p = new Pramaan({ apiKey: process.env.PRAMAAN_API_KEY }); console.log(await p.web.search({ query: "open source CRM", limit: 3 }))'
```

You get back a list of results, each with a title, URL and snippet.

## The same call over HTTP

```bash theme={null}
curl https://api.pramaan.dev/v1/capabilities/web.search \
  -H "Authorization: Bearer $PRAMAAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "open source CRM", "limit": 3}'
```

Prefer to click? Every page in the **API reference** tab has a playground that sends the
request with your key.

## In your code

```ts theme={null}
import { Pramaan } from "@pramaan/sdk";

const p = new Pramaan({ apiKey: process.env.PRAMAAN_API_KEY! });

const { results } = await p.web.search({ query: "open source CRM", limit: 5 });
// Same call by id; useful when the id comes from data.
await p.run("web.search", { query: "open source CRM" });
```

The SDK uses only `fetch`, so it runs in Node, Next.js, Bun, Deno, Workers, mobile apps and Tauri.
Keep your API key on the server: never ship it inside a browser or mobile app.

## Next steps

* Find a capability in the **API reference** tab: each page shows its request, result,
  price and an example.
* Run a long capability with [jobs](https://docs.pramaan.dev/guides/jobs.md).
* Connect your own email or payments accounts, and your users' social accounts, with
  [connections](https://docs.pramaan.dev/guides/connections.md).
* Send texts with [numbers and US registration](https://docs.pramaan.dev/guides/numbers.md).
* Check on something you sent or created with [references](https://docs.pramaan.dev/guides/references.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.