Skip to content

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.

MethodPathWhat it does
GET/shared/{token}/summaryThe AI summary of the public demo's replay (public; 60 per minute)
POST/shared/{token}/summaryWrites the demo replay's summary with Claude, once (public; 5 per 10 minutes)
GET/sites/{site}/assistant/conversationsThe user's Ask AI conversations about the site (plan feature assistant.monthly)
POST/sites/{site}/assistant/conversationsStarts a conversation with a question (Claude reads the site's API to answer)
GET/sites/{site}/assistant/conversations/{conversation}One conversation with its questions and answers
POST/sites/{site}/assistant/conversations/{conversation}Asks a follow-up question (the conversation so far is sent along)
DELETE/sites/{site}/assistant/conversations/{conversation}Deletes a conversation
GET/sites/{site}/assistant/digestThe site summary (Ask AI's diagnosis of the whole site, rewritten every 6 hours while on)
POST/sites/{site}/assistant/digestRewrites the site summary now (managers; written after the response, poll GET)
PUT/sites/{site}/assistant/digestSwitches the site summary on or off (managers; the first one is written right away)
POST/sites/{site}/sessions/askTurns a question in plain words into session filters (Claude; plan feature ai_search.enabled)
POST/sites/{site}/sessions/{session}/questionsAsk Claude a question about one session (plan feature summaries.monthly; nothing is stored)
GET/sites/{site}/sessions/{session}/summaryThe session's stored AI summary
POST/sites/{site}/sessions/{session}/summaryWrites the summary with Claude (or answers the stored one unless refresh); 20 per minute

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 ​

NameInTypeRequiredDescription
tokenpathstringyesThe secret from the share link. Pattern ^[A-Za-z0-9]{40}$.

Responses ​

  • 200 — The summary (data is null until one is written).
  • 404 — Missing, or another account's.
Response fields
FieldTypeRequiredDescription
dataobject, nullable
data.summarystring
data.outcomestringOne of: completed, abandoned, struggled, browsed, bounced.
data.timelineobject[]
data.timeline[].offset_msintegerTime since the session started.
data.timeline[].kindstringOne of: navigation, action, frustration, error, milestone.
data.timeline[].textstring
data.modelstring
data.tokensobject
data.tokens.inputinteger
data.tokens.outputinteger
data.written_atstring (date-time)
metaobject
meta.availableboolean
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 ​

NameInTypeRequiredDescription
tokenpathstringyesThe 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
FieldTypeRequiredDescription
dataobject, nullable
data.summarystring
data.outcomestringOne of: completed, abandoned, struggled, browsed, bounced.
data.timelineobject[]
data.timeline[].offset_msintegerTime since the session started.
data.timeline[].kindstringOne of: navigation, action, frustration, error, milestone.
data.timeline[].textstring
data.modelstring
data.tokensobject
data.tokens.inputinteger
data.tokens.outputinteger
data.written_atstring (date-time)
metaobject
meta.availableboolean
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 ​

NameInTypeRequiredDescription
sitepathintegeryes

Responses ​

  • 200 — OK
  • 403 — Not allowed (not an administrator, or outside the token's abilities).
  • 404 — Missing, or another account's.
Response fields
FieldTypeRequiredDescription
dataobject[]
data[].idinteger
data[].titlestring
data[].updated_atstring (date-time)
metaobject
meta.availableboolean
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 ​

NameInTypeRequiredDescription
sitepathintegeryes

Request body ​

application/json, required

FieldTypeRequiredDescription
questionstringyesAt 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
FieldTypeRequiredDescription
dataobject
data.idinteger
data.titlestring
data.updated_atstring (date-time)
data.messagesobject[]
data.messages[].idinteger
data.messages[].rolestringOne of: user, assistant.
data.messages[].statusstringAnswers only; a failed answer's content says why. One of: pending, done, failed.
data.messages[].contentstringThe question, or the answer in Markdown.
data.messages[].stepsobject[]The API reads made for the answer so far.
data.messages[].created_atstring (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 ​

NameInTypeRequiredDescription
sitepathintegeryes
conversationpathintegeryes

Responses ​

  • 200 — OK
  • 404 — Missing, or another account's.
Response fields
FieldTypeRequiredDescription
dataobject
data.idinteger
data.titlestring
data.updated_atstring (date-time)
data.messagesobject[]
data.messages[].idinteger
data.messages[].rolestringOne of: user, assistant.
data.messages[].statusstringAnswers only; a failed answer's content says why. One of: pending, done, failed.
data.messages[].contentstringThe question, or the answer in Markdown.
data.messages[].stepsobject[]The API reads made for the answer so far.
data.messages[].created_atstring (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 ​

NameInTypeRequiredDescription
sitepathintegeryes
conversationpathintegeryes

Request body ​

application/json, required

FieldTypeRequiredDescription
questionstringyesAt 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
FieldTypeRequiredDescription
dataobject
data.idinteger
data.titlestring
data.updated_atstring (date-time)
data.messagesobject[]
data.messages[].idinteger
data.messages[].rolestringOne of: user, assistant.
data.messages[].statusstringAnswers only; a failed answer's content says why. One of: pending, done, failed.
data.messages[].contentstringThe question, or the answer in Markdown.
data.messages[].stepsobject[]The API reads made for the answer so far.
data.messages[].created_atstring (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 ​

NameInTypeRequiredDescription
sitepathintegeryes
conversationpathintegeryes

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 ​

NameInTypeRequiredDescription
sitepathintegeryes

Responses ​

  • 200 — OK
  • 404 — Missing, or another account's.
Response fields
FieldTypeRequiredDescription
dataobject
data.availableboolean
data.enabledboolean
data.summarystring, nullableMarkdown.
data.modelstring, nullable
data.written_atstring (date-time), nullable
data.next_atstring (date-time), nullable
data.errorstring, 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 ​

NameInTypeRequiredDescription
sitepathintegeryes

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
FieldTypeRequiredDescription
dataobject
data.availableboolean
data.enabledboolean
data.summarystring, nullableMarkdown.
data.modelstring, nullable
data.written_atstring (date-time), nullable
data.next_atstring (date-time), nullable
data.errorstring, 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 ​

NameInTypeRequiredDescription
sitepathintegeryes

Request body ​

application/json, required

FieldTypeRequiredDescription
enabledbooleanyes

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
FieldTypeRequiredDescription
dataobject
data.availableboolean
data.enabledboolean
data.summarystring, nullableMarkdown.
data.modelstring, nullable
data.written_atstring (date-time), nullable
data.next_atstring (date-time), nullable
data.errorstring, 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 ​

NameInTypeRequiredDescription
sitepathintegeryes

Request body ​

application/json, required

FieldTypeRequiredDescription
questionstringyesAt 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
FieldTypeRequiredDescription
dataobject
data.understoodboolean
data.filtersobjectThe same keys and values as the filters of GET /sites/{site}/sessions (has and tags are lists).
data.sortstring, nullable
data.explanationstring
data.querystringThe 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 ​

NameInTypeRequiredDescription
sitepathintegeryes
sessionpathstring (uuid)yes

Request body ​

application/json, required

FieldTypeRequiredDescription
questionstringyesAt least 3 characters. At most 500 characters.
historyobject[]At most 20 items.
history[].questionstringyes
history[].answerstringyes

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
FieldTypeRequiredDescription
dataobject
data.answerstring
data.momentsobject[]
data.moments[].offset_msinteger
data.moments[].textstring
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 ​

NameInTypeRequiredDescription
sitepathintegeryes
sessionpathstring (uuid)yes

Responses ​

  • 200 — The summary (data is null until one is written); meta.available says whether summaries can be written on this server.
  • 404 — Missing, or another account's.
Response fields
FieldTypeRequiredDescription
dataobject, nullable
data.summarystring
data.outcomestringOne of: completed, abandoned, struggled, browsed, bounced.
data.timelineobject[]
data.timeline[].offset_msintegerTime since the session started.
data.timeline[].kindstringOne of: navigation, action, frustration, error, milestone.
data.timeline[].textstring
data.modelstring
data.tokensobject
data.tokens.inputinteger
data.tokens.outputinteger
data.written_atstring (date-time)
metaobject
meta.availableboolean
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 ​

NameInTypeRequiredDescription
sitepathintegeryes
sessionpathstring (uuid)yes

Request body ​

application/json

FieldTypeRequiredDescription
refreshbooleanWrite 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); message says which.
  • 503 — Summaries are not set up on this server (no API key).
Response fields
FieldTypeRequiredDescription
dataobject, nullable
data.summarystring
data.outcomestringOne of: completed, abandoned, struggled, browsed, bounced.
data.timelineobject[]
data.timeline[].offset_msintegerTime since the session started.
data.timeline[].kindstringOne of: navigation, action, frustration, error, milestone.
data.timeline[].textstring
data.modelstring
data.tokensobject
data.tokens.inputinteger
data.tokens.outputinteger
data.written_atstring (date-time)
metaobject
meta.availableboolean
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}'

Replora: see what your visitors see.