# aspire docs api get command

## Name

`aspire docs api get` - Get the full content of an API reference entry by identifier.

## Synopsis

```bash title="Aspire CLI"
aspire docs api get <id> [options]
```

## Description

The `aspire docs api get` command retrieves and displays the full API reference content for a specific entry from [aspire.dev](https://aspire.dev). The content is rendered as Markdown in the terminal.

Use the [`aspire docs api list`](../aspire-docs-api-list/) command to browse available scopes and discover identifiers, or use the [`aspire docs api search`](../aspire-docs-api-search/) command to find identifiers by keyword.

## Arguments

- **`<id>`**

  The identifier of the API reference entry to retrieve. Identifiers are path-based strings derived from the API route structure on `aspire.dev`, for example `csharp/aspire.hosting/iresourcebuilder` or `typescript/aspire.hosting/addredis`.

  Use [`aspire docs api list`](../aspire-docs-api-list/) or [`aspire docs api search`](../aspire-docs-api-search/) to discover valid identifiers.

## Options

The following options are available:

- **`--format <Table|Json>`**

  Output format. Choose `Table` for a human-readable table or `Json` for machine-readable JSON output. Defaults to `Table`.

- <Include relativePath="reference/cli/includes/option-help.md" />

- <Include relativePath="reference/cli/includes/option-log-level.md" />

- <Include relativePath="reference/cli/includes/option-non-interactive.md" />

- <Include relativePath="reference/cli/includes/option-nologo.md" />

- <Include relativePath="reference/cli/includes/option-banner.md" />

- <Include relativePath="reference/cli/includes/option-wait.md" />

## Examples

- Get the API reference for a C# package:

  ```bash title="Aspire CLI"
  aspire docs api get csharp/aspire.hosting
  ```

- Get the API reference for a specific C# type:

  ```bash title="Aspire CLI"
  aspire docs api get csharp/aspire.hosting/iresourcebuilder
  ```

- Get the API reference for a TypeScript module symbol:

  ```bash title="Aspire CLI"
  aspire docs api get typescript/aspire.hosting/addredis
  ```

- Get API content in JSON format:

  ```bash title="Aspire CLI"
  aspire docs api get csharp/aspire.hosting/iresourcebuilder --format Json
  ```

## See also

- [aspire docs api command](../aspire-docs-api/)
- [aspire docs api list command](../aspire-docs-api-list/)
- [aspire docs api search command](../aspire-docs-api-search/)