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

# Use The Swarm in Deepline

> Use your own The Swarm API key. Search returns IDs; fetch retrieves records. Deepline does not bill for The Swarm usage.

[Human guide: work with your agent →](https://deepline.com/docs/human/providers/theswarm/guide.md)
Inspect one The Swarm action before starting provider-backed work. Your first result is a verified input and output contract.

## Provider-specific requirements

Use the workspace's own The Swarm API key. Deepline does not bill for The Swarm usage. The connected account's The Swarm plan and API permissions still apply.

Search returns profile or company IDs. fetch retrieves records for IDs, LinkedIn names, or numeric/entity identifiers supported by that action. V3 fetch uses `linkedin_names`, not the similarly named aliases found in some prose documentation. Fetch batches allow at most 1,000 identifiers. Search uses Elasticsearch Query DSL. when `stable_pagination` is true, the provider documentation requires `limit: 1000`.

Use `linkedinName` for beta profile/company posts and refreshed profile requests. Pass the returned post's `urn` into comments, reactions, or reshares. Request and response pagination names differ by endpoint. Use its exact contract. Company posts use `page`, profile posts use `paginationToken`, and V3 search/relationships use `pagination_token`.

Relationships return connection information scoped to the API-key team. Live responses confirm an object containing `items`, `count`, `total_count`, and an optional `pagination_token`. Provider responses are preserved without flattening or renaming their fields.

Partner mapping, child-team switching/creation, and connector addition are unavailable in this connector. Connector addition is asynchronous but has no documented completion-status API. It is not safe to claim completed mapping from HTTP 202 acceptance.

## Find an applicable action

Confirm your effective workspace, then search the live catalog:

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline auth status --json
deepline search "The Swarm" --type tools --json
```

Search returns candidates. Check the returned provider and operation rather than selecting a similar title automatically.

## Inspect the selected contract

Replace `<returned-tool-id>` with the identifier returned by discovery:

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline describe <returned-tool-id> --json
```

These commands do not execute the selected provider action. Read its required inputs, supported access mode, pricing unit, outputs, and limits.

A connection does not establish that every action supports BYOK. Follow the provider-specific requirements above and the live action contract.

## Prepare one reviewed input

Use one authorized record that matches the inspected schema. Preserve its source identity and define the result you will accept.

Open the action reference for its payload and response shape. Provider-backed execution can incur usage or external effects.

For reusable logic, follow [Write Plays](https://deepline.com/docs/sdk-v2/plays.md). For direct-call recovery, use [Tool execution recovery](https://deepline.com/docs/sdk-v2/tool-execution-recovery.md).

> [!TIP]
>
> Continue only when the workspace, provider, required fields, acceptance rule, and applicable price are understood. Keep unavailable access separate from no-result evidence.


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