---
title: "Help on a topic, generated from this API document [read]"
method: GET
path: "/help"
tags: ["help"]
---

# Help on a topic, generated from this API document \[read\]

`GET /help`

## Request

- Base URL: `https://api.agentsky.dev/v1`
- URL: `https://api.agentsky.dev/v1/help`
- Auth: HTTP bearer

Without topic: the topics (the first segment of every path, plus connectors/<kind> and workflow). With one: its operations, each body's required fields and a skeleton, and one usage line. Aliases: start_session, trigger, identity, singular forms. 404 unknown_topic; 404 connector_not_installed for connectors/<kind> the workspace lacks.

## Query parameters

- `topic` string

## Response `200`

OK

- object
  - `help` Help, required
    - `topic` string, required
    - `usage` string, required: One request to adapt
    - `operations` object[], required
      - `method` string
      - `path` string
      - `summary` string
      - `description` string, nullable
      - `body` object, nullable
        - `required` string[]
        - `example` object
    - `connector` object
      - `kind` string
      - `name` string
      - `origin` string
      - `granted` boolean, nullable
      - `tools` object[]
        - `name` string, required
        - `description` string, required
        - `example` string, nullable, required
    - `notes` string[], required
    - `topics` string[], required

## Other responses

- `default`: Error — { error: { code, message } }

## Changes

- **2026-11-02** `e5e8f0229a99`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/agentsky/apis/agentsky-developer-api/changes/help/get.md)

---

[API](https://skmtc.dev/agentsky/apis/agentsky-developer-api.md) - [All operations](https://skmtc.dev/agentsky/apis/agentsky-developer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/agentsky/apis/agentsky-developer-api/revisions/8280a065ef6a?raw)