> ## 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.

# Exa: Contents

> Scrape web pages by URL: get the text content, summaries, and highlights of company websites, articles, and profile pages.

Scrape web pages by URL: get the text content, summaries, and highlights of company websites, articles, and profile pages.

> [!NOTE]
>
> Tool ID: `exa_contents`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'exa_contents',
  {
    "urls": [
      "https://example.com"
    ],
    "ids": [
      "id_123"
    ],
    "text": true
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute exa_contents --input '{
  "urls": [
    "https://example.com"
  ],
  "ids": [
    "id_123"
  ],
  "text": true
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "requestId": "request_123",
    "results": [
      {
        "id": "id_123",
        "url": "https://example.com",
        "title": "VP of Engineering"
      }
    ],
    "context": "example"
  }
}
```

Use `deepline describe exa_contents --json` for the latest machine-readable contract.

## Input reference

Exa contents input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.urls` | `array` | No | — | URLs to fetch contents for (alias of ids). |
| `payload.ids` | `array` | No | — | Document IDs (or URLs) to fetch contents for. |
| `payload.text` | `boolean \| object` | No | — | — |
| `payload.highlights` | `boolean \| object` | No | — | — |
| `payload.summary` | `object` | No | — | LLM-generated summary of each page (structured output supported). |
| `payload.livecrawl` | `"never" \| "fallback" \| "preferred" \| "always"` | No | — | Live crawl behavior (deprecated in Exa docs. prefer maxAgeHours). Allowed: `never`, `fallback`, `preferred`, `always`. |
| `payload.livecrawlTimeout` | `number` | No | — | Live crawl timeout in milliseconds. |
| `payload.maxAgeHours` | `number` | No | — | Max age (hours) for cached content before live crawl. |
| `payload.subpages` | `number` | No | — | Number of subpages to crawl from each result. |
| `payload.subpageTarget` | `string \| array` | No | — | Subpage keyword(s) to target. |
| `payload.extras` | `object` | No | — | Extra content options. |
| `payload.context` | `boolean \| object` | No | — | Return a combined context string. When true, combines all result contents into one string (10,000+ chars recommended). |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Exa contents input.",
    "properties": {
      "urls": {
        "type": "array",
        "description": "URLs to fetch contents for (alias of ids).",
        "items": {
          "type": "string"
        }
      },
      "ids": {
        "type": "array",
        "description": "Document IDs (or URLs) to fetch contents for.",
        "items": {
          "type": "string"
        }
      },
      "text": {
        "anyOf": [
          {
            "type": "boolean",
            "description": "If true, returns full page text with default settings. If false, disables text return."
          },
          {
            "type": "object",
            "description": "Advanced text extraction options.",
            "properties": {
              "maxCharacters": {
                "type": "number",
                "description": "Maximum characters for full page text (use to cap response size)."
              },
              "includeHtmlTags": {
                "type": "boolean",
                "description": "Include HTML tags in the returned text."
              },
              "verbosity": {
                "type": "string",
                "enum": [
                  "compact",
                  "standard",
                  "full"
                ]
              },
              "includeSections": {
                "type": "array",
                "description": "Only include content from these sections.",
                "items": {
                  "type": "string",
                  "enum": [
                    "header",
                    "navigation",
                    "banner",
                    "body",
                    "sidebar",
                    "footer",
                    "metadata"
                  ]
                }
              },
              "excludeSections": {
                "type": "array",
                "description": "Exclude content from these sections.",
                "items": {
                  "type": "string",
                  "enum": [
                    "header",
                    "navigation",
                    "banner",
                    "body",
                    "sidebar",
                    "footer",
                    "metadata"
                  ]
                }
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "highlights": {
        "anyOf": [
          {
            "type": "boolean",
            "description": "If true, returns highlight snippets with default settings (short evidence excerpts)."
          },
          {
            "type": "object",
            "description": "Advanced highlight extraction options.",
            "properties": {
              "numSentences": {
                "type": "number",
                "description": "Number of sentences per highlight snippet."
              },
              "highlightsPerUrl": {
                "type": "number",
                "description": "Number of highlight snippets per URL."
              },
              "query": {
                "type": "string",
                "description": "Custom query to guide highlight selection."
              },
              "maxCharacters": {
                "type": "number",
                "description": "Maximum characters returned for highlights."
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "summary": {
        "type": "object",
        "description": "LLM-generated summary of each page (structured output supported).",
        "properties": {
          "query": {
            "type": "string",
            "description": "Custom query for the summary."
          },
          "schema": {
            "type": "object",
            "description": "JSON Schema for structured summary output (validated).",
            "additionalProperties": {}
          }
        },
        "additionalProperties": false
      },
      "livecrawl": {
        "type": "string",
        "description": "Live crawl behavior (deprecated in Exa docs; prefer maxAgeHours).",
        "enum": [
          "never",
          "fallback",
          "preferred",
          "always"
        ]
      },
      "livecrawlTimeout": {
        "type": "number",
        "description": "Live crawl timeout in milliseconds."
      },
      "maxAgeHours": {
        "type": "number",
        "description": "Max age (hours) for cached content before live crawl."
      },
      "subpages": {
        "type": "number",
        "description": "Number of subpages to crawl from each result."
      },
      "subpageTarget": {
        "description": "Subpage keyword(s) to target.",
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ]
      },
      "extras": {
        "type": "object",
        "description": "Extra content options.",
        "properties": {
          "links": {
            "type": "number",
            "description": "Number of links to return per result."
          },
          "imageLinks": {
            "type": "number",
            "description": "Number of image links to return per result."
          }
        },
        "additionalProperties": false
      },
      "context": {
        "description": "Return a combined context string. When true, combines all result contents into one string (10,000+ chars recommended).",
        "anyOf": [
          {
            "type": "boolean",
            "description": "If true, returns a combined context string from results. Context strings often perform better than highlights for RAG."
          },
          {
            "type": "object",
            "description": "Context string options. When enabled, combines all result contents into a single string.",
            "properties": {
              "maxCharacters": {
                "type": "number",
                "description": "Maximum characters for the combined context string. Exa recommends 10,000+ characters for best results."
              }
            },
            "additionalProperties": false
          }
        ]
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Exa contents result.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.requestId` | `string` | No | — | — |
| `result.data.results` | `array` | No | — | — |
| `result.data.results[].id` | `string` | No | — | — |
| `result.data.results[].url` | `string` | No | — | — |
| `result.data.results[].title` | `string` | No | — | — |
| `result.data.results[].text` | `string` | No | — | — |
| `result.data.results[].publishedDate` | `string` | No | — | — |
| `result.data.results[].author` | `string \| unknown` | No | — | — |
| `result.data.results[].score` | `number` | No | — | — |
| `result.data.results[].highlights` | `array` | No | — | — |
| `result.data.results[].highlightScores` | `array` | No | — | — |
| `result.data.results[].summary` | `string \| record` | No | — | — |
| `result.data.results[].entities` | `array` | No | — | — |
| `result.data.results[].entities[].id` | `string` | No | — | — |
| `result.data.results[].entities[].type` | `"company" \| "person"` | No | — | Allowed: `company`, `person`. |
| `result.data.results[].entities[].version` | `number` | No | — | — |
| `result.data.results[].entities[].properties` | `record` | No | — | — |
| `result.data.results[].extras` | `record` | No | — | — |
| `result.data.results[].subpages` | `array` | No | — | — |
| `result.data.results[].subpages[].id` | `string` | No | — | — |
| `result.data.results[].subpages[].url` | `string` | No | — | — |
| `result.data.results[].subpages[].title` | `string` | No | — | — |
| `result.data.results[].subpages[].text` | `string` | No | — | — |
| `result.data.results[].subpages[].publishedDate` | `string` | No | — | — |
| `result.data.results[].subpages[].author` | `string \| unknown` | No | — | — |
| `result.data.results[].subpages[].score` | `number` | No | — | — |
| `result.data.results[].subpages[].highlights` | `array` | No | — | — |
| `result.data.results[].subpages[].highlightScores` | `array` | No | — | — |
| `result.data.results[].subpages[].summary` | `string \| record` | No | — | — |
| `result.data.results[].subpages[].entities` | `array` | No | — | — |
| `result.data.results[].subpages[].entities[].id` | `string` | No | — | — |
| `result.data.results[].subpages[].entities[].type` | `"company" \| "person"` | No | — | Allowed: `company`, `person`. |
| `result.data.results[].subpages[].entities[].version` | `number` | No | — | — |
| `result.data.results[].subpages[].entities[].properties` | `record` | No | — | — |
| `result.data.results[].subpages[].extras` | `record` | No | — | — |
| `result.data.context` | `string` | No | — | — |
| `result.meta` | `record` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Exa contents result.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "requestId": {
            "type": "string"
          },
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                },
                "title": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "publishedDate": {
                  "type": "string"
                },
                "author": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {}
                  ]
                },
                "score": {
                  "type": "number"
                },
                "highlights": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "highlightScores": {
                  "type": "array",
                  "items": {
                    "type": "number"
                  }
                },
                "summary": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "object",
                      "additionalProperties": {}
                    }
                  ]
                },
                "entities": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "company",
                          "person"
                        ]
                      },
                      "version": {
                        "type": "number"
                      },
                      "properties": {
                        "type": "object",
                        "additionalProperties": {}
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "extras": {
                  "type": "object",
                  "additionalProperties": {}
                },
                "subpages": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "url": {
                        "type": "string"
                      },
                      "title": {
                        "type": "string"
                      },
                      "text": {
                        "type": "string"
                      },
                      "publishedDate": {
                        "type": "string"
                      },
                      "author": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {}
                        ]
                      },
                      "score": {
                        "type": "number"
                      },
                      "highlights": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "highlightScores": {
                        "type": "array",
                        "items": {
                          "type": "number"
                        }
                      },
                      "summary": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "object",
                            "additionalProperties": {}
                          }
                        ]
                      },
                      "entities": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string"
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "company",
                                "person"
                              ]
                            },
                            "version": {
                              "type": "number"
                            },
                            "properties": {
                              "type": "object",
                              "additionalProperties": {}
                            }
                          },
                          "additionalProperties": false
                        }
                      },
                      "extras": {
                        "type": "object",
                        "additionalProperties": {}
                      }
                    },
                    "additionalProperties": false
                  }
                }
              },
              "additionalProperties": false
            }
          },
          "context": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `per_result` (per result).
* Estimated Deepline credits: `0.02` per pricing unit.

## Related documentation

* [Exa provider guide](https://deepline.com/docs/providers/exa/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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