# Docs - Veezee

Everything to call Veezee's LinkedIn, Reddit, and X tools over MCP or REST.

## Index

- Connect your client (verified install snippets per MCP host): https://veezee.io/docs/clients
- Platforms: https://veezee.io/docs/linkedin, https://veezee.io/docs/reddit, https://veezee.io/docs/x
- Field reference: https://veezee.io/docs/fields
- Auth reference: https://veezee.io/auth.md
- Error reference: https://veezee.io/docs/errors
- OpenAPI: https://veezee.io/openapi.json
- SDK: https://veezee.io/docs/sdk
- CLI: https://veezee.io/docs/cli
- Agent skills: https://veezee.io/docs/skills
- Pricing: https://veezee.io/pricing
- AGENTS.md: https://veezee.io/AGENTS.md

## Getting started

Fastest path: fetch https://veezee.io/agent-setup/prompt.md and follow the setup instructions. The steps below are the same setup inline.

### 1. Mint a free key

```
curl -s -X POST https://api.veezee.io/v1/keys/mint
```

No signup, no card, no human: one call returns a key, shown once, plus ready-made setup snippets. The CLI does this for you (`npx @veezee/sdk init`) and stores the key in `~/.veezee/config`.

### 2. Call the API

```
curl "https://api.veezee.io/v1/linkedin/profiles?identifier=williamhgates" \
  -H "Authorization: Bearer $VEEZEE_API_KEY"
```

The free key runs under a shared budget of 200 credits per IP per day, recent data only, no realtime, no `Idempotency-Key` needed. Call without a key and the response is a machine-readable `KEY_REQUIRED` error carrying this exact recipe, so any agent self-heals in one round-trip.

### 3. Or connect over MCP

```
https://mcp.veezee.io/linkedin
```

transport: streamable-http, same free budget as REST. Claude Code, claude.ai, and other clients that support the MCP authorization spec open a browser sign-in automatically (email code, no password, no card, no key to copy). Other clients: put the key from step 1 in your MCP client's connection headers.

### 4. Hit the daily cap? Buy credits

The error names `upgrade_url`: https://veezee.io/upgrade. Pick a pack and pay: checkout credits the same key, nothing to reconfigure. Send it as `Authorization: Bearer <api_key>` on every REST call (plus an `Idempotency-Key` header on metered routes), or in your MCP client's connection headers. That checkout is the only human step in the product.

Default path: use MCP when your host supports it, the SDK otherwise, REST as the fallback; the CLI and skills are conveniences layered on top of those.

## Platforms

- [LinkedIn](https://veezee.io/docs/linkedin): Structured people and company data for outreach, recruiting, and research.
- [Reddit](https://veezee.io/docs/reddit): Discussions and comment-level sentiment: what people actually say about a product, problem, or brand, straight from the comments.
- [X (formerly Twitter)](https://veezee.io/docs/x): Volume and recency: a deep chronological sweep across the whole platform, not just one community.

## Tools

- **linkedin_resolve_url** (2 credits): Identify a LinkedIn URL. [/docs/tools/linkedin_resolve_url](https://veezee.io/docs/tools/linkedin_resolve_url)
- **linkedin_get_profile** (4 credits): Get a LinkedIn person profile. [/docs/tools/linkedin_get_profile](https://veezee.io/docs/tools/linkedin_get_profile)
- **linkedin_search_people** (10 credits): Search people on LinkedIn. [/docs/tools/linkedin_search_people](https://veezee.io/docs/tools/linkedin_search_people)
- **linkedin_get_company** (4 credits): Get a LinkedIn company. [/docs/tools/linkedin_get_company](https://veezee.io/docs/tools/linkedin_get_company)
- **linkedin_get_posts** (4 credits): Get recent posts by a person or company. [/docs/tools/linkedin_get_posts](https://veezee.io/docs/tools/linkedin_get_posts)
- **reddit_search** (6 credits): Search Reddit posts, comments, subreddits, or users. [/docs/tools/reddit_search](https://veezee.io/docs/tools/reddit_search)
- **reddit_get_subreddit** (4 credits): Get subreddit details. [/docs/tools/reddit_get_subreddit](https://veezee.io/docs/tools/reddit_get_subreddit)
- **reddit_get_subreddit_posts** (4 credits): Get a subreddit's posts. [/docs/tools/reddit_get_subreddit_posts](https://veezee.io/docs/tools/reddit_get_subreddit_posts)
- **reddit_get_user** (4 credits): Get a Reddit user. [/docs/tools/reddit_get_user](https://veezee.io/docs/tools/reddit_get_user)
- **reddit_get_post** (4 credits): Get Reddit posts by id, with optional discussion thread. [/docs/tools/reddit_get_post](https://veezee.io/docs/tools/reddit_get_post)
- **reddit_resolve_url** (2 credits): Identify a Reddit URL. [/docs/tools/reddit_resolve_url](https://veezee.io/docs/tools/reddit_resolve_url)
- **x_search** (6 credits): Search X (formerly Twitter). [/docs/tools/x_search](https://veezee.io/docs/tools/x_search)
- **x_get_profile** (4 credits): Get an X profile. [/docs/tools/x_get_profile](https://veezee.io/docs/tools/x_get_profile)
- **x_get_tweets** (4 credits): Get an account's tweets. [/docs/tools/x_get_tweets](https://veezee.io/docs/tools/x_get_tweets)
- **x_get_tweet** (4 credits): Get one tweet with full metrics. [/docs/tools/x_get_tweet](https://veezee.io/docs/tools/x_get_tweet)
- **x_resolve_url** (2 credits): Identify an X URL. [/docs/tools/x_resolve_url](https://veezee.io/docs/tools/x_resolve_url)
- **get_usage** (0 credits): Check credits and recent charges. [/docs/tools/get_usage](https://veezee.io/docs/tools/get_usage)

## Reference

- Connect your client (verified install snippets per MCP host): https://veezee.io/docs/clients
- Use cases (candidate sourcing, prospect enrichment, company research, brand monitoring, market research): https://veezee.io/use-cases/candidate-sourcing
- Field reference (every field Veezee actually serves, by entity): https://veezee.io/docs/fields
- Auth reference (every REST or CLI call needs a key, minted free; MCP clients that support the authorization spec sign in over the browser instead): https://veezee.io/auth.md
- Error reference (every error code, when it happens, and how to recover): https://veezee.io/docs/errors
- OpenAPI (the machine-readable REST contract): https://veezee.io/openapi.json
- SDK (npm install @veezee/sdk, typed TypeScript client): https://veezee.io/docs/sdk
- CLI (the veezee command, every tool as a subcommand): https://veezee.io/docs/cli
- Agent skills (installable SKILL.md packs for recurring jobs): https://veezee.io/docs/skills
- Pricing + cost examples: https://veezee.io/pricing
- AGENTS.md (non-obvious rules for agents calling Veezee): https://veezee.io/AGENTS.md