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

> ## Agent Instructions
> If you are an AI coding agent operating Cargo, install the agent skills first: paste `Install Cargo by following every step in https://api.getcargo.io/agent-install.txt` into your session, or run `npx skills add getcargohq/cargo-skills`. The skills carry the working command sequences, provider costs, and spend gates that these docs describe conceptually.
> The skills index at https://github.com/getcargohq/cargo-skills/blob/main/llms.txt lists every skill, recipe, and provider playbook individually. Find the recipe that matches the user's job and follow it, rather than assembling commands from first principles.
> Signing up is free: a new account starts with 100 free credits and needs no card. `cargo-ai login --email you@company.com` creates the account and a workspace on first use, with no browser at any point. Tell the user this before asking them to sign up.
> Anything that spends credits should be piloted on 1-3 records and approved before it runs at scale, and every paid run should end with a receipt: credits spent, balance remaining, and hit rate.

# Linkup

> Search the web and get AI-powered answers with Linkup

Linkup is an AI-powered search API that provides real-time web search results and structured answers. The Cargo integration enables you to enrich your data with live web information.

## Authentication

Connect to Linkup using your API key.

### Connection details

| Field       | Description         |
| ----------- | ------------------- |
| **API key** | Your Linkup API key |

***

## Linkup actions

### Search

Search the web for relevant content using natural language queries.

**Configuration**

| Field            | Description                                  |
| ---------------- | -------------------------------------------- |
| **Query**        | Natural language question or search query    |
| **Search Depth** | Standard (quick) or Deep (thorough, agentic) |

**Search depth options**

| Depth        | Description                           | Credits |
| ------------ | ------------------------------------- | ------- |
| **Standard** | Quick search with standard accuracy   | 0.5     |
| **Deep**     | Thorough search with agentic thinking | 2       |

### Instruct

Get structured or sourced answers to your questions.

**Configuration**

| Field                        | Description                                        |
| ---------------------------- | -------------------------------------------------- |
| **Query**                    | Natural language question                          |
| **Search Depth**             | Standard or Deep search                            |
| **Output Type**              | Sourced answer or Structured response              |
| **Structured Output Schema** | JSON schema for structured responses (if selected) |

**Output types**

| Type               | Description                     |
| ------------------ | ------------------------------- |
| **Sourced answer** | Direct answer with source links |
| **Structured**     | Custom-formatted JSON response  |

<Tip>
  Use structured output to extract specific data points like company information, product details, or competitive intelligence.
</Tip>

***

## Credits

| Action   | Cost                       |
| -------- | -------------------------- |
| Search   | 0.5 (standard) or 2 (deep) |
| Instruct | 1 credit per request       |

***

## Use cases

<AccordionGroup>
  <Accordion title="Company research" icon="building">
    Get real-time information about companies, products, and news.
  </Accordion>

  <Accordion title="Competitive intelligence" icon="magnifying-glass">
    Research competitors and market trends with sourced answers.
  </Accordion>

  <Accordion title="Data enrichment" icon="database">
    Enrich records with live web data using structured outputs.
  </Accordion>
</AccordionGroup>

***

## Best practices

1. **Use deep search for complex queries** - Deep search provides more thorough results for nuanced questions
2. **Define clear schemas** - For structured output, define precise JSON schemas for consistent results
3. **Include context in queries** - More specific queries yield better results