Appearance
AI summaries API
A short story and key-moment timeline of a session, written by Claude on request (needs ANTHROPIC_API_KEY on the server). The visitor's identity is never sent to Claude.
All paths are relative to https://your-site.com/api/v1. Send Authorization: Bearer <token> and Accept: application/json; see authentication and errors.
GET /shared/{token}/summary
The AI summary of the public demo's replay (public; 60 per minute)
Only for share links of the public demo's sessions (data.demo of GET /shared/{token}); any other link is 404.
No sign-in needed
This endpoint is public.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
token | path | string | yes | The secret from the share link. Pattern ^[A-Za-z0-9]{40}$. |
Responses
- 200 — The summary (
datais null until one is written). - 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object, nullable | ||
data.summary | string | ||
data.outcome | string | One of: completed, abandoned, struggled, browsed, bounced. | |
data.timeline | object[] | ||
data.timeline[].offset_ms | integer | Time since the session started. | |
data.timeline[].kind | string | One of: navigation, action, frustration, error, milestone. | |
data.timeline[].text | string | ||
data.model | string | ||
data.tokens | object | ||
data.tokens.input | integer | ||
data.tokens.output | integer | ||
data.written_at | string (date-time) | ||
meta | object | ||
meta.available | boolean |
bash
curl -X GET "https://your-site.com/api/v1/shared/{token}/summary" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /shared/{token}/summary
Writes the demo replay's summary with Claude, once (public; 5 per 10 minutes)
Counts toward the demo account's summaries.monthly. An existing summary is answered as it is.
No sign-in needed
This endpoint is public.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
token | path | string | yes | The secret from the share link. Pattern ^[A-Za-z0-9]{40}$. |
Responses
- 200 — The stored summary.
- 201 — Written.
- 403 — The demo account used up its monthly summaries.
- 404 — Missing, or another account's.
- 409 — A summary of this session is being written.
- 502 — Claude could not answer.
- 503 — AI summaries are not set up on this server.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object, nullable | ||
data.summary | string | ||
data.outcome | string | One of: completed, abandoned, struggled, browsed, bounced. | |
data.timeline | object[] | ||
data.timeline[].offset_ms | integer | Time since the session started. | |
data.timeline[].kind | string | One of: navigation, action, frustration, error, milestone. | |
data.timeline[].text | string | ||
data.model | string | ||
data.tokens | object | ||
data.tokens.input | integer | ||
data.tokens.output | integer | ||
data.written_at | string (date-time) | ||
meta | object | ||
meta.available | boolean |
bash
curl -X POST "https://your-site.com/api/v1/shared/{token}/summary" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /sites/{site}/assistant/conversations
The user's Ask AI conversations about the site (plan feature assistant.monthly)
Each user's own conversations, last active first (at most 100). meta.available is false when no Anthropic API key is set.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes |
Responses
- 200 — OK
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].id | integer | ||
data[].title | string | ||
data[].updated_at | string (date-time) | ||
meta | object | ||
meta.available | boolean |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/assistant/conversations" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /sites/{site}/assistant/conversations
Starts a conversation with a question (Claude reads the site's API to answer)
Stores the question and a pending answer and returns at once (202). Claude then answers from the site's own API, read as the asking user with the asking token's abilities (sessions, stats, errors, funnels, journeys, forms, surveys, A/B tests); fetch the conversation until the answer's status is done or failed. Answers are short Markdown whose links are session:<uuid> or dashboard paths of this site. Counts toward assistant.monthly.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
question | string | yes | At least 2 characters. At most 4000 characters. |
Responses
- 202 — The conversation with the pending answer.
- 403 — The plan doesn't include Ask AI, or this month's questions are used up.
- 404 — Missing, or another account's.
- 422 — Validation failed.
- 503 — No Anthropic API key is set.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.title | string | ||
data.updated_at | string (date-time) | ||
data.messages | object[] | ||
data.messages[].id | integer | ||
data.messages[].role | string | One of: user, assistant. | |
data.messages[].status | string | Answers only; a failed answer's content says why. One of: pending, done, failed. | |
data.messages[].content | string | The question, or the answer in Markdown. | |
data.messages[].steps | object[] | The API reads made for the answer so far. | |
data.messages[].created_at | string (date-time) |
bash
curl -X POST "https://your-site.com/api/v1/sites/{site}/assistant/conversations" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"question":"text"}'GET /sites/{site}/assistant/conversations/{conversation}
One conversation with its questions and answers
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
conversation | path | integer | yes |
Responses
- 200 — OK
- 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.title | string | ||
data.updated_at | string (date-time) | ||
data.messages | object[] | ||
data.messages[].id | integer | ||
data.messages[].role | string | One of: user, assistant. | |
data.messages[].status | string | Answers only; a failed answer's content says why. One of: pending, done, failed. | |
data.messages[].content | string | The question, or the answer in Markdown. | |
data.messages[].steps | object[] | The API reads made for the answer so far. | |
data.messages[].created_at | string (date-time) |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/assistant/conversations/{conversation}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /sites/{site}/assistant/conversations/{conversation}
Asks a follow-up question (the conversation so far is sent along)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
conversation | path | integer | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
question | string | yes | At least 2 characters. At most 4000 characters. |
Responses
- 202 — The conversation with the pending answer.
- 403 — The plan doesn't include Ask AI, or this month's questions are used up.
- 404 — Missing, or another account's.
- 409 — The last question is still being answered.
- 422 — Validation failed.
- 503 — No Anthropic API key is set.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.title | string | ||
data.updated_at | string (date-time) | ||
data.messages | object[] | ||
data.messages[].id | integer | ||
data.messages[].role | string | One of: user, assistant. | |
data.messages[].status | string | Answers only; a failed answer's content says why. One of: pending, done, failed. | |
data.messages[].content | string | The question, or the answer in Markdown. | |
data.messages[].steps | object[] | The API reads made for the answer so far. | |
data.messages[].created_at | string (date-time) |
bash
curl -X POST "https://your-site.com/api/v1/sites/{site}/assistant/conversations/{conversation}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"question":"text"}'DELETE /sites/{site}/assistant/conversations/{conversation}
Deletes a conversation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
conversation | path | integer | yes |
Responses
- 204 — Deleted.
- 404 — Missing, or another account's.
bash
curl -X DELETE "https://your-site.com/api/v1/sites/{site}/assistant/conversations/{conversation}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /sites/{site}/assistant/digest
The site summary (Ask AI's diagnosis of the whole site, rewritten every 6 hours while on)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes |
Responses
- 200 — OK
- 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.available | boolean | ||
data.enabled | boolean | ||
data.summary | string, nullable | Markdown. | |
data.model | string, nullable | ||
data.written_at | string (date-time), nullable | ||
data.next_at | string (date-time), nullable | ||
data.error | string, nullable |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/assistant/digest" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /sites/{site}/assistant/digest
Rewrites the site summary now (managers; written after the response, poll GET)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes |
Responses
- 202 — Being written.
- 403 — Not a manager of the account, or the plan doesn't include Ask AI.
- 404 — Missing, or another account's.
- 409 — The site summary is off.
- 503 — No Anthropic API key is set.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.available | boolean | ||
data.enabled | boolean | ||
data.summary | string, nullable | Markdown. | |
data.model | string, nullable | ||
data.written_at | string (date-time), nullable | ||
data.next_at | string (date-time), nullable | ||
data.error | string, nullable |
bash
curl -X POST "https://your-site.com/api/v1/sites/{site}/assistant/digest" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PUT /sites/{site}/assistant/digest
Switches the site summary on or off (managers; the first one is written right away)
Each summary counts as one of the month's Ask AI questions. It reads the site as the person who switched it on.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | yes |
Responses
- 200 — OK
- 403 — Not a manager of the account, or the plan doesn't include Ask AI.
- 404 — Missing, or another account's.
- 422 — Validation failed.
- 503 — No Anthropic API key is set.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.available | boolean | ||
data.enabled | boolean | ||
data.summary | string, nullable | Markdown. | |
data.model | string, nullable | ||
data.written_at | string (date-time), nullable | ||
data.next_at | string (date-time), nullable | ||
data.error | string, nullable |
bash
curl -X PUT "https://your-site.com/api/v1/sites/{site}/assistant/digest" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"enabled":true}'POST /sites/{site}/sessions/ask
Turns a question in plain words into session filters (Claude; plan feature ai_search.enabled)
"Mobile visitors from Google who rage-clicked at checkout last week" becomes the filters of GET /sites/{site}/sessions (query is ready to append). Only the question and today's date are sent to Claude; every value is checked. understood: false when the question isn't a search (then explanation says so). 20 per minute.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
question | string | yes | At least 3 characters. At most 300 characters. |
Responses
- 200 — The filters.
- 404 — Missing, or another account's.
- 422 — Validation failed.
- 502 — Claude gave no usable answer (the message says why).
- 503 — No Anthropic API key is set.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.understood | boolean | ||
data.filters | object | The same keys and values as the filters of GET /sites/{site}/sessions (has and tags are lists). | |
data.sort | string, nullable | ||
data.explanation | string | ||
data.query | string | The filters and sort as a query string for GET /sites/{site}/sessions. |
bash
curl -X POST "https://your-site.com/api/v1/sites/{site}/sessions/ask" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"question":"text"}'POST /sites/{site}/sessions/{session}/questions
Ask Claude a question about one session (plan feature summaries.monthly; nothing is stored)
Answered only from the session's facts and moments (never the visitor's identity; typed values are never recorded). Send earlier questions and answers in history (the last 6 are used) for a conversation. moments are the points the answer relies on, in ms since the session started. 30 per minute.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
session | path | string (uuid) | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
question | string | yes | At least 3 characters. At most 500 characters. |
history | object[] | At most 20 items. | |
history[].question | string | yes | |
history[].answer | string | yes |
Responses
- 200 — The answer.
- 404 — Missing, or another account's.
- 422 — Validation failed.
- 502 — Claude gave no usable answer (the message says why).
- 503 — No Anthropic API key is set.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.answer | string | ||
data.moments | object[] | ||
data.moments[].offset_ms | integer | ||
data.moments[].text | string |
bash
curl -X POST "https://your-site.com/api/v1/sites/{site}/sessions/{session}/questions" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"question":"text","history":[{"question":"text","answer":"text"}]}'GET /sites/{site}/sessions/{session}/summary
The session's stored AI summary
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
session | path | string (uuid) | yes |
Responses
- 200 — The summary (
datais null until one is written);meta.availablesays whether summaries can be written on this server. - 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object, nullable | ||
data.summary | string | ||
data.outcome | string | One of: completed, abandoned, struggled, browsed, bounced. | |
data.timeline | object[] | ||
data.timeline[].offset_ms | integer | Time since the session started. | |
data.timeline[].kind | string | One of: navigation, action, frustration, error, milestone. | |
data.timeline[].text | string | ||
data.model | string | ||
data.tokens | object | ||
data.tokens.input | integer | ||
data.tokens.output | integer | ||
data.written_at | string (date-time) | ||
meta | object | ||
meta.available | boolean |
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/sessions/{session}/summary" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /sites/{site}/sessions/{session}/summary
Writes the summary with Claude (or answers the stored one unless refresh); 20 per minute
Each written summary counts toward the plan feature summaries.monthly.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | integer | yes | |
session | path | string (uuid) | yes |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
refresh | boolean | Write it again even when one is stored. |
Responses
- 200 — The stored (or rewritten) summary.
- 201 — Written.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 404 — Missing, or another account's.
- 502 — Claude gave no usable answer (rejected key, busy, refused, unreachable);
messagesays which. - 503 — Summaries are not set up on this server (no API key).
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object, nullable | ||
data.summary | string | ||
data.outcome | string | One of: completed, abandoned, struggled, browsed, bounced. | |
data.timeline | object[] | ||
data.timeline[].offset_ms | integer | Time since the session started. | |
data.timeline[].kind | string | One of: navigation, action, frustration, error, milestone. | |
data.timeline[].text | string | ||
data.model | string | ||
data.tokens | object | ||
data.tokens.input | integer | ||
data.tokens.output | integer | ||
data.written_at | string (date-time) | ||
meta | object | ||
meta.available | boolean |
bash
curl -X POST "https://your-site.com/api/v1/sites/{site}/sessions/{session}/summary" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"refresh":true}'