Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Support Agent

Read the guide of the chat

The places of your product that the chat can show a customer: each one a page by its path, with words that say what is there. An element with data-troopy-guide and the name of the place gets the ring. readsPage says whether a message of the chat carries the names of the links and buttons of the page of the customer. Not found while Liquid SaaS is off.

get/api/v1/support-liquid/guides

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy liquid guides
MCP tooltroopy_get_liquid_guides
Rate limit60 calls in 60 seconds, for each key

Response

200 · application/json
data*object
3 properties
guides*array<object>
5 properties
name*string
about*string

At least 1 characters · At most 120 characters

path*string

At most 200 characters

mark*enum<string> | null

found: a page of the website had the mark of the place. missing: a customer pressed Show me, and its page had no mark. Null: no visitor opened the page yet

foundmissing

markAt*string | null

When the chat said so

readsPage*boolean
tours*array<object>

At most 5 items

4 properties
name*string
title*string

At least 1 characters · At most 60 characters

path*string

At most 200 characters

steps*array<object>

At most 4 items

2 properties
to*string
say*string

At least 1 characters · At most 140 characters

Errors

401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask a company owner or admin.
429 rate_limitedWait the number of seconds in Retry-After, then retry.