---
title: "Guide State Endpoint"
method: GET
path: "/guide/state"
tags: ["guide"]
---

# Guide State Endpoint

`GET /guide/state`

## Request

- Base URL: `https://api.framesail.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.framesail.com/guide/state`
- Auth: HTTP bearer

Whether the user is still on their first run ('new') — the app asks for
first-run messages only while they are.

## Response `200`

Successful Response

- GuideState
  - `level` 'new' | 'experienced', required

---

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