---
title: "Ask the in-app guide: it answers and may point at the next thing to click"
method: POST
path: "/v1/guide/ask"
---

# Ask the in-app guide: it answers and may point at the next thing to click

`POST /v1/guide/ask`

## Request

- Base URL: `https://api.octapi.app`
- URL: `https://api.octapi.app/v1/guide/ask`
- Auth: HTTP bearer

## Request body

- object
  - `question` string
  - `report` object[]
    - `action` 'go_to' | 'highlight' | 'finish', required
    - `screen` string
    - `ok` boolean
    - `target` string
    - `outcome` 'clicked' | 'timed_out' | 'not_found'
  - `state` object, required
    - `screen` string, required
    - `visible` string[], required
    - `facts` object, required
  - `thread` string, nullable

## Response `200`

Default Response

- object
  - `text` string, required
  - `actions` unknown[], required
    - unknown
  - `thread` string, required

---

[API](https://skmtc.dev/octapi/apis/octapi-api.md) · [All operations](https://skmtc.dev/octapi/apis/octapi-api/llms.txt) · [OpenAPI document](https://skmtc.dev/octapi/apis/octapi-api/revisions/580afda787d2?raw)