> ## 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 Credit News By ID

> Credit News. PitchBook Get Credit News By Id reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Credit News.

<Info>
  Tool ID: `pitchbook_get_credit_news_by_id`
</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_credit_news_by_id',
  {
    "articleId": 123
  },
);

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

### CLI

```bash theme={null}
deepline tools execute pitchbook_get_credit_news_by_id --input '{
  "articleId": 123
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "articleId": 123,
    "title": "VP of Engineering",
    "authors": [
      {
        "authorName": "Example"
      }
    ]
  }
}
```

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

## Input reference

Retrieves full article content for specific article IDs

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.articleId` | `integer` | Yes | — | News articleId |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves full article content for specific article IDs",
    "properties": {
      "articleId": {
        "type": "integer",
        "description": "News articleId"
      }
    },
    "required": [
      "articleId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.articleId` | `integer` | No | — | Format: `int32`. |
| `result.data.title` | `string` | No | — | — |
| `result.data.authors` | `array` | No | — | — |
| `result.data.authors[].authorName` | `string` | No | — | — |
| `result.data.regions` | `array` | No | — | — |
| `result.data.publishDate` | `string` | No | — | Format: `date-time`. |
| `result.data.assetClasses` | `array` | No | — | — |
| `result.data.topics` | `array` | No | — | — |
| `result.data.issuer` | `object \| null` | No | — | — |
| `result.data.issuer.pbId` | `string` | No | — | — |
| `result.data.issuer.name` | `string` | No | — | — |
| `result.data.lender` | `object \| null` | No | — | — |
| `result.data.lender.pbId` | `string` | No | — | — |
| `result.data.lender.name` | `string` | No | — | — |
| `result.data.sponsor` | `object \| null` | No | — | — |
| `result.data.sponsor.pbId` | `string` | No | — | — |
| `result.data.sponsor.name` | `string` | No | — | — |
| `result.data.articleBody` | `string` | No | — | — |
| `result.data.attachments` | `array` | No | — | — |
| `result.data.attachments[].name` | `string` | No | — | — |
| `result.data.attachments[].url` | `string` | No | — | — |
| `result.data.deal` | `object \| null` | No | — | — |
| `result.data.deal.dealId` | `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": {
          "articleId": {
            "type": "integer",
            "format": "int32"
          },
          "title": {
            "type": "string"
          },
          "authors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "authorName": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "regions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "publishDate": {
            "type": "string",
            "format": "date-time"
          },
          "assetClasses": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "topics": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "issuer": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "pbId": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "lender": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "pbId": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "sponsor": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "pbId": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "articleBody": {
            "type": "string"
          },
          "attachments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "deal": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "dealId": {
                "type": "string"
              }
            },
            "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` 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.