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

# Limadata: Research Search

> Run AI web research for a natural-language query and return an answer with ranked source results. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Run AI web research for a natural-language query and return an answer with ranked source results.

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

## 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(
  'limadata_research_search',
  {
    "query": "software companies hiring engineers"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute limadata_research_search --input '{
  "query": "software companies hiring engineers"
}' --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": {
    "answer": "example",
    "results": [
      {
        "title": "VP of Engineering",
        "url": "https://example.com",
        "snippet": "example"
      }
    ]
  }
}
```

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

## Input reference

This endpoint is an AI search tool. It acts as a context retrieval tool for Web content. For a natural language query, it finds online information to answer your query. It has the ability to search the web and fetch URL content to enhance understanding. #### Rate limit This endpoint is exempt from the global rate limit and can support higher concurrency. ### Cost:

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.query` | `string` | Yes | — | Search query string Minimum length: 1. |
| `payload.output_type` | `"SearchResults" \| "SourcedAnswer" \| "Structured"` | No | — | The type of output to return. Allowed: `SearchResults`, `SourcedAnswer`, `Structured`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "This endpoint is an AI search tool. It acts as a context retrieval tool for Web content. For a natural language query, it finds online information to answer your query. It has the ability to search the web and fetch URL content to enhance understanding. #### Rate limit This endpoint is exempt from the global rate limit and can support higher concurrency. ### Cost:",
    "properties": {
      "query": {
        "type": "string",
        "description": "Search query string",
        "minLength": 1
      },
      "output_type": {
        "type": [
          "string",
          "null"
        ],
        "description": "The type of output to return.",
        "enum": [
          "SearchResults",
          "SourcedAnswer",
          "Structured"
        ]
      }
    },
    "required": [
      "query"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.answer` | `string \| null` | No | — | A short answer to the user's query, generated by an LLM. Included in the response only if output\_type is SourcedAnswer. |
| `result.data.results` | `array \| null` | No | — | A list of sorted search results, ranked by relevancy. |
| `result.data.results[].title` | `string \| null` | No | — | — |
| `result.data.results[].url` | `string \| null` | No | — | — |
| `result.data.results[].snippet` | `string \| null` | No | — | — |
| `result.data.results[].extract` | `object \| null` | No | — | — |
| `result.data.results[].extract.url` | `string \| null` | No | — | Original URL that was processed |
| `result.data.results[].extract.title` | `string \| null` | No | — | Page title |
| `result.data.results[].extract.meta_description` | `string \| null` | No | — | Meta description |
| `result.data.results[].extract.favicon` | `string \| null` | No | — | Favicon URL |
| `result.data.results[].extract.content` | `string \| null` | No | — | Cleaned content in Markdown format |
| `result.data.results[].extract.images` | `array \| null` | No | — | List of image URLs found on the page (only present if include\_images was requested) |
| `result.data.results[].extract.links` | `array \| null` | No | — | List of link URLs found on the page (only present if include\_links was requested) |
| `result.data.results[].extract.links[].url` | `string \| null` | No | — | — |
| `result.data.results[].extract.links[].text` | `string \| null` | No | — | — |
| `result.meta` | `object` | 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": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "answer": {
            "type": [
              "string",
              "null"
            ],
            "description": "A short answer to the user's query, generated by an LLM. Included in the response only if output_type is SourcedAnswer."
          },
          "results": {
            "type": [
              "array",
              "null"
            ],
            "description": "A list of sorted search results, ranked by relevancy.",
            "items": {
              "type": "object",
              "properties": {
                "title": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "url": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "snippet": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "extract": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "url": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Original URL that was processed"
                    },
                    "title": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Page title"
                    },
                    "meta_description": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Meta description"
                    },
                    "favicon": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Favicon URL"
                    },
                    "content": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Cleaned content in Markdown format"
                    },
                    "images": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "description": "List of image URLs found on the page (only present if include_images was requested)",
                      "items": {
                        "type": "string"
                      }
                    },
                    "links": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "description": "List of link URLs found on the page (only present if include_links was requested)",
                      "items": {
                        "type": "object",
                        "properties": {
                          "url": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "text": {
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "additionalProperties": false
                      }
                    }
                  },
                  "additionalProperties": false
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0.09` per pricing unit.

## Related documentation

* [Limadata provider guide](https://deepline.com/docs/providers/limadata/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.