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

# API Overview

> Read Plyne intent signals, leads, and monitored accounts from your product or workflow.

The Plyne API is designed around the same jobs your team handles in the dashboard: find buyers showing intent, track accounts that matter, and pull the context needed for timely outreach.

Setup stays in the dashboard. The API gives you a clean read layer for Signal Agents, Leads, Monitored Accounts, Custom Signals, and detected account signals.

## What Plyne tracks

Plyne tracks two kinds of GTM movement:

| Product area       | Answers                                             | API output                                      |
| ------------------ | --------------------------------------------------- | ----------------------------------------------- |
| Intent Signals     | Which leads are showing buying intent now?          | Signal Agents and qualified Leads               |
| Monitored Accounts | What changed in the accounts we already care about? | Monitored Accounts and detected account signals |

### Intent Signals

Intent Signals find buying-intent leads across keywords, sources, watched profiles, and signal types. Your team configures Signal Agents in the dashboard. The API lets you read those Signal Agents and pull the qualified Leads they surface.

Examples of what Intent Signals can track:

* leads engaging with relevant topics, posts, companies, or watched profiles
* leads matching your target title, seniority, geography, and ICP criteria
* companies hiring for roles that suggest a new initiative
* companies showing funding, launch, expansion, technology, or category activity
* leads tied to a specific sheet, signal type, or source your team configured

### Monitored Accounts

Monitored Accounts are the companies your team has chosen to track over time. Your team adds accounts and defines Custom Signals in the dashboard. Plyne evaluates those accounts and surfaces detected account signals when something worth acting on appears.

Examples of what Custom Signals can track across Monitored Accounts:

* hiring for sales, engineering, security, compliance, or other target roles
* expansion into a new country, region, market, or customer segment
* launches of new products, features, pricing pages, integrations, or partnerships
* mentions of competitors, tools, migrations, compliance, procurement, or security
* new public evidence that an account is entering an active buying window

## Base URL

```http theme={null}
https://api.plyne.ai
```

All endpoints require an organization-scoped API key:

```bash theme={null}
Authorization: Bearer plyne_...
Content-Type: application/json
```

## Quickstart

Read the newest Leads by Date found, matching the Leads Directory default order:

```bash cURL theme={null}
curl --request POST \
  --url 'https://api.plyne.ai/v1/signals/leads' \
  --header 'Authorization: Bearer plyne_...' \
  --header 'Content-Type: application/json' \
  --data '{
    "cursor": { "limit": 10 }
  }'
```

Read the newest detected account signals from Monitored Accounts:

```bash cURL theme={null}
curl --request POST \
  --url 'https://api.plyne.ai/v1/monitor/signals' \
  --header 'Authorization: Bearer plyne_...' \
  --header 'Content-Type: application/json' \
  --data '{
    "cursor": { "limit": 10 }
  }'
```

## Dashboard and API responsibilities

| In the dashboard                                 | In the API                    |
| ------------------------------------------------ | ----------------------------- |
| Create and edit Signal Agents                    | Read Signal Agents            |
| Configure ICP, signal types, sources, and sheets | Read qualified Leads          |
| Add and manage Monitored Accounts                | Read Monitored Accounts       |
| Create and edit Custom Signals                   | Read detected account signals |
| Manage API keys                                  | Authenticate API requests     |

## Sections

<CardGroup cols={2}>
  <Card title="Signals" icon="radar" href="/signals/overview">
    Intent Signals and Signal Agents that continuously surface qualified Leads.
  </Card>

  <Card title="Monitor" icon="activity" href="/monitor/overview">
    Monitored Accounts and detected account signals from Custom Signals.
  </Card>

  <Card title="Leads" icon="users-round" href="/signals/leads">
    Qualified leads with embedded company details and source context.
  </Card>

  <Card title="API Basics" icon="gauge" href="/api/authentication">
    Authentication, pagination, and shared filtering conventions.
  </Card>
</CardGroup>

## Endpoint surface

### Signals

| Method | Endpoint               | Use when                                                                             |
| ------ | ---------------------- | ------------------------------------------------------------------------------------ |
| POST   | `/v1/signals/agents`   | You need the Signal Agents configured in the dashboard.                              |
| POST   | `/v1/signals/leads`    | You want to sync qualified Leads into your CRM, outbound tool, product, or workflow. |
| POST   | `/v1/signals/accounts` | You want Accounts Directory rows with dashboard-equivalent filters and sorting.      |

### Monitor

| Method | Endpoint                     | Use when                                             |
| ------ | ---------------------------- | ---------------------------------------------------- |
| POST   | `/v1/monitor/accounts`       | You need the list of Monitored Accounts.             |
| POST   | `/v1/monitor/leads`          | You need the list of Monitored Leads.                |
| POST   | `/v1/monitor/signals`        | You want account signal history from Custom Signals. |
| POST   | `/v1/monitor/custom-signals` | You need the Custom Signals available for filtering. |

## Common patterns

\| Pattern | Behavior |
\| --- | --- | --- |
\| Authentication | Send `Authorization: Bearer plyne_...` with every request. |
\| Pagination | List endpoints use request-body cursor pagination. |
\| Filtering | Directory endpoints use `date_found` and `latest_signal`; monitored entity endpoints use `latest_activity`; signal-history rows use `observed_at`. Unknown fields return `400 InvalidArgument`. |
\| Scope | Every response is scoped to the organization that owns the API key. |

## Dashboard label to API field

| Dashboard label | API field         | Meaning                                                                      |
| --------------- | ----------------- | ---------------------------------------------------------------------------- |
| Date found      | `date_found`      | When the entity first entered the Directory.                                 |
| Latest signal   | `latest_signal`   | When the latest matching distinct material signal was created.               |
| Latest activity | `latest_activity` | The combined activity time used by Monitored Leads and Accounts.             |
| Observed at     | `observed_at`     | The timestamp of one concrete signal-history row.                            |
| AI score        | `ai_score`        | Inclusive score range or `ai_score` sort field on Directory endpoints.       |
| Signal          | `signals`         | Source IDs on Directory endpoints and definition IDs on Monitored endpoints. |
| Sheet           | `sheet_ids`       | Directory sheet/source-list IDs.                                             |

## Current limitations

* No API endpoint to create or edit Signal Agents.
* No API endpoint to create or edit Custom Signals.
* No API endpoint to add or edit Monitored Accounts.
* No run-start endpoint in the first API version.
* Use filters on list endpoints instead of deep nested result endpoints.
