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

# PitchBook: Get Patent Detailed

> Patent Detailed. PitchBook Get Patent Detailed reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Patent Detailed.

<Info>
  Tool ID: `pitchbook_get_patent_detailed`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'pitchbook_get_patent_detailed',
  {
    "patentId": "patent_123"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute pitchbook_get_patent_detailed --input '{
  "patentId": "patent_123"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "patentId": "patent_123",
    "patentTitle": "example",
    "status": "example"
  }
}
```

Use `deepline tools get pitchbook_get_patent_detailed --json` for the latest machine-readable contract.

## Input reference

Retrieves extended description of the specific patent

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.patentId` | `string` | Yes | — | Patent ID |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves extended description of the specific patent",
    "properties": {
      "patentId": {
        "type": "string",
        "description": "Patent ID"
      }
    },
    "required": [
      "patentId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.patentId` | `string` | No | — | — |
| `result.data.patentTitle` | `string` | No | — | — |
| `result.data.status` | `string` | No | — | — |
| `result.data.publicationDate` | `string` | No | — | Format: `date`. |
| `result.data.firstFilingDate` | `string` | No | — | Format: `date`. |
| `result.data.expirationDate` | `string \| null` | No | — | Format: `date`. |
| `result.data.filingAuthorityLocation` | `string` | No | — | — |
| `result.data.cpcSection` | `object \| null` | No | — | — |
| `result.data.cpcSection.code` | `string` | No | — | — |
| `result.data.cpcSection.description` | `string` | No | — | — |
| `result.data.cpcClass` | `object \| null` | No | — | — |
| `result.data.cpcClass.code` | `string` | No | — | — |
| `result.data.cpcClass.description` | `string` | No | — | — |
| `result.data.cpcSubclass` | `object \| null` | No | — | — |
| `result.data.cpcSubclass.code` | `string` | No | — | — |
| `result.data.cpcSubclass.description` | `string` | No | — | — |
| `result.data.currentAssigneeNames` | `array` | No | — | — |
| `result.data.originalAssigneeNames` | `array` | No | — | — |
| `result.data.mostRecentLegalStatus` | `string` | No | — | — |
| `result.data.mostRecentLegalStatusDate` | `string` | No | — | Format: `date`. |
| `result.data.applicationDate` | `string` | No | — | Format: `date`. |
| `result.data.grantDate` | `string` | No | — | Format: `date`. |
| `result.data.familyId` | `string` | No | — | — |
| `result.data.inventors` | `array` | No | — | — |
| `result.data.documentForwardCitations` | `integer` | No | — | Format: `int32`. |
| `result.data.documentBackwardCitations` | `integer` | No | — | Format: `int32`. |
| `result.data.countOfClaims` | `integer` | No | — | Format: `int32`. |
| `result.data.countOfIndependentClaims` | `integer` | No | — | Format: `int32`. |
| `result.data.patentDownloadUrl` | `string` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "patentId": {
            "type": "string"
          },
          "patentTitle": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "publicationDate": {
            "type": "string",
            "format": "date"
          },
          "firstFilingDate": {
            "type": "string",
            "format": "date"
          },
          "expirationDate": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "filingAuthorityLocation": {
            "type": "string"
          },
          "cpcSection": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "code": {
                "type": "string"
              },
              "description": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "cpcClass": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "code": {
                "type": "string"
              },
              "description": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "cpcSubclass": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "code": {
                "type": "string"
              },
              "description": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "currentAssigneeNames": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "originalAssigneeNames": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "mostRecentLegalStatus": {
            "type": "string"
          },
          "mostRecentLegalStatusDate": {
            "type": "string",
            "format": "date"
          },
          "applicationDate": {
            "type": "string",
            "format": "date"
          },
          "grantDate": {
            "type": "string",
            "format": "date"
          },
          "familyId": {
            "type": "string"
          },
          "inventors": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "documentForwardCitations": {
            "type": "integer",
            "format": "int32"
          },
          "documentBackwardCitations": {
            "type": "integer",
            "format": "int32"
          },
          "countOfClaims": {
            "type": "integer",
            "format": "int32"
          },
          "countOfIndependentClaims": {
            "type": "integer",
            "format": "int32"
          },
          "patentDownloadUrl": {
            "type": "string"
          }
        },
        "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` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [PitchBook provider guide](/docs/providers/pitchbook/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


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