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

# Quickstart for AI agents

Get an API key and make your first call in a few minutes. No network setup is needed.

## 1. Sign up

Open `app.theswarm.com/api`. Sign in with Google or your work email, and enter the 6-digit code if you used email. On the "Map your team's network" screen, select **Skip To The API**. We create your workspace, generate your API key and start a 14-day trial with 1,000 API credits. You land on the API page.\


## 2. Get your key and team ID

On the API page, select **Reveal API Key** and copy the key. Copy your team ID from the same page. Some endpoints need it.

Send the key in the `x-api-key` header on every request:

```text theme={null}
curl -H "x-api-key: $SWARM_API_KEY" "<endpoint URL from the API reference>"
```

## 3. Know your limits

* **Trial:** 14 days, with 1,000 credits. Calls pause when the credits run out.
* **Credit cost:** 1 credit per record for Profile, Company, Relationships and Daily job changes, and 1 credit per result for Network mapper.
* **Both products share the trial.** Turning on My network later doesn't extend it.\


## 4. Make a first call

Look up a profile by LinkedIn URL with the Profile endpoint. A response includes `fullName`, `title`, `company` and `location`. It costs 1 credit.

## 5. Choose your endpoints

| Group | Endpoint | Returns (example fields) | Needs My network |
| :- | :- | :- | :- |
| Enrichment data | Profile | fullName, title, company, location | No |
| Enrichment data | Company | name, domain, industry, headcount | No |
| Intelligence | Relationships | person, knownBy, strength, source | Yes |
| Intelligence | Network mapper | target, paths, via, strength | Yes |
| Signals | Daily job changes | person, from, to, date | No |

Relationships and Network mapper use your team's mapped network. To use them, select **Set up your network** in the sidebar and follow the steps.

## 6. Use MCP instead of the REST API

MCP lets you use The Swarm inside AI tools with the same key and credits. It is part of the API product. With My network on, answers also show who on your team knows each person.

* **Claude:** copy the MCP server URL, add a connector in Claude's settings (name it "The Swarm", paste the URL and your OAuth Client ID), then select **Allow access**.
* **ChatGPT:** open [The Swarm plugin for ChatGPT](https://chatgpt.com/plugins/plugin_asdk_app_6ae1ca7c9334819198f1246e2791c88d), select **Install plugin**, sign in with your Swarm account, choose your team and select **Allow access**, then start a new chat. See [ChatGPT app](https://docs.theswarm.com/docs/mcp/connect-chatgpt.md) for details.
* **Other tools** (HubSpot, Cursor, Windsurf, your own apps): fill in the request form. OAuth is live for Claude and ChatGPT only.

## If something goes wrong

If the trial can't start, you see a message with [support@theswarm.com](mailto:support@theswarm.com). Contact us and we'll start it for you.


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