---
title: "Get Software Tool by ID"
method: GET
path: "/software-tools/{software_tool_id}"
tags: ["Software Tool"]
---

# Get Software Tool by ID

`GET /software-tools/{software_tool_id}`

## Request

- Base URL: `https://api.renesas.com/web-data/v1`
- URL: `https://api.renesas.com/web-data/v1/software-tools/{software_tool_id}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/renesas/apis/renesas-web-data-api/docs/software-tools/:software_tool_id/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tool_id` string, required

## Response `200`

Successful response

- SoftwareTool
  - `softwareToolName` string: Unique identifier for the software tool (uses full title).
  - `wwwUpdateDate` string: Date the software tool page was last updated on the website.
  - `url` string, uri: Public URL of the software tool page on the Renesas website.
  - `uuid` string: UUID of the software tool.
  - `shortDescription` string: Brief description of the software tool.
  - `description` string: Detailed description of the software tool.
  - `softwareType` string: Type classification of the software tool.
  - `parentSoftwareCategory` string[]: Parent software category name.
  - `features` string: Key features and capabilities of the software tool.
  - `additionalDetails` string, nullable: Additional technical details and specifications.
  - `documentationDetails` string, nullable: Details about documentation and help resources.
  - `downloadDetails` string, nullable: Information about downloads and installation.
  - `releaseInformation` string, nullable: Release notes and version information.
  - `targetDeviceDescription` string, nullable: Description of target devices and compatibility.
  - `discontinued` boolean: Whether the software tool has been discontinued.
  - `externalUrl` string, uri, nullable: External download or information URL.
  - `images` string[]: Array of image URLs for the software tool.
  - `evaluationBoards` object[]: List of compatible boards and kits.
    - `boardKitId` string: Board or kit identifier.
    - `title` string: Board or kit title.
    - `href` string, uri: URL to the board/kit details.
  - `orderableProducts` object[]: List of orderable product parts associated with this board/kit.
    - `orderableId` string: Orderable product part identifier.
    - `href` string, uri: URL to the product part endpoint.
  - `featuredDocuments` object[]: Featured documents associated with the board/kit.
    - `agileId` string: Agile ID of the document.
    - `dcpDocumentId` string, nullable: DCP Document ID, if applicable.
    - `title` string: Document title.
    - `type` string: Document type.
    - `language` string: Document language.
    - `href` string, uri: Public URL of the document file.
  - `relatedDocuments` object[]: Technical documentation associated with the software tool.
    - `agileId` string: Agile ID of the document.
    - `dcpDocumentId` string, nullable: DCP Document ID, if applicable.
    - `title` string: Document title.
    - `type` string: Document type.
    - `language` string: Document language.
    - `href` string, uri: Public URL of the document file.
  - `relatedDocumentsSecondary` object[]: Secondary related documents.
    - `agileId` string: Agile ID of the document.
    - `dcpDocumentId` string, nullable: DCP Document ID, if applicable.
    - `title` string: Document title.
    - `type` string: Document type.
    - `language` string: Document language.
    - `href` string, uri: Public URL of the document file.
  - `relatedSoftwareTools` object[]: Related software tools (primary).
    - `softwareToolName` string: Software tool identifier.
    - `href` string, uri: URL to the software tool details.
  - `relatedSoftwareToolsSecondary` object[]: Related software tools (secondary).
    - `name` string: Software tool identifier.
    - `href` string, uri: URL to the software tool details.
  - `alternative` object, nullable: Alternative software tool.
    - `softwareToolName` string: Alternative tool identifier.
    - `href` string, uri: URL to the alternative tool.
    - `notes` string, nullable: Notes about the alternative.
  - `partner` object[], nullable: Partner information if applicable.
    - `name` string: Partner company name.
    - `url` string, uri, nullable: Partner website URL.
  - `relatedVideos` object[]: Related video content.
    - `videoId` string: Video node ID.
    - `title` string: Video title.
    - `url` string, uri: Video URL.

## Other responses

- `404`: Software tool not found
- `500`: Internal server error

---

[API](https://skmtc.dev/renesas/apis/renesas-web-data-api.md) - [All operations](https://skmtc.dev/renesas/apis/renesas-web-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/renesas/apis/renesas-web-data-api/revisions/4a72e6c49b2c?raw)