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

# PredictLeads: Product

> Get the details of one company product, given its ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get the details of one company product, given its ID.

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

## 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(
  'predictleads_product',
  {
    "id": "123e4567-e89b-42d3-a456-426614174000"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute predictleads_product --input '{
  "id": "123e4567-e89b-42d3-a456-426614174000"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe predictleads_product --json` for the complete live contract.

## Input reference

Returns a single Product.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | Product's ID. Format: `uuid`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns a single Product.",
    "properties": {
      "id": {
        "type": "string",
        "description": "Product's ID.",
        "format": "uuid"
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | PredictLeads provides data on the products offered by more than 2 million companies. |
| `result.data.data` | `array` | Yes | — | — |
| `result.data.data[].id` | `string` | Yes | — | ID of the `Product` object. Format: `uuid`. |
| `result.data.data[].type` | `"product"` | Yes | — | Type of the `Product` object. |
| `result.data.data[].attributes` | `object` | Yes | — | Attributes of the `Product` object. |
| `result.data.data[].attributes.category` | `"product" \| "service" \| "solution" \| "unclassified"` | Yes | — | Category classified to `product`, `service` or `solution`. If the product cannot be classified, this field will be `unclassified`. Allowed: `product`, `service`, `solution`, `unclassified`. |
| `result.data.data[].attributes.description` | `string \| null` | Yes | — | Short description of the product. |
| `result.data.data[].attributes.name` | `string` | Yes | — | Name of the product. |
| `result.data.data[].attributes.sources` | `"menu" \| "pricing"` | Yes | — | Array of source types where the `Product` has been found on. Allowed: `menu`, `pricing`. |
| `result.data.data[].attributes.source_url` | `string` | Yes | — | URL where the product was found on. Format: `uri`. |
| `result.data.data[].attributes.first_seen_at` | `string` | Yes | — | Date & time (ISO 8601) when the `Product` was discovered. Format: `date-time`. |
| `result.data.data[].attributes.last_seen_at` | `string` | Yes | — | Date & time (ISO 8601) when the Product's page was last visited. Format: `date-time`. |
| `result.data.data[].relationships` | `object` | Yes | — | The data contains references to related objects listed in the `included` property. |
| `result.data.data[].relationships.company` | `object` | Yes | — | The data contains a reference to related `CompanyLite` object listed in the `included` property. |
| `result.data.data[].relationships.company.data` | `object` | Yes | — | — |
| `result.data.data[].relationships.company.data.id` | `string` | Yes | — | ID of the included `CompanyLite` object. Format: `uuid`. |
| `result.data.data[].relationships.company.data.type` | `"company"` | Yes | — | Type of the included `CompanyLite` object. |
| `result.data.included` | `array` | Yes | — | Contains objects referenced in property `relationships`. |
| `result.data.included[].id` | `string` | Yes | — | ID of the `CompanyLite` object. Format: `uuid`. |
| `result.data.included[].type` | `"company"` | Yes | — | Type of the `CompanyLite` object. |
| `result.data.included[].attributes` | `object` | Yes | — | Attributes of the `CompanyLite` object. |
| `result.data.included[].attributes.domain` | `string` | Yes | — | Company domain name. |
| `result.data.included[].attributes.company_name` | `string \| null` | Yes | — | Company name if available. |
| `result.data.included[].attributes.ticker` | `string \| null` | Yes | — | Company stock symbol (ticker) if available. |
| `result.data.meta` | `object` | No | — | Meta information about `ProductsDataset` object. |
| `result.data.meta.schema_version` | `string` | Yes | — | Represents schema version of objects. |
| `result.data.meta.record_state` | `"active"` | Yes | — | Represents record state of objects. |
| `result.data.meta.count` | `integer` | No | — | Total number of results. **NOTE**: Only included in API responses when the request parameter `page` is provided, for performance reasons. |
| `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": "PredictLeads provides data on the products offered by more than 2 million companies.",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "The `Product` object.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "ID of the `Product` object.",
                  "format": "uuid"
                },
                "type": {
                  "description": "Type of the `Product` object.",
                  "const": "product"
                },
                "attributes": {
                  "type": "object",
                  "description": "Attributes of the `Product` object.",
                  "properties": {
                    "category": {
                      "description": "Category classified to `product`, `service` or `solution`. If the product cannot be classified, this field will be `unclassified`.",
                      "enum": [
                        "product",
                        "service",
                        "solution",
                        "unclassified"
                      ]
                    },
                    "description": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Short description of the product."
                    },
                    "name": {
                      "type": "string",
                      "description": "Name of the product."
                    },
                    "sources": {
                      "description": "Array of source types where the `Product` has been found on.",
                      "enum": [
                        "menu",
                        "pricing"
                      ]
                    },
                    "source_url": {
                      "type": "string",
                      "description": "URL where the product was found on.",
                      "format": "uri"
                    },
                    "first_seen_at": {
                      "type": "string",
                      "description": "Date & time (ISO 8601) when the `Product` was discovered.",
                      "format": "date-time"
                    },
                    "last_seen_at": {
                      "type": "string",
                      "description": "Date & time (ISO 8601) when the Product's page was last visited.",
                      "format": "date-time"
                    }
                  },
                  "required": [
                    "category",
                    "description",
                    "name",
                    "sources",
                    "source_url",
                    "first_seen_at",
                    "last_seen_at"
                  ],
                  "additionalProperties": false
                },
                "relationships": {
                  "type": "object",
                  "description": "The data contains references to related objects listed in the `included` property.",
                  "properties": {
                    "company": {
                      "type": "object",
                      "description": "The data contains a reference to related `CompanyLite` object listed in the `included` property.",
                      "properties": {
                        "data": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "ID of the included `CompanyLite` object.",
                              "format": "uuid"
                            },
                            "type": {
                              "description": "Type of the included `CompanyLite` object.",
                              "const": "company"
                            }
                          },
                          "required": [
                            "id",
                            "type"
                          ],
                          "additionalProperties": false
                        }
                      },
                      "required": [
                        "data"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "required": [
                    "company"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "id",
                "type",
                "attributes",
                "relationships"
              ],
              "additionalProperties": false
            }
          },
          "included": {
            "type": "array",
            "description": "Contains objects referenced in property `relationships`.",
            "items": {
              "type": "object",
              "description": "The `CompanyLite` object.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "ID of the `CompanyLite` object.",
                  "format": "uuid"
                },
                "type": {
                  "description": "Type of the `CompanyLite` object.",
                  "const": "company"
                },
                "attributes": {
                  "type": "object",
                  "description": "Attributes of the `CompanyLite` object.",
                  "properties": {
                    "domain": {
                      "type": "string",
                      "description": "Company domain name."
                    },
                    "company_name": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Company name if available."
                    },
                    "ticker": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Company stock symbol (ticker) if available."
                    }
                  },
                  "required": [
                    "domain",
                    "company_name",
                    "ticker"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "id",
                "type",
                "attributes"
              ],
              "additionalProperties": false
            }
          },
          "meta": {
            "type": "object",
            "description": "Meta information about `ProductsDataset` object.",
            "properties": {
              "schema_version": {
                "type": "string",
                "description": "Represents schema version of objects."
              },
              "record_state": {
                "type": "string",
                "description": "Represents record state of objects.",
                "const": "active"
              },
              "count": {
                "type": "integer",
                "description": "Total number of results. **NOTE**: Only included in API responses when the request parameter `page` is provided, for performance reasons."
              }
            },
            "required": [
              "schema_version",
              "record_state"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "data",
          "included"
        ],
        "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.56` per pricing unit.

## Related documentation

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