---
title: "Action help"
method: GET
path: "/api/v1/actions/{serviceId}/{actionId}/help"
tags: ["OSDB"]
---

# Action help

`GET /api/v1/actions/{serviceId}/{actionId}/help`

Returns the help text for a given service action

## Path parameters

- `serviceId` string, required
- `actionId` string, required

## Response `200`

Action help text

- ActionHelpResponse
  - `api` string, required — The path of the REST API method
  - `method` string, required — The name of the REST API method
  - `response` ActionHelp, required
    - `action_id` string, required — A unique one word identifier for the action.
    - `help_text` string, required — The help text for the action.
    - `service_id` string, required — A unique one word identifier for the service.
  - `status` 'success', required

## Other responses

- `default` — Error response

---

[API](https://skmtc.net/openlinksw/apis/osdb.md) · [All operations](https://skmtc.net/openlinksw/apis/osdb/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openlinksw/osdb/versions/24e38e614429/schema)