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

# Quickstart

> Get your first LinkedIn search results in under 2 minutes.

## What is Edges?

Edges is the API for LinkedIn automation and data enrichment. One API call to:

<CardGroup cols={4}>
  <Card title="Extract" icon="download">
    Profiles, posts, companies
  </Card>

  <Card title="Enrich" icon="sparkles">
    Add LinkedIn data to your SaaS or agent
  </Card>

  <Card title="Automate" icon="robot">
    Messages, invites, follows
  </Card>

  <Card title="Search" icon="magnifying-glass">
    Find leads at scale
  </Card>
</CardGroup>

<Tip>
  **No LinkedIn account setup required** — start with `identity_mode: "managed"` and upgrade later.
</Tip>

<Card title="Use our documentation MCP" icon="gem" href="/mcp">
  Add Edges Documentation to your AI assistant or IDE thanks to our Model Context Protocol server. Best advices directly from the documentation into your IDE !
</Card>

***

## Try it now

Get your API key from [Developer Settings](https://app.edges.run/settings/developers), then run:

<CodeGroup>
  ```bash cURL theme={null}
  curl --request POST \
    --url https://api.edges.run/v1/actions/linkedin-search-people/run/live \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --header 'X-API-Key: YOUR_API_KEY' \
    --data '{
      "identity_mode": "managed",
      "input": {
        "linkedin_people_search_url": "https://www.linkedin.com/search/results/people/?keywords=software%20engineer"
      }
    }'
  ```

  ```typescript TypeScript SDK theme={null}
  import { Edges } from '@edgesrun/sdk';

  const ed = new Edges({ apiKey: process.env.EDGES_API_KEY! });

  const { data } = await ed.linkedin.searchPeople({
    identity_mode: "managed",
    input: {
      linkedin_people_search_url: "https://www.linkedin.com/search/results/people/?keywords=software%20engineer"
    }
  });

  console.log(data);
  ```
</CodeGroup>

<Check>
  **Success!** If you see an array of LinkedIn profiles, you're ready to build.
</Check>

### What you'll get back

```json theme={null}
[
  {
    "full_name": "John Doe",
    "linkedin_profile_url": "https://www.linkedin.com/in/johndoe",
    "job_title": "Senior Software Engineer",
    "company_name": "Tech Company",
    "headline": "Software Engineer | Full Stack Developer",
    "location": "San Francisco Bay Area",
    "connection_degree": "2nd"
  }
]
```

<Note>
  **Managed mode cost:** Using `identity_mode: "managed"` costs 1.5× standard credits but requires zero setup. Perfect for getting started.
</Note>

<Info>
  **Built-in protection:** Edges applies **Smart Limits** to protect LinkedIn accounts from restrictions automatically. [Learn more](/v1/linkedin/limits).
</Info>

***

## How it works

<Steps>
  <Step title="Choose an Action">
    Browse [60+ Actions](/v1/api/actions) for LinkedIn, Sales Navigator, and data enrichment.
  </Step>

  <Step title="Pick an Identity Mode">
    Use `managed` (no setup), your users' accounts (`direct`), or rotate your accounts (`auto`).
  </Step>

  <Step title="Make the API call">
    Send a POST request with your input. Results return in real-time.
  </Step>

  <Step title="Process results">
    Each successful result consumes credits — [see how billing works](https://support.edges.run/en/articles/12398360-understanding-how-credits-are-billed).
  </Step>
</Steps>

***

## Identity modes explained

Most Actions require a LinkedIn account to execute. Edges gives you three options:

| Mode      | Setup                        | Cost                   | Best for                                         |
| --------- | ---------------------------- | ---------------------- | ------------------------------------------------ |
| `managed` | None                         | 1.5× credits           | Getting started, testing, hassle-free automation |
| `direct`  | Connect your users' accounts | Standard               | User-specific outreach, personal accounts        |
| `auto`    | Rent accounts from Edges     | \$70-125/mo + standard | High-volume, dedicated bandwidth                 |

<Accordion title="Using your own LinkedIn accounts">
  For production use or user-specific actions (sending messages, invitations):

  1. [Create an Identity](/v1/api/identities/create) to represent your user
  2. [Connect their LinkedIn](/v1/api/integrations/connect) via Chrome Extension or API
  3. Use `identity_ids: ["identity_uid"]` instead of `identity_mode: "managed"`

  **Full guide:** [LinkedIn Identity Options](/v1/identities/sync-vs-managed)
</Accordion>

***

## Handling errors

The API uses consistent error responses across all endpoints:

```json theme={null}
{
  "error_label": "INVALID_INPUT",
  "error_scope": "input",
  "error_ref": "ERR-12345",
  "message": "The provided input is invalid.",
  "status_code": 400
}
```

| Status | Meaning                                               |
| ------ | ----------------------------------------------------- |
| `200`  | Success                                               |
| `400`  | Bad request — check your input                        |
| `401`  | Invalid or missing API key                            |
| `424`  | LinkedIn-specific error (check `error_label`)         |
| `500`  | Server error — [contact us](mailto:support@edges.run) |

<Tip>
  Use `error_label` and `error_scope` for programmatic error handling. See the full [Error Reference](/v1/error-reference).
</Tip>

***

## What's next?

<CardGroup cols={2}>
  <Card title="Explore Actions" icon="bolt" href="/v1/api/actions">
    Browse 60+ LinkedIn, Sales Navigator, and enrichment actions
  </Card>

  <Card title="TypeScript SDK" icon="code" href="/v1/sdk">
    Type-safe SDK with autocomplete for faster development
  </Card>

  <Card title="Async & Batch Processing" icon="clock" href="/v1/runs/overview">
    Process thousands of records with callbacks
  </Card>

  <Card title="Core Concepts" icon="book" href="/v1/core-concepts">
    Deep dive into Identities, Integrations, and Runs
  </Card>
</CardGroup>

***

## Need help?

* **Email:** [support@edges.run](mailto:support@edges.run)
* **Full API Reference:** [/v1/api/introduction](/v1/api/introduction)
* **Troubleshooting:** [FAQ & Common Issues](/v1/faq-troubleshooting)
* **Ask your AI tools** about Edges Documentation thanks to our MCP : [Edges MCP](/mcp)