curl https://app.solacia.ai/v1/account/me \
-H "Authorization: Bearer $SOLACIA_API_KEY"The Solacia API.
Read what your Solacia agent learned from every buyer: leads, demos, transcripts, questions and knowledge gaps. Make a personal demo link for each prospect. From your own code, your CRM or an AI agent.
- Base URL
https://app.solacia.ai/v1- Auth
- Bearer key from your console
- Format
- JSON, errors as problem+json
- Contract
- OpenAPI 3.1.0
Make your first call
Every call is a plain HTTPS request to https://app.solacia.ai/v1 with your key in the Authorization header. The key says which account you read, so there is no account id to pass.
- Make a key. In your console, Team, API keys. It is shown once. Keep it like a password.
- Call
/account/me. It says who the key is and what it may do. - Read your buyers.
/leadsreturns one record per buyer, hottest first.
curl https://app.solacia.ai/v1/account/me \
-H "Authorization: Bearer $SOLACIA_API_KEY"
curl "https://app.solacia.ai/v1/leads?priority=hot&limit=20" \
-H "Authorization: Bearer $SOLACIA_API_KEY"Keys and scopes
A key reads one account, within its scopes; each endpoint below names the scope it needs. A person signed in to the console uses the same endpoints with the role shown instead.
Made in the console
An owner makes a key on the console's Team page, with the scopes it needs. It is shown once; Solacia keeps only its hash.
It says where it works
sol_live_halden_… works on production, sol_dev_halden_… on dev, for the account it names. Its last six characters check the rest, so a mistyped key is refused at once. Secret scanners know the sol_ prefix.
Every key ends
In 7, 30 or 90 days (90 unless you pick another), or never. Every response to a key says when in Solacia-Key-Expires; GET /v1/api-keys/self says the rest.
Roll it without downtime
A roll makes a new key with the same name and scopes, and keeps the old one working now, for 1 hour, 24 hours or 7 days, while you switch.
Revoke it at once
On the Team page, or with DELETE /v1/api-keys/{id}. Its next call gets a 401 with key_revoked, and what it did stays on record.
See what it did
Every call a key makes is recorded with its status, time and request id, refused ones too. GET /v1/api-keys/self/usage reads the last 30 days, with the demo links it made and the demos they brought.
agents:adminagents:readdemos:readfoundation:readfoundation:writegaps:writeintegrations:adminintegrations:readkeys:adminleads:readleads:writelinks:writemail:eventsteam:admin
How the API behaves
Records name their shape
Every record carries schema, such as solacia.lead.v1. Under one name, fields are only ever added: never removed, renamed or made required. solacia.analytics.v0 may still change.
One lead record
Lead is the same record your CRM webhook and HubSpot receive. What the API returns is what your team sees.
Lists page by cursor
Every list pages the same way: pass limit and the previous page's next_cursor as cursor. A page with next_cursor: null is the last, and total says how many matched over every page. A record that arrives while you page is never repeated or skipped. Leads, demos and questions send 50 rows unless asked (up to 200); buyers, demo links, unanswered questions and team requests send every row unless asked (up to 500).
Test demos stay out
Demos marked as tests are left out of every list unless you pass tests=true.
A budget per key
120 units a minute and 5,000 a day. A read costs one unit, /analytics two, fresh=true one more, and a page one more per 50 records past the first 50. RateLimit-Remaining and RateLimit-Reset are on every response; past the budget you get a 429 with Retry-After.
Every response has an id
X-Request-Id is yours if you sent one (up to 64 plain characters), or ours. Errors repeat it. Quote it when you ask us about a request.
Errors
Every error is application/problem+json with a stable code. Branch on code, not on detail, which is written for people.
unauthorized401- No key, a mistyped one, or a key this host does not know.
key_expired401- The key passed its end. Make a new one or roll it before it ends.
key_revoked401- The key was revoked, or replaced by a roll and its overlap is over.
wrong_environment401- A
sol_dev_key on production, or asol_live_key on dev. wrong_account403- A key of another account.
forbidden403- The key lacks the scope, or the user the role, the operation needs.
not_found404- No record with that id in this account.
key_ended409- The key already stopped working; there is nothing to change.
invalid422- A parameter or body field is not right;
detailsays which. wider_scopes422- An edit asked for a scope the key does not have. Keys are narrowed, never widened.
bad_cursor400- A
cursorthat did not come from this API. bad_include400- An
includevalue the operation does not offer. rate_limited429- The key has used its budget for the minute or the day;
Retry-Aftersays when.
{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "No lead with that id in this account.",
"code": "not_found",
"request_id": "req_4f9a1c2e"
}Account
Who a key belongs to and what it may do. The first call to make with a new key.
Leads
One record per buyer: who they are, what they asked, saw and objected to, and the next step. The same solacia.lead.v1 record your CRM receives.
GET/v1/leads
Every buyer as a lead record, hottest first.
- Scope
leads:read - Console role
member
Parameters
qstringquery- Words to find in what the buyer asked, their email, company or fit. Up to 200 characters.
sincestringquery- Only demos active at or after this time, ISO 8601 (e.g. 2026-10-01T00:00:00Z). Up to 40 characters.
priority"hot" | "warm" | "nurture" | "cold" | nullquerycampaignstring | nullquery- Only buyers who came in by a demo link of this campaign; an empty value, buyers with none.
testsbooleanquery- Include test demos. Default
false. freshbooleanquery- Read the record again instead of the last few seconds' copy. Costs one more unit. Default
false. cursorstringquery- The previous page's next_cursor; empty for the first page. Up to 2000 characters.
limitintegerquery- Records per page; 50 per unit. 1 to 200. Default
50.
Returns
curl "https://app.solacia.ai/v1/leads?priority=hot&limit=20" \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/leads/{id}
One buyer's lead record, with the transcript, calls and CRM deals on request.
- Scope
leads:read - Console role
member - MCP tool
get_buyer
Parameters
idstringpathRequired- Up to 200 characters.
includestringquery- Comma-separated: transcript, calls, deals. Up to 40 characters.
Returns
curl "https://app.solacia.ai/v1/leads/web-7f3a9c?include=transcript,calls" \
-H "Authorization: Bearer $SOLACIA_API_KEY"{
"schema": "solacia.lead.v1",
"event": "lead.snapshot",
"at": "2026-10-14T15:02:55.000+00:00",
"product": "halden",
"vendor": "Halden",
"session": "web-7f3a9c",
"link": "https://app.solacia.ai/halden/console/outcomes?id=web-7f3a9c",
"test": false,
"contact": {
"email": "maya.chen@arbor.example",
"company": "Arbor",
"role": "VP Finance"
},
"campaign": "Finance leaders Q4",
"network": null,
"source": {
"utm": {},
"campaign": "CFOs Mexico Q4",
"channel": "outbound",
"click_id": null,
"click_ids": {},
"arrival_url": "https://demo.solacia.ai/clara/",
"arrived_at": null,
"embedded": false,
"landing_page": "https://demo.solacia.ai/clara/",
"referrer": null,
"first_touch": null,
"last_touch": {
"page": "https://demo.solacia.ai/clara/",
"referrer": null,
"utm": {},
"click_id": null,
"channel": "direct",
"at": null
}
},
"priority": "hot",
"fit": null,
"reasons": [
{
"text": "Asked to talk to the team",
"tone": "intent"
}
],
"stages": [
"email",
"asked",
"team"
],
"facts": [],
"seen": [],
"questions": [
{
"question": "Can it forecast by region?",
"answer": "Yes. Forecasts split by any region you define, and each region's plan updates daily.",
"answered": true,
"channel": "call",
"at": "2026-10-14T15:02:10.000+00:00"
},
{
"question": "Does it read our NetSuite subsidiaries?",
"answer": null,
"answered": false,
"channel": "call",
"at": "2026-10-14T15:02:30.000+00:00"
}
],
"concerns": [],
"team_request": {
"requested": true,
"slot": "2026-10-16T15:00:00-04:00",
"booked": null
},
"next_meeting": [
"Show a forecast for each region: on their agenda, not reached",
"Find out how many subsidiaries they consolidate, when they need it live and who else decides"
],
"follow_up": {
"subject": "Forecasts by region, and your next step with Halden",
"body": "Hi Maya,\n\nThanks for touring Halden today. ..."
},
"activity": {
"first_at": "2026-10-14T15:02:10.000+00:00",
"last_at": "2026-10-14T15:02:50.000+00:00",
"minutes": 0.7
},
"number": 7,
"transcript": null,
"calls": [
{
"voice": null,
"model": null,
"started_at": "2026-10-14T15:02:05.000+00:00",
"minutes": 4.2,
"ended": "goodbye"
}
],
"deals": null
}Demos
Every run of the demo, the buyers in them, and the conversation in each.
GET/v1/buyers
The Buyers list: one row per buyer that reads as a short brief, newest first. In preview.
- Scope
demos:read - Console role
member - MCP tool
find_buyers
Parameters
daysintegerquery- Demos that began in the last
daysdays, today included. 1 to 365. Default90. testsbooleanquery- Default
false. qstringquery- Only the buyers whose name, address, company, role, or anything they said or told the demo (calls included) holds every word of it; case and accents don't matter. Up to 120 characters.
order"newest" | "promising"query- newest: by their latest demo. promising: meetings first, then qualified, nurture and no email, each by score. Default
"newest". limitintegerquery- At most this many buyers; 0 for all of them. 0 to 500. Default
0. cursorstringquery- The previous page's next_cursor; empty for the first page. Up to 2000 characters.
language"en" | "es" | "pt"query- The language the rows' roles and facts are written in: English, Spanish or Portuguese. Default
"en".
Returns
curl https://app.solacia.ai/v1/buyers \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/buyers/{id}/done
Mark the one thing to do for a buyer done, or take the mark back. In preview.
- Scope
leads:write - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
Body: BuyerDoneIn
action"book" | "prep" | "follow_up"Required- The action they did, as the row gave it.
doneboolean- False takes the mark back (Undo). Default
true.
Returns
curl -X PUT https://app.solacia.ai/v1/buyers/{id}/done \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/demos
Every run of the demo, newest first.
- Scope
demos:read - Console role
member
Parameters
sincestringquery- Only demos active at or after this time, ISO 8601 (e.g. 2026-10-01T00:00:00Z). Up to 40 characters.
testsbooleanquery- Default
false. freshbooleanquery- Default
false. cursorstringquery- The previous page's next_cursor; empty for the first page. Up to 2000 characters.
limitintegerquery- 1 to 200. Default
50.
Returns
curl "https://app.solacia.ai/v1/demos?since=2026-10-01T00:00:00Z" \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/demos/{id}
One run of the demo.
- Scope
demos:read - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl https://app.solacia.ai/v1/demos/web-7f3a9c \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/demos/{id}/brief-link
A new link to the demo's brief, for 30 days, to send a rep by hand: it opens to a work email at the account proven by a code; Handoff ends it. In preview.
- Scope
leads:write - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl -X POST https://app.solacia.ai/v1/demos/{id}/brief-link \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/demos/{id}/follow-up
Keep the demo's follow-up email as a teammate edited it. In preview.
- Scope
leads:write - Console role
member - MCP tool
edit_follow_up
Parameters
idstringpathRequired- Up to 200 characters.
Body: FollowUpIn
bodystringRequired- Up to 10000 characters.
subjectstringRequired- Up to 300 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/demos/{id}/follow-up \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/demos/{id}/recordings
The demo's calls as recorded, each with a link that plays it for an hour. In preview.
- Scope
leads:read - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl https://app.solacia.ai/v1/demos/{id}/recordings \
-H "Authorization: Bearer $SOLACIA_API_KEY"DELETE/v1/demos/{id}/recordings/{n}
Delete one of the demo's recordings now, before its 90 days are up. In preview.
- Scope
leads:write - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
nstringpathRequired- Up to 200 characters.
Returns
curl -X DELETE https://app.solacia.ai/v1/demos/{id}/recordings/{n} \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/demos/{id}/recordings/{n}/chapters
A recorded call's parts, each named in a few words, in order. In preview.
- Scope
leads:read - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
nstringpathRequired- Up to 200 characters.
language"en" | "es" | "pt"query- The language events and notes are written in: English, Spanish or Portuguese. Default
"en".
Returns
curl https://app.solacia.ai/v1/demos/{id}/recordings/{n}/chapters \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/demos/{id}/standing
Where one demo stands: its outcome, the meeting time picked, its agent and door. In preview.
- Scope
demos:read - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl https://app.solacia.ai/v1/demos/{id}/standing \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/demos/{id}/transcript
The conversation of one demo: what the buyer wrote or said, what the guide answered and showed.
- Scope
leads:read - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
language"en" | "es" | "pt"query- The language events and notes are written in: English, Spanish or Portuguese. Default
"en".
Returns
curl https://app.solacia.ai/v1/demos/web-7f3a9c/transcript \
-H "Authorization: Bearer $SOLACIA_API_KEY"Questions
Everything buyers asked, and how well it was answered.
GET/v1/questions
Every question buyers asked, newest first, with how well it was answered.
- Scope
demos:read - Console role
member - MCP tool
list_questions
Parameters
qstringquery- Up to 200 characters.
sincestringquery- Only demos active at or after this time, ISO 8601 (e.g. 2026-10-01T00:00:00Z). Up to 40 characters.
answeredboolean | nullquery- true: answered from a source or in the call; false: not.
testsbooleanquery- Default
false. freshbooleanquery- Default
false. cursorstringquery- The previous page's next_cursor; empty for the first page. Up to 2000 characters.
limitintegerquery- 1 to 200. Default
50.
Returns
curl https://app.solacia.ai/v1/questions \
-H "Authorization: Bearer $SOLACIA_API_KEY"Knowledge gaps
What the agent could not answer from your sources, most asked first. Close a gap by adding the answer to your docs.
POST/v1/dictation
Write down a recorded answer: the recording in, the words out. In preview.
- Scope
gaps:write - Console role
member
Body: DictationIn
audiostringRequired- The recording, base64, up to 3 MB Up to 4200000 characters.
typestring- Up to 100 characters. Default
"audio/webm".
Returns
curl -X POST https://app.solacia.ai/v1/dictation \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/gaps
What the agent could not answer from the vendor's sources, most asked first.
- Scope
demos:read - Console role
member - MCP tool
list_unanswered_questions
Parameters
status"open" | "closed" | "dismissed" | "all"query- Default
"open". freshbooleanquery- Default
false. language"en" | "es" | "pt"query- The language who asked is described in: English, Spanish or Portuguese. Default
"en". limitintegerquery- At most this many questions; 0 for all of them. 0 to 500. Default
0. cursorstringquery- The previous page's next_cursor; empty for the first page. Up to 2000 characters.
Returns
curl https://app.solacia.ai/v1/gaps \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/gaps/answer
Answer a gap, or give it a new answer: the agent gives it to every buyer who asks after, in any wording.
- Scope
gaps:write - Console role
member - MCP tool
answer_question
Body: GapAnswerIn
answerstringRequired- What buyers should be told, as the team would say it: facts only, no quotes. Up to 2000 characters.
keystringRequired- The gap's key Up to 2000 characters.
Returns
curl -X POST https://app.solacia.ai/v1/gaps/answer \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/gaps/calls
Check a gap against the sales calls read from Granola: whether a rep answered it, and the answer drafted from the rep's when one did. In preview.
- Scope
gaps:write - Console role
member
Body: GapCallsIn
keystringRequired- The gap's key Up to 2000 characters.
questionstring- The question as asked; left out: the gap's Up to 2000 characters.
Returns
curl -X POST https://app.solacia.ai/v1/gaps/calls \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/gaps/dismiss
Dismiss a gap, or restore it with dismissed=false: it leaves the open list and count, and the guide's answers stay as they are. In preview.
- Scope
gaps:write - Console role
member - MCP tool
dismiss_question
Body: GapDismissIn
dismissedboolean- false restores it to the open list Default
true. keystringRequired- The gap's key Up to 2000 characters.
reason"unpublished" | null- unpublished: the vendor deliberately doesn't publish this (a margin, a custom price), so the agent keeps handing it to the team (ADR 0009)
Returns
curl -X POST https://app.solacia.ai/v1/gaps/dismiss \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/gaps/documents
Attach a document to a gap: kept with the vendor's docs, checked against the question, and the answer drafted from it when it answers. In preview.
- Scope
gaps:write - Console role
member
Body: GapDocumentIn
contentstring- The file, base64: .pdf, .docx, .html, .md or .txt, up to 3 MB Up to 4200000 characters.
keystringRequired- The gap's key Up to 2000 characters.
namestringRequired- Up to 200 characters.
questionstring- The question as asked; left out: the gap's Up to 2000 characters.
textstring- Or its text, instead of the file Up to 1000000 characters.
Returns
curl -X POST https://app.solacia.ai/v1/gaps/documents \
-H "Authorization: Bearer $SOLACIA_API_KEY"Analytics
What the demos add up to over a period.
GET/v1/analytics
What the demos add up to over a period: KPIs, funnel, topics, sessions.
- Scope
demos:read - Console role
member - MCP tool
get_numbers
Parameters
daysintegerquery- 1 to 365. Default
30. testsbooleanquery- Default
false. freshbooleanquery- Default
false. demosbooleanquery- false leaves out each demo's row and the demos behind each question: the numbers alone. Default
true.
Returns
curl "https://app.solacia.ai/v1/analytics?days=30" \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/analytics/flow
Where every buyer went, from opening the demo to where they are now, counted by way.
- Scope
demos:read - Console role
member
Parameters
daysintegerquery- The last
daysdays, today included;startoverrides it. 1 to 365. Default30. startstring (date) | nullquery- A range of your own: its first day (UTC). Ends today unless
endsays. endstring (date) | nullquery- The range's last day, included (UTC); with
startonly. testsbooleanquery- Default
false. agentstring[]query- Only the demos these agents ran; repeat for several. All when none.
doorstring[]query- Only the demos opened through these doors; repeat for several: "outbound" (a personal link), "site:<host>" (the embed on that website), "site" (the embed, page not known), "link" (the demo's own address), or "unknown". All when none.
Returns
curl https://app.solacia.ai/v1/analytics/flow \
-H "Authorization: Bearer $SOLACIA_API_KEY"Demo links
A personal demo link per prospect, for your outbound email. The agent reads who they are before the call.
GET/v1/clay
Whether Clay can make this account's links, where its column sends them, and what it has made.
- Scope
integrations:admin - Console role
owner
Returns
curl https://app.solacia.ai/v1/clay \
-H "Authorization: Bearer $SOLACIA_API_KEY"DELETE/v1/clay/key
Stop the Clay key working at once.
- Scope
integrations:admin - Console role
owner
Returns
curl -X DELETE https://app.solacia.ai/v1/clay/key \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/clay/key
A key for a Clay HTTP column that can only make demo links, shown once; the one before it stops working.
- Scope
integrations:admin - Console role
owner
Returns
curl -X POST https://app.solacia.ai/v1/clay/key \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/crm/lists
The lists in the account's CRM that personal demo links can be made for: HubSpot's contact lists, Salesforce's campaigns.
- Scope
links:write - Console role
member - MCP tool
list_crm_lists
Parameters
qstringquery- Words in the list's name. Up to 80 characters.
Returns
curl https://app.solacia.ai/v1/crm/lists \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/demo-links
The personal demo links made so far, newest first, one per prospect, with what each brought and a result per campaign.
- Scope
links:write - Console role
member - MCP tool
list_demo_links
Parameters
campaignstring | nullquery- Only this campaign's links; an empty value, those without one.
limitintegerquery- At most this many links, newest first; 0 for all of them. 0 to 500. Default
0. cursorstringquery- The previous page's next_cursor; empty for the first page. Up to 2000 characters.
Returns
curl https://app.solacia.ai/v1/demo-links \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/demo-links
Make a personal demo link for one prospect, with who they are for the guide.
- Scope
links:write - Console role
member
Body: DemoLinkIn
agentstring | null- The agent the prospect meets: its id. Left out: the sender's default agent, else the outbound channel's.
anonymousboolean- A link for someone unnamed: its demos are filed under an address made up for it, and a buyer who asks for your team gives their own email. Default
false. campaignstring- The list, segment or sequence the link goes out in, such as CFOs Mexico Q4. Your team's label: the agent never sees it; the lead record carries it. Up to 80 characters.
companystring- Up to 80 characters.
daysinteger- How long the link opens the demo. 1 to 90. Default
30. emailstring- The prospect's work email; none for an anonymous link. Up to 254 characters.
namestring- Their name, to greet them by. Up to 80 characters.
notesstring- What the rep knows that should shape the demo. The agent checks it with the buyer before relying on it and never quotes it. Up to 600 characters.
rolestring- Their job, such as CFO. Up to 80 characters.
sent_tostring- Who you sent the link to: a company, a person or both. Your team's label: the agent never sees it. Up to 80 characters.
try_outboolean- A try link, Solacia's team only: one we keep to try the demo ourselves, never sent to a buyer. Its demos never post to Slack or reach the CRM. Anyone else is refused. Default
false.
Returns
curl -X POST https://app.solacia.ai/v1/demo-links \
-H "Authorization: Bearer $SOLACIA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "maya.chen@arbor.example",
"name": "Maya Chen",
"role": "VP Finance",
"company": "Arbor",
"campaign": "Finance leaders Q4",
"notes": "Asked about forecasting by region on LinkedIn."
}'POST/v1/demo-links/batch
Make personal demo links for a list of prospects in one request, up to 500 at a time; rows that are not a work email come back refused, with why.
- Scope
links:write - Console role
member - MCP tool
make_demo_links
Body: DemoLinksIn
rowsDemoLinkIn[]Required- Up to 500 prospects.
Returns
curl -X POST https://app.solacia.ai/v1/demo-links/batch \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/demo-links/from-crm-list
Make personal demo links for one page of a CRM list's people and write each onto their record (HubSpot's Solacia demo link property, Salesforce's Solacia Demo Link field); call again with next until it is empty.
- Scope
links:write - Console role
member - MCP tool
make_crm_list_links
Body: CrmListLinksIn
afterstring- Where this page starts: the last answer's
next. Up to 256 characters. agentstring | null- The agent they meet; left out: the sender's default.
campaignstring- Up to 80 characters.
daysinteger- How long the links open the demo. 1 to 90. Default
30. list_idstringRequired- Up to 64 characters.
Returns
curl -X POST https://app.solacia.ai/v1/demo-links/from-crm-list \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/demo-links/try-out
Solacia's team only: mark a link already made as a try link, kept to try the demo, whose demos never post to Slack or reach the CRM; or as one sent to a buyer again.
- Scope
links:write - Console role
member
Body: TryLinkIn
emailstringRequired- The email the link was made for, as the list of links gives it. Up to 254 characters.
try_outboolean- True: a try link, whose demos never post to Slack or reach your CRM. False: a link sent to a buyer. Default
true.
Returns
curl -X POST https://app.solacia.ai/v1/demo-links/try-out \
-H "Authorization: Bearer $SOLACIA_API_KEY"Agents
Your demo agents: what each says and shows, where it runs, and its test calls.
PUT/v1/agent-default
Set the agent your personal links carry unless you pick another. In preview.
- Scope
agents:admin - Console role
member
Body: AgentDefaultIn
agentstring | null- Null: the outbound channel's
Returns
curl -X PUT https://app.solacia.ai/v1/agent-default \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/agent-routes/{channel}
Give a channel's demos to an agent, from the next demo that starts. In preview.
- Scope
agents:admin - Console role
owner
Parameters
channelstringpathRequired- Up to 200 characters.
Body: AgentRouteIn
agentstringRequired- The id of the agent to run the channel's demos Up to 80 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/agent-routes/{channel} \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/agent-rules
Set the website's rules: which agent a buyer meets by where they came from, then by the page the demo opened on. In preview.
- Scope
agents:admin - Console role
owner
Body: AgentRulesIn
rulesAgentRule[]Required
Returns
curl -X PUT https://app.solacia.ai/v1/agent-rules \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/agent-tests
Split one channel's buyers between two or three agents, each buyer always on the same side. In preview.
- Scope
agents:admin - Console role
owner
Body: AgentTestIn
armsTestArmIn[]Requiredchannel"embed" | "outbound" | "link"Requiredmin_buyersinteger- Buyers each side needs before any verdict 20 to 100000. Default
20. questionstring- Up to 200 characters.
weeksinteger | null- How long it takes buyers; left out: until stopped
Returns
curl -X POST https://app.solacia.ai/v1/agent-tests \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/agent-tests/{id}/check-crm
Read from your CRM which prospects of an outreach test against no demo have had a meeting booked since their link was made, on both sides. In preview.
- Scope
agents:admin - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
Body: Nothing
None.
Returns
curl -X POST https://app.solacia.ai/v1/agent-tests/{id}/check-crm \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/agent-tests/{id}/stop
Stop a test; with keep, that agent runs the channel from the next demo. In preview.
- Scope
agents:admin - Console role
owner - MCP tool
stop_agent_test
Parameters
idstringpathRequired- Up to 200 characters.
Body: AgentTestStopIn
keepstring | null- The agent to run the channel from now on; in a test between an agent's versions, the side (A, B or C) whose version goes live
Returns
curl -X POST https://app.solacia.ai/v1/agent-tests/{id}/stop \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/agents
The account's agents, what each runs and costs, and the agent of each channel. In preview.
- Scope
agents:read - Console role
member - MCP tool
list_agents
Returns
curl https://app.solacia.ai/v1/agents \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/agents
Make an agent: the pack run another way, with its own name and face or none. In preview.
- Scope
agents:admin - Console role
owner
Body: AgentIn
copy_ofstring | null- Start from this agent's tone, instructions, facts and voices
namestringRequired- Up to 200 characters.
priceinteger | null- US cents a demo; Solacia only. Left out: the list price
renderer"voice" | "face"- Default
"voice".
Returns
curl -X POST https://app.solacia.ai/v1/agents \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/agents/{id}
One agent: its live version, its draft, every version and the script a buyer meets. In preview.
- Scope
agents:read - Console role
member - MCP tool
get_agent
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl https://app.solacia.ai/v1/agents/{id} \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/agents/{id}
Rename an agent, change its face, how it talks, its voice, its price (Solacia only), or retire it. In preview.
- Scope
agents:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Body: AgentChangeIn
factsAgentFact[] | null- Replaces all its facts
instructionsstring | nulllist_priceboolean- Back to the list price for its renderer; Solacia only Default
false. namestring | nullpriceinteger | null- US cents a demo; Solacia only
renderer"voice" | "face" | nullretiredboolean | null- true pauses it everywhere: its website rules and links send buyers to the next rule or the default until false resumes it. Refused while it holds a default or is in a test
tone"brief" | "warm" | "expert" | "pack" | null- pack: as the brief says
voicesobject<string, string> | null- Voice id per language; Solacia only. Empty: the product's
Returns
curl -X PUT https://app.solacia.ai/v1/agents/{id} \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/agents/{id}/changes
Turn the agent's open notes into changes to its next version: each with what it replaces, why, and whether its words meet the demo-lines standard. Drafted by a model; nothing changes until kept. In preview.
- Scope
agents:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Body: AgentChangesIn
notesstring[] | null- The notes to read; all the open ones when left out
Returns
curl -X POST https://app.solacia.ai/v1/agents/{id}/changes \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/agents/{id}/changes/apply
Put the kept changes into the agent's draft and close their notes, and the ones dropped. In preview.
- Scope
agents:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Body: AgentChangesApplyIn
droppedstring[]- Notes closed with no change
keptAgentChangeKept[]- Into the draft
Returns
curl -X POST https://app.solacia.ai/v1/agents/{id}/changes/apply \
-H "Authorization: Bearer $SOLACIA_API_KEY"DELETE/v1/agents/{id}/draft
Throw the agent's draft away. In preview.
- Scope
agents:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl -X DELETE https://app.solacia.ai/v1/agents/{id}/draft \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/agents/{id}/draft
Change the agent's draft: how it talks, who it's for, its goal and its script. Buyers never meet a draft. In preview.
- Scope
agents:admin - Console role
owner - MCP tool
change_agent
Parameters
idstringpathRequired- Up to 200 characters.
Body: AgentDraftIn
audiencestring | nullcounts"qualified" | "meeting" | null- What reaching the goal is: the buyer qualifies, or asks to meet the team
factsAgentFact[] | null- Replaces all its facts
goalstring | nullinstructionsstring | nullscriptAgentScriptIn | nulltone"brief" | "warm" | "expert" | "pack" | null- pack: as the brief says
voicesobject<string, string> | null- Voice id per language; Solacia only
Returns
curl -X PUT https://app.solacia.ai/v1/agents/{id}/draft \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/agents/{id}/draft/publish
Make the draft the agent's next version, from the next demo that starts; refused while its own lines miss the demo-lines standard. In preview.
- Scope
agents:admin - Console role
owner - MCP tool
publish_agent
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl -X POST https://app.solacia.ai/v1/agents/{id}/draft/publish \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/agents/{id}/levers
What a test on the agent can learn, one lever at a time (its message, the features it shows first, its pricing, its offer, its qualification): each with the goal its test is read on, the parts of a version it changes, and what the agent's buyers of the last 30 days did that it starts from. In preview.
- Scope
agents:admin - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl https://app.solacia.ai/v1/agents/{id}/levers \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/agents/{id}/notes
Leave a note on one turn of a rehearsal, for the agent's next version. In preview.
- Scope
agents:admin - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
Body: AgentNoteIn
sessionstringRequired- Up to 80 characters.
textstringRequired- Up to 1000 characters.
turnintegerRequired
Returns
curl -X POST https://app.solacia.ai/v1/agents/{id}/notes \
-H "Authorization: Bearer $SOLACIA_API_KEY"DELETE/v1/agents/{id}/notes/{note}
Take a note back. In preview.
- Scope
agents:admin - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
notestringpathRequired- Up to 200 characters.
Returns
curl -X DELETE https://app.solacia.ai/v1/agents/{id}/notes/{note} \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/agents/{id}/rehearsals
Rehearse the agent: a demo of its draft as it is now, or of one of its versions, for the team to run as a buyer would. Never counted in results, and nothing in it reaches the team, the CRM or the calendar. Open url to run it. In preview.
- Scope
agents:admin - Console role
member - MCP tool
rehearse_agent
Parameters
idstringpathRequired- Up to 200 characters.
Body: AgentRehearseIn
ofinteger | "draft"- A version's number, or the draft as it is now Default
"draft".
Returns
curl -X POST https://app.solacia.ai/v1/agents/{id}/rehearsals \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/agents/{id}/rehearsals/{session}
A rehearsal read back: each turn tagged script (said as written), answer (the agent's own words, with what the docs made of them), screen or buyer, with the notes on it. In preview.
- Scope
agents:admin - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
sessionstringpathRequired- Up to 200 characters.
Returns
curl https://app.solacia.ai/v1/agents/{id}/rehearsals/{session} \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/agents/{id}/suggestions
Tests worth running on the agent, read from what its buyers did in the last 30 days: the part most of the ones who left without its goal left on, or its opening when many leave in the first minute. At most 3, the strongest first. In preview.
- Scope
agents:admin - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl https://app.solacia.ai/v1/agents/{id}/suggestions \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/agents/{id}/suggestions/{sid}/draft
Have a model draft a suggestion's change into the agent's draft, from the buyers behind it, checked as any draft: read it, then test it against the live version. In preview.
- Scope
agents:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
sidstringpathRequired- Up to 200 characters.
Returns
curl -X POST https://app.solacia.ai/v1/agents/{id}/suggestions/{sid}/draft \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/agents/{id}/test-plan
Before testing an agent's versions: its pace, and how soon a test would make a better draft live, or how often a worse one, under each rule. share: percent on the challenger. In preview.
- Scope
agents:admin - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
shareintegerquery- Percent of buyers on the challenger 10 to 90. Default
50. lever"message" | "features" | "pricing" | "offer" | "qualification" | nullquery- What it would learn: it is read on that lever's goal, else the agent's own
Returns
curl https://app.solacia.ai/v1/agents/{id}/test-plan \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/agents/{id}/tests
Test an agent's versions against each other, or its draft against its live version, across every place it runs; each buyer always on the same side, read on who qualified. In preview.
- Scope
agents:admin - Console role
owner - MCP tool
test_agent
Parameters
idstringpathRequired- Up to 200 characters.
Body: AgentVersionTestIn
lever"message" | "features" | "pricing" | "offer" | "qualification" | null- What it is to learn (GET /agents/{id}/levers): it is read on that lever's goal
min_buyersinteger- Buyers each side needs before any verdict 20 to 100000. Default
20. questionstring- Up to 200 characters.
rule"unless_worse" | "proven"- unless_worse: a challenger may go live unless it is worse; proven: only once it is proven better Default
"unless_worse". sidesVersionSideIn[]Requiredweeksinteger | null- How long it takes buyers; left out: until stopped
Returns
curl -X POST https://app.solacia.ai/v1/agents/{id}/tests \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/agents/{id}/versions/{number}/publish
Put an earlier version back as the agent's next version: the rollback. In preview.
- Scope
agents:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
numberstringpathRequired- Up to 200 characters.
Returns
curl -X POST https://app.solacia.ai/v1/agents/{id}/versions/{number}/publish \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/voice-samples
Hear a voice an agent can have: it says the start of the account's opening in that language. In preview.
- Scope
agents:admin - Console role
owner
Body: VoiceSampleIn
agentstring | null- Say this agent's own opening, when it has one
languagestringRequired- Up to 8 characters.
voicestringRequired- An id from the agents' voice_pool Up to 100 characters.
Returns
curl -X POST https://app.solacia.ai/v1/voice-samples \
-H "Authorization: Bearer $SOLACIA_API_KEY"Knowledge
The sources an agent answers from, and the claims read from them.
GET/v1/docs-versions
Which version of the vendor's docs the agent answers from, and the latest ones kept.
- Scope
foundation:read - Console role
member
Returns
curl https://app.solacia.ai/v1/docs-versions \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/docs-versions/live
Answer from a kept docs version: go back to an earlier one, or forward again. Calls pick it up within a minute.
- Scope
foundation:write - Console role
owner
Body: DocsLiveIn
versionstringRequired- The id of a kept version. Up to 64 characters.
whystring- Why: shown with the version. Up to 300 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/docs-versions/live \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/foundation
What the account's customers say, quote by quote, graded by who said it, and what nobody has said yet. In preview.
- Scope
foundation:read - Console role
member
Returns
curl https://app.solacia.ai/v1/foundation \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/foundation/claims/{id}
Reword a claim, fold it into another of its kind, or drop it. In preview.
- Scope
foundation:write - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Body: FoundationClaimIn
goneboolean- Drop it Default
false. intostring | null- Fold it into this claim: its quotes count there
textstring | null- Its new wording
Returns
curl -X PUT https://app.solacia.ai/v1/foundation/claims/{id} \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/foundation/quotes/{id}/remove
Take one quote off its claim. In preview.
- Scope
foundation:write - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl -X POST https://app.solacia.ai/v1/foundation/quotes/{id}/remove \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/foundation/sources
Add raw evidence (a call, an interview, a note, a ticket, a review, usage, a page); its first part is read at once. In preview.
- Scope
foundation:write - Console role
member
Body: FoundationSourceIn
customerstring- Whose words: the company Up to 80 characters.
datestring- YYYY-MM-DD Up to 10 characters.
kind"won_call" | "lost_call" | "interview" | "crm_note" | "ticket" | "review" | "usage" | "case_study" | "vendor_page" | "our_note"Requiredpublicboolean | null- May be quoted to buyers; left out: by its kind
rolestring- Who spoke Up to 80 characters.
textstringRequired- Up to 200000 characters.
titlestring- Up to 120 characters.
Returns
curl -X POST https://app.solacia.ai/v1/foundation/sources \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/foundation/sources/{id}/read
Read one more part of a source (its left), keeping only quotes that are its own words. In preview.
- Scope
foundation:write - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
Body: FoundationReadIn
partintegerRequired- 0 to 100.
Returns
curl -X POST https://app.solacia.ai/v1/foundation/sources/{id}/read \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/foundation/sources/{id}/remove
Take a source out, with every quote cut from it. In preview.
- Scope
foundation:write - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl -X POST https://app.solacia.ai/v1/foundation/sources/{id}/remove \
-H "Authorization: Bearer $SOLACIA_API_KEY"Demo page
How the demo looks to buyers.
DELETE/v1/demo/theme
Put the demo back in the product's own colours.
- Scope
agents:admin - Console role
owner
Returns
curl -X DELETE https://app.solacia.ai/v1/demo/theme \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/demo/theme
The demo's colours, and the product's own.
- Scope
agents:admin - Console role
owner
Returns
curl https://app.solacia.ai/v1/demo/theme \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/demo/theme
Recolour the demo (the call around the product and the popup's loading screen).
- Scope
agents:admin - Console role
owner
Body: ThemeIn
accentstring | null- Links, the active item, focus rings
accent_deepstring | null- The accent under the pointer, and on a tint
accent_softstring | null- Tints behind highlighted things
backgroundstring | null- Behind everything
buttonstring | null- The main button, with white words on it
linestring | null- Borders and dividers
mutedstring | null- Secondary words: hints, labels, times
surfacestring | null- Cards and panels
textstring | null- The words
Returns
curl -X PUT https://app.solacia.ai/v1/demo/theme \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/demo/theme/suggestion
Colours for the demo, read from a website; nothing is saved.
- Scope
agents:admin - Console role
owner
Body: ThemeSiteIn
urlstringRequired- Up to 300 characters.
Returns
curl -X POST https://app.solacia.ai/v1/demo/theme/suggestion \
-H "Authorization: Bearer $SOLACIA_API_KEY"Integrations
Connect your CRM, scheduler and alerts, and say who hears about each buyer. The console uses these; most teams never call them.
DELETE/v1/app
Forget the vendor's app and its login. In preview.
- Scope
integrations:admin - Console role
owner
Returns
curl -X DELETE https://app.solacia.ai/v1/app \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/app
The vendor's app the explorer checks the demo against, and what its last check found. In preview.
- Scope
integrations:admin - Console role
member
Returns
curl https://app.solacia.ai/v1/app \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/app
Connect the vendor's app: its sign-in page and a sandbox login, the password kept sealed. In preview.
- Scope
integrations:admin - Console role
owner
Body: AppConnectionIn
emailstringRequired- A sandbox user made for Solacia. Up to 200 characters.
passwordstringRequired- That user's password: kept sealed. Up to 200 characters.
urlstringRequired- The app's sign-in page, https://. Up to 500 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/app \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/embed
The website embeds: each key's script tag for the site's HTML, the sites it answers on, and whether it is paused. In preview.
- Console role
member - MCP tool
get_website_embed
Returns
curl https://app.solacia.ai/v1/embed \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/handoff
Every buyer who asked for the team in the last days days (30 by default), each step of the hand-off with why one didn't go, and where today's rules send them. In preview.
- Scope
integrations:admin - Console role
member
Parameters
daysintegerquery- How many days back: 30 by default, up to 365. 1 to 365. Default
30. language"en" | "es" | "pt"query- The language each step's why and each rule's reason are written in: English, Spanish or Portuguese. Default
"en". testsbooleanquery- Include test demos: try links, test addresses, demos Solacia opened. Default
false. limitintegerquery- At most this many requests, newest first; 0 for all of them. 0 to 500. Default
0. cursorstringquery- The previous page's next_cursor; empty for the first page. Up to 2000 characters.
Returns
curl https://app.solacia.ai/v1/handoff \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/handoff/brief-link/end
End every link a demo's brief went out with, so a forwarded or leaked one opens nothing; the next hand-off makes a new one. In preview.
- Scope
integrations:admin - Console role
member
Body: BriefLinkEndIn
demostringRequired- Up to 120 characters.
Returns
curl -X POST https://app.solacia.ai/v1/handoff/brief-link/end \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/integrations
Every integration with its state, grouped as the console's Integrations page shows them, and the scheduler and CRM the account picked.
- Scope
integrations:read - Console role
member - MCP tool
list_integrations
Parameters
language"en" | "es" | "pt"query- The language its words are in. Default
"en".
Returns
curl https://app.solacia.ai/v1/integrations \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/integrations/chilipiper/key
Connect Chili Piper by an Edge API token with Concierge permissions; pick the router next. In preview.
- Scope
integrations:admin - Console role
owner
Body: ChiliPiperIn
tokenstringRequired- Up to 2000 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/integrations/chilipiper/key \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/integrations/chilipiper/router
The Chili Piper router buyers go through, and the token's routers with what each field gets. In preview.
- Scope
integrations:admin - Console role
owner
Returns
curl https://app.solacia.ai/v1/integrations/chilipiper/router \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/integrations/chilipiper/router
Pick the Chili Piper router buyers go through and what each of its fields gets; it becomes the account's scheduler. In preview.
- Scope
integrations:admin - Console role
owner
Body: ChiliPiperRouterIn
fieldsobject<string, string> | nullrouterstringRequired- Up to 300 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/integrations/chilipiper/router \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/integrations/craft/link
Connect Craft by the link of an API connection made there for the documents the agent may answer from. In preview.
- Scope
integrations:admin - Console role
owner
Body: CraftLinkIn
keystring- The connection's API key, when it has one. Up to 500 characters.
urlstringRequired- Up to 300 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/integrations/craft/link \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/integrations/fathom/calls
The sales calls read from Fathom: what buyers asked and how reps answered, objections and how they were handled, how reps pitched. In preview.
- Scope
integrations:admin - Console role
member
Returns
curl https://app.solacia.ai/v1/integrations/fathom/calls \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/integrations/fathom/calls
Read the Fathom sales calls not yet read, for up to 40 seconds; call again while unread is above 0. In preview.
- Scope
integrations:admin - Console role
owner
Body: SalesCallsReadIn
listed_withininteger- Once every call is read, list the picked folders again only when the last listing is older than this many seconds (0: always). Above 0, a connection with no folders picked is no error. 0 to 86400. Default
0.
Returns
curl -X POST https://app.solacia.ai/v1/integrations/fathom/calls \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/integrations/fathom/key
Connect Fathom by a user's API key made there: kept sealed, only ever read. Returns the teams and meeting types it reaches, to pick from. In preview.
- Scope
integrations:admin - Console role
owner
Body: FathomKeyIn
keystringRequired- The key, as Fathom showed it. Up to 500 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/integrations/fathom/key \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/integrations/fathom/places
The Fathom teams and meeting types the connected key reaches, and those picked as holding the sales calls. In preview.
- Scope
integrations:admin - Console role
member
Returns
curl https://app.solacia.ai/v1/integrations/fathom/places \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/integrations/fathom/places
Pick the Fathom teams or meeting types holding the sales calls; their calls with someone from outside the company are listed, to be read. In preview.
- Scope
integrations:admin - Console role
owner
Body: CallPicksIn
pickedstring[]Required- The refs of the folders or spaces picked.
Returns
curl -X PUT https://app.solacia.ai/v1/integrations/fathom/places \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/integrations/granola/calls
The sales calls read from Granola: what buyers asked and how reps answered, objections and how they were handled, how reps pitched. In preview.
- Scope
integrations:admin - Console role
member
Returns
curl https://app.solacia.ai/v1/integrations/granola/calls \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/integrations/granola/calls
Read the sales calls not yet read, for up to 40 seconds; call again while unread is above 0. In preview.
- Scope
integrations:admin - Console role
owner
Body: SalesCallsReadIn
listed_withininteger- Once every call is read, list the picked folders again only when the last listing is older than this many seconds (0: always). Above 0, a connection with no folders picked is no error. 0 to 86400. Default
0.
Returns
curl -X POST https://app.solacia.ai/v1/integrations/granola/calls \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/integrations/granola/key
Connect Granola by an API key made there: kept sealed, only ever read. Returns the folders and spaces it reaches, to pick from. In preview.
- Scope
integrations:admin - Console role
owner
Body: GranolaKeyIn
keystringRequired- The key, as Granola showed it. Up to 500 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/integrations/granola/key \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/integrations/granola/places
The Granola folders and spaces the connected key reaches, and those picked as holding the sales calls. In preview.
- Scope
integrations:admin - Console role
member
Returns
curl https://app.solacia.ai/v1/integrations/granola/places \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/integrations/granola/places
Pick the Granola folders or spaces holding the sales calls; the calls there are listed, to be read. In preview.
- Scope
integrations:admin - Console role
owner
Body: CallPicksIn
pickedstring[]Required- The refs of the folders or spaces picked.
Returns
curl -X PUT https://app.solacia.ai/v1/integrations/granola/places \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/integrations/hubspot_meetings/link
The HubSpot meeting link buyers book, and the connected HubSpot's links.
- Scope
integrations:admin - Console role
owner
Returns
curl https://app.solacia.ai/v1/integrations/hubspot_meetings/link \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/integrations/hubspot_meetings/link
Pick which of the connected HubSpot's meeting links buyers book.
- Scope
integrations:admin - Console role
owner
Body: MeetingLinkIn
urlstringRequired- Up to 500 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/integrations/hubspot_meetings/link \
-H "Authorization: Bearer $SOLACIA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://meetings.hubspot.com/your-team/demo"
}'GET/v1/integrations/zendesk/audiences
Who the connected Zendesk help center's articles are for (its user segments, or everyone), and those picked. In preview.
- Scope
integrations:admin - Console role
member
Returns
curl https://app.solacia.ai/v1/integrations/zendesk/audiences \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/integrations/zendesk/audiences
Pick the audiences whose published Zendesk articles the agent may answer from; their articles are read. In preview.
- Scope
integrations:admin - Console role
owner
Body: AudiencePicksIn
pickedstring[]Required- The refs of the audiences picked.
Returns
curl -X PUT https://app.solacia.ai/v1/integrations/zendesk/audiences \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/integrations/zendesk/key
Refused (404): Zendesk no longer connects by an API token. It connects by signing in (POST /integrations/zendesk/sign-in). In preview.
- Scope
integrations:admin - Console role
owner
Body: ZendeskKeyIn
addressstringRequired- Up to 300 characters.
emailstringRequired- Someone who can see the articles. Up to 320 characters.
tokenstringRequired- The API token, as Zendesk showed it. Up to 500 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/integrations/zendesk/key \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/integrations/zendesk/sign-in
Start connecting Zendesk at its address: where to send the owner to sign in and approve Solacia's read-only access to its help center. The address is checked with Zendesk first: 422 when no Zendesk account holds it. Finished like any sign-in (PUT /integrations/zendesk/connection); then pick the audiences, which a connection by API token to the same account hands over. In preview.
- Scope
integrations:admin - Console role
owner
Body: ZendeskSignInIn
addressstringRequired- Up to 300 characters.
Returns
curl -X POST https://app.solacia.ai/v1/integrations/zendesk/sign-in \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/integrations/{crm}/field-map
Which of your own CRM fields get where each buyer came from (your UTM tags, ad click ids, the page and the site), each checked against your CRM. In preview.
- Scope
integrations:read - Console role
member
Parameters
crmstringpathRequired- Up to 200 characters.
limitintegerquery- 1 to 200. Default
50. cursorstringquery- The previous page's next_cursor; empty for the first page. Up to 2000 characters.
Returns
curl https://app.solacia.ai/v1/integrations/{crm}/field-map \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/integrations/{crm}/field-map
Save which of your own CRM fields get where each buyer came from: the whole map, replacing the one before. In preview.
- Scope
integrations:admin - Console role
owner
Parameters
crmstringpathRequired- Up to 200 characters.
Body: FieldMapIn
rowsFieldMapRow[]Required
Returns
curl -X PUT https://app.solacia.ai/v1/integrations/{crm}/field-map \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/integrations/{crm}/field-map/draft
Draft your field map from your account of your CRM process (a PDF, a Word file or text): which of your own CRM fields get where the buyer came from, how the demo went and the lead's stage, checked against your CRM, with what the document leaves open. Saves nothing. In preview.
- Scope
integrations:admin - Console role
owner
Parameters
crmstringpathRequired- Up to 200 characters.
Body: FieldMapDraftIn
answersFieldMapAnswer[]- Your answers to the draft's questions.
contentstring- The file, base64: .pdf, .docx, .html, .md or .txt, up to 3 MB Up to 4200000 characters.
language"en" | "es" | "pt"- The language the questions are written in. Default
"en". namestringRequired- Up to 200 characters.
rowsFieldMapRow[]- The draft as you edited it, to change only where your answers do.
textstring- Or its text, instead of the file Up to 200000 characters.
Returns
curl -X POST https://app.solacia.ai/v1/integrations/{crm}/field-map/draft \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/integrations/{crm}/field-map/preview
What a new lead from a buyer who opens a link would get in each of your own CRM fields, by your saved map, and why a field stays empty. Writes nothing. In preview.
- Scope
integrations:read - Console role
member
Parameters
crmstringpathRequired- Up to 200 characters.
Body: FieldMapPreviewIn
meeting"none" | "asked" | "booked"- Whether the buyer asked for a meeting in the demo, or booked one. Default
"none". pagestringRequired- The page the buyer opens, with its tags. Up to 2000 characters.
priority"hot" | "warm" | "nurture" | "cold" | null- How Solacia rated the buyer after the demo.
referrerstring | null- The site that sent them.
rowsFieldMapRow[] | null- A map to preview instead of the saved one, such as a draft before it is saved.
Returns
curl -X POST https://app.solacia.ai/v1/integrations/{crm}/field-map/preview \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/integrations/{crm}/fields
Your CRM's fields Solacia may write (Salesforce's Lead fields, HubSpot's contact properties), with each closed list's values: what your field map's rows are picked from. In preview.
- Scope
integrations:read - Console role
member
Parameters
crmstringpathRequired- Up to 200 characters.
limitintegerquery- 1 to 200. Default
50. cursorstringquery- The previous page's next_cursor; empty for the first page. Up to 2000 characters.
Returns
curl https://app.solacia.ai/v1/integrations/{crm}/fields \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/integrations/{id}/connect
Start connecting a provider by its owner signing in there: where to send them.
- Scope
integrations:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl -X POST https://app.solacia.ai/v1/integrations/hubspot/connect \
-H "Authorization: Bearer $SOLACIA_API_KEY"DELETE/v1/integrations/{id}/connection
Remove a connection the owner made, and Solacia's app from their account.
- Scope
integrations:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl -X DELETE https://app.solacia.ai/v1/integrations/hubspot/connection \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/integrations/{id}/connection
Finish connecting a provider with what it sent the owner back with.
- Scope
integrations:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Body: IntegrationConnectionIn
codestringRequired- Up to 2000 characters.
pickedstring- Google Drive: the ids of the files picked in Google's picker, comma-separated (picked_file_ids), as Google sent them back. Up to 20000 characters.
statestringRequired- Up to 500 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/integrations/hubspot/connection \
-H "Authorization: Bearer $SOLACIA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"code": "CODE_FROM_THE_PROVIDER",
"state": "STATE_FROM_CONNECT"
}'GET/v1/integrations/{id}/docs
The internal documents a connected source (drive, craft or zendesk) lets the agent answer from. In preview.
- Scope
integrations:admin - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl https://app.solacia.ai/v1/integrations/{id}/docs \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/integrations/{id}/docs
Read a source of internal docs (drive, craft or zendesk) again, so the agent answers from what it holds now. In preview.
- Scope
integrations:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl -X POST https://app.solacia.ai/v1/integrations/{id}/docs \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/integrations/{id}/event_type
The event buyers book in a connected scheduler, and its event types.
- Scope
integrations:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl https://app.solacia.ai/v1/integrations/calendly/event_type \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/integrations/{id}/event_type
Pick which of the connected scheduler's event types buyers book.
- Scope
integrations:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Body: EventTypeIn
idstringRequired- Up to 500 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/integrations/calendly/event_type \
-H "Authorization: Bearer $SOLACIA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "EVENT_TYPE_ID_FROM_THE_LIST"
}'PUT/v1/integrations/{kind}
Pick the one provider the account uses for a kind: crm or scheduling.
- Scope
integrations:admin - Console role
owner
Parameters
kindstringpathRequired- Up to 200 characters.
Body: IntegrationChoiceIn
providerstringRequired- Up to 40 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/integrations/crm \
-H "Authorization: Bearer $SOLACIA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"provider": "hubspot"
}'GET/v1/internal-docs
Where the internal docs and the public docs state one thing two ways, and which side the agent follows. In preview.
- Scope
integrations:admin - Console role
member
Returns
curl https://app.solacia.ai/v1/internal-docs \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/internal-docs
Pick the side the agent follows where the internal docs and the public docs disagree: internal or public. In preview.
- Scope
integrations:admin - Console role
owner
Body: InternalDocsChoice
prefer"internal" | "public"Required
Returns
curl -X PUT https://app.solacia.ai/v1/internal-docs \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/internal-docs/check
Check the internal docs not yet checked against the public docs, for up to 35 seconds; call again while unchecked is above 0. In preview.
- Scope
integrations:admin - Console role
owner
Returns
curl -X POST https://app.solacia.ai/v1/internal-docs/check \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/mail/events
Whether SES's events on the routed emails reach Solacia: the key, the configuration set and SNS's last post.
- Scope
integrations:admin - Console role
solacia
Returns
curl https://app.solacia.ai/v1/mail/events \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/mail/events
SES's events on the emails routed to the team (delivered, bounced, opened), as SNS posts them; each is kept with the buyer it names. For Solacia's own SNS subscription.
- Scope
mail:events - Console role
solacia
Body: SnsPost
Messagestring- Up to 200000 characters.
MessageIdstring- Up to 100 characters.
Signaturestring- Up to 1000 characters.
SignatureVersionstring- Up to 4 characters.
SigningCertURLstring- Up to 500 characters.
Subjectstring | nullSubscribeURLstring- Up to 2000 characters.
Timestampstring- Up to 40 characters.
Tokenstring- Up to 1000 characters.
TopicArnstring- Up to 300 characters.
TypestringRequired- Up to 40 characters.
UnsubscribeURLstring- Up to 2000 characters.
Returns
curl -X POST https://app.solacia.ai/v1/mail/events \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/mail/events/key
A key for SNS to post SES's events with, shown once; the one before it stops working.
- Scope
integrations:admin - Console role
solacia
Returns
curl -X POST https://app.solacia.ai/v1/mail/events/key \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/routing
Who on the team hears about which buyers, and where the latest buyers went. In preview.
- Scope
integrations:admin - Console role
member
Returns
curl https://app.solacia.ai/v1/routing \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/routing
Keep the account's routing rules, in order: the first that fits a buyer decides. In preview.
- Scope
integrations:admin - Console role
owner
Body: RoutingIn
routesRoutingRule[]Required
Returns
curl -X PUT https://app.solacia.ai/v1/routing \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/routing/preview
Where the latest buyers would go under rules not saved yet. In preview.
- Scope
integrations:admin - Console role
member
Body: RoutingIn
routesRoutingRule[]Required
Returns
curl -X POST https://app.solacia.ai/v1/routing/preview \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/routing/test
Email one saved rule's people the latest buyer's brief, marked as a test. In preview.
- Scope
integrations:admin - Console role
owner
Body: RoutingTestIn
routestringRequired- Up to 64 characters.
Returns
curl -X POST https://app.solacia.ai/v1/routing/test \
-H "Authorization: Bearer $SOLACIA_API_KEY"Team
The people who sign in to your console and hear about buyers.
GET/v1/me
The caller's own account: name, email and access. For a person signed in to the console.
- Console role
member
Returns
curl https://app.solacia.ai/v1/me \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/me
Change the caller's own name, as the team sees it.
- Console role
member
Body: MeNameIn
namestringRequired- How the team sees them on Team and in Handoff. Up to 80 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/me \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/me/language
Pick the language the caller's own console speaks: en, es or pt. In preview.
- Console role
member
Body: MeLanguageIn
language"en" | "es" | "pt"Required- English, Spanish or Portuguese.
Returns
curl -X PUT https://app.solacia.ai/v1/me/language \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/me/password
Change the caller's own password, given the current one. Every session of theirs ends, this one too; the console's own form keeps its browser signed in.
- Console role
member
Body: MePasswordIn
currentstringRequired- Up to 200 characters.
newstringRequired- At least 10 characters. Up to 200 characters.
Returns
curl -X POST https://app.solacia.ai/v1/me/password \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/me/picture
Change the caller's own picture, as the team sees it; an empty image takes it away.
- Console role
member
Body: MePictureIn
imagestringRequired- A JPEG, PNG or WebP as a base64 data: URL, at most 48 KB decoded (a square of about 160 px); empty takes the picture away. Up to 65536 characters.
Returns
curl -X PUT https://app.solacia.ai/v1/me/picture \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/me/sign-out-everywhere
End every session of the caller's, this one too. In preview.
- Console role
member
Returns
curl -X POST https://app.solacia.ai/v1/me/sign-out-everywhere \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/me/started
The caller's first steps in the console, each done or not, ticked off from what is true; none once all were done. For a person signed in to the console. In preview.
- Console role
member
Returns
curl https://app.solacia.ai/v1/me/started \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/me/two-step
The caller's two-step sign-in: whether it is on, and the backup codes left. In preview.
- Console role
member
Returns
curl https://app.solacia.ai/v1/me/two-step \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/me/two-step
Start two-step sign-in: a new secret for the caller's authenticator app. In preview.
- Console role
member
Returns
curl -X POST https://app.solacia.ai/v1/me/two-step \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/me/two-step/backup-codes
Ten new backup codes in place of the old ones, for a right code. In preview.
- Console role
member
Body: TwoStepCodeIn
codestringRequired- A code from the app, or a backup code. Up to 40 characters.
Returns
curl -X POST https://app.solacia.ai/v1/me/two-step/backup-codes \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/me/two-step/confirm
Turn two-step sign-in on with the app's first code; answers the backup codes, once. In preview.
- Console role
member
Body: TwoStepCodeIn
codestringRequired- A code from the app, or a backup code. Up to 40 characters.
Returns
curl -X POST https://app.solacia.ai/v1/me/two-step/confirm \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/me/two-step/off
Turn the caller's two-step sign-in off, with a code from the app or a backup code. In preview.
- Console role
member
Body: TwoStepCodeIn
codestringRequired- A code from the app, or a backup code. Up to 40 characters.
Returns
curl -X POST https://app.solacia.ai/v1/me/two-step/off \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/team
Who can sign in to the account's console, and the invitations out.
- Scope
team:admin - Console role
member
Returns
curl https://app.solacia.ai/v1/team \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/team/hand-over
Give everyone a person's Handoff rules send them to someone else, with their share of the turns: before removing them, or when their alerts bounce.
- Scope
integrations:admin - Console role
owner
Body: TeamHandOverIn
emailstringRequired- Whose place on the Handoff rules moves. Up to 254 characters.
tostringRequired- Who takes it: a teammate's or any work email. Up to 254 characters.
Returns
curl -X POST https://app.solacia.ai/v1/team/hand-over \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/team/invitations
Invite someone by email, as an owner or a member; their link is in the answer, once.
- Scope
team:admin - Console role
owner
Body: TeamInviteIn
emailstringRequired- The person's work email. Up to 254 characters.
role"owner" | "member" | "solacia"solaciaonly for Solacia's own people. Default"member".
Returns
curl -X POST https://app.solacia.ai/v1/team/invitations \
-H "Authorization: Bearer $SOLACIA_API_KEY"DELETE/v1/team/invitations/{email}
Withdraw an invitation: its link stops working.
- Scope
team:admin - Console role
owner
Parameters
emailstringpathRequired- Up to 200 characters.
Returns
curl -X DELETE https://app.solacia.ai/v1/team/invitations/{email} \
-H "Authorization: Bearer $SOLACIA_API_KEY"DELETE/v1/team/members/{email}
Take someone off the team: they are signed out everywhere. Hand their buyers over first (POST /v1/team/hand-over) so their Handoff rules keep reaching a person.
- Scope
team:admin - Console role
owner
Parameters
emailstringpathRequired- Up to 200 characters.
Returns
curl -X DELETE https://app.solacia.ai/v1/team/members/{email} \
-H "Authorization: Bearer $SOLACIA_API_KEY"PUT/v1/team/members/{email}
Change someone's role. The last owner stays an owner.
- Scope
team:admin - Console role
owner
Parameters
emailstringpathRequired- Up to 200 characters.
Body: TeamRoleIn
role"owner" | "member" | "solacia"Required
Returns
curl -X PUT https://app.solacia.ai/v1/team/members/{email} \
-H "Authorization: Bearer $SOLACIA_API_KEY"DELETE/v1/team/members/{email}/two-step
Turn off someone's two-step sign-in when they lost their phone; they sign in with their password. In preview.
- Scope
team:admin - Console role
owner
Parameters
emailstringpathRequired- Up to 200 characters.
Returns
curl -X DELETE https://app.solacia.ai/v1/team/members/{email}/two-step \
-H "Authorization: Bearer $SOLACIA_API_KEY"API keys
Make, roll, edit and revoke the keys that call this API.
GET/v1/api-keys
Every key that can call this account's API, the ones that stopped working, and the scopes and lifetimes a new one can have.
- Scope
keys:admin - Console role
owner
Returns
curl https://app.solacia.ai/v1/api-keys \
-H "Authorization: Bearer $SOLACIA_API_KEY"POST/v1/api-keys
A new key with the scopes asked for, shown once; it works at once and stops after 7, 30 or 90 days (90 when left out) or never. A key makes keys only within its own scopes.
- Scope
keys:admin - Console role
owner
Body: ApiKeyIn
expires_in_days7 | 30 | 90 | null- Days until it stops working: 7, 30 or 90; null for never. 90 when left out. Default
90. namestringRequired- What it is for: "Zapier", "Data warehouse". Up to 40 characters.
scopesstring[]Required- What it may do; see
scopesin the list.
Returns
curl -X POST https://app.solacia.ai/v1/api-keys \
-H "Authorization: Bearer $SOLACIA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Data warehouse",
"scopes": [
"leads:read",
"demos:read"
],
"expires_in_days": 90
}'GET/v1/api-keys/self
The key making this call: its name, scopes and when it stops working.
- Console role
member
Returns
curl https://app.solacia.ai/v1/api-keys/self \
-H "Authorization: Bearer $SOLACIA_API_KEY"DELETE/v1/api-keys/{id}
Stop a key working at once; it stays listed under ended.
- Scope
keys:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl -X DELETE https://app.solacia.ai/v1/api-keys/3f9c1a7e5b2d8c40 \
-H "Authorization: Bearer $SOLACIA_API_KEY"PATCH/v1/api-keys/{id}
Rename a key, narrow its scopes, or give it a new end (7, 30 or 90 days from now, or never). A key is narrowed, never widened.
- Scope
keys:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Body: ApiKeyChange
expires_in_days7 | 30 | 90 | null- A new end, this many days from now: 7, 30 or 90; null for never. Leave out to keep it.
namestring | null- A new name.
scopesstring[] | null- Fewer scopes: a key is narrowed, never widened.
Returns
curl -X PATCH https://app.solacia.ai/v1/api-keys/3f9c1a7e5b2d8c40 \
-H "Authorization: Bearer $SOLACIA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"scopes": [
"leads:read"
]
}'POST/v1/api-keys/{id}/roll
A new key in place of this one, with its name, scopes and lifetime, shown once. The old key keeps working for the overlap asked for (now, 1h, 24h, 7d), so whatever uses it can switch without downtime.
- Scope
keys:admin - Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Body: ApiKeyRoll
overlap"now" | "1h" | "24h" | "7d"Required- How long the old key keeps working beside the new one;
nowstops it at once.
Returns
curl -X POST https://app.solacia.ai/v1/api-keys/3f9c1a7e5b2d8c40/roll \
-H "Authorization: Bearer $SOLACIA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"overlap": "24h"
}'GET/v1/api-keys/{id}/usage
What a key did in the last 30 days: calls by day and by operation, its latest 50 calls, the demo links it made and the demos they brought, and its budget now. A key reads its own as self; another key's takes keys:admin.
- Console role
owner
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl https://app.solacia.ai/v1/api-keys/{id}/usage \
-H "Authorization: Bearer $SOLACIA_API_KEY"GET/v1/chatbots
The chatbots people connected to this account by OAuth (Claude, ChatGPT), newest first, with what each may do and its calls; an owner sees everyone's, anyone else their own.
- Scope
keys:admin - Console role
member
Returns
curl https://app.solacia.ai/v1/chatbots \
-H "Authorization: Bearer $SOLACIA_API_KEY"DELETE/v1/chatbots/{id}
Stop a connected chatbot at once; it stays listed under ended. An owner ends anyone's, anyone else their own.
- Scope
keys:admin - Console role
member
Parameters
idstringpathRequired- Up to 200 characters.
Returns
curl -X DELETE https://app.solacia.ai/v1/chatbots/{id} \
-H "Authorization: Bearer $SOLACIA_API_KEY"Billing
GET/v1/billing
What the account is billed for: its plan and counter, and each buyer's day with the reason it counts as a demo or not. In preview.
- Scope
demos:read - Console role
member
Parameters
startstring (date) | nullquery- The first day to read (Eastern Time). With none: the plan's current month so far, or the last 30 days for an account with no month running.
endstring (date) | nullquery- The last day, included (Eastern Time); with
startonly. Today when left out. testsbooleanquery- List the test lines too. They never count either way. Default
false. limitintegerquery- 1 to 200. Default
50. cursorstringquery- The previous page's next_cursor; empty for the first page. Up to 2000 characters.
Returns
curl https://app.solacia.ai/v1/billing \
-H "Authorization: Bearer $SOLACIA_API_KEY"Records
What the endpoints return, field by field. A required field is always present; any other may be null or missing.
Problem
Every error, as application/problem+json.
codestringRequireddetailstringRequiredrequest_idstring | null- The X-Request-Id of this request; quote it when asking about the error.
statusintegerRequiredtitlestringRequiredtypestring- Default
"about:blank".
Activity
first_atstringRequiredlast_atstringRequiredminutesnumberRequired
AgentAsked
buyersintegerRequiredtextstringRequired
AgentButton
agendastring | nullRequiredlabelstringRequired
AgentChange
A change some notes ask for: what it replaces, with what, and why.
afterstringRequiredbeforestringRequiredfaultsstring[]- Why its words miss the demo-lines standard
field"opening" | "part" | "order" | "instructions" | "fact"Required- opening and part: words said as written; order: the parts it shows first; instructions: its rules, whole; fact: something it knows
idstringRequiredlangstring | nullnamestring | null- A fact's name
notesstring[]Required- The notes it answers
partstring | nullwhystringRequired
AgentChangeIn
What changes; anything left out stays as it is.
factsAgentFact[] | null- Replaces all its facts
instructionsstring | nulllist_priceboolean- Back to the list price for its renderer; Solacia only Default
false. namestring | nullpriceinteger | null- US cents a demo; Solacia only
renderer"voice" | "face" | nullretiredboolean | null- true pauses it everywhere: its website rules and links send buyers to the next rule or the default until false resumes it. Refused while it holds a default or is in a test
tone"brief" | "warm" | "expert" | "pack" | null- pack: as the brief says
voicesobject<string, string> | null- Voice id per language; Solacia only. Empty: the product's
AgentChangeKept
afterstringRequired- Up to 4000 characters.
field"opening" | "part" | "order" | "instructions" | "fact"Requiredidstring- Up to 40 characters.
langstring | nullnamestring | nullnotesstring[]partstring | null
AgentChangessolacia.agents.v0
schemastring- Default
"solacia.agents.v0". changesAgentChange[]Required
AgentChangesApplyIn
droppedstring[]- Notes closed with no change
keptAgentChangeKept[]- Into the draft
AgentChangesIn
notesstring[] | null- The notes to read; all the open ones when left out
AgentChoiceIn
agendastring | null- The part it picks
labelobject<string, string>- Its words per language
AgentChoiceOut
agendastring | nullRequired- The part it picks; null: its words are said for the buyer
labelobject<string, string>Required- Its words per language; empty: the part's title
AgentDefaultIn
The agent the caller sends personal links with unless they pick another.
agentstring | null- Null: the outbound channel's
AgentDetailsolacia.agents.v0
One agent: its live version, its draft, every version, and its script. In preview.
schemastring- Default
"solacia.agents.v0". basebooleanRequireddraftAgentDraftOut | nullRequiredidstringRequiredin_testbooleanRequired- One side of a running test: nothing can be published until it stops
languagesstring[]RequiredliveAgentVersionContentRequirednamestringRequirednotesAgentNote[]- Notes left on its rehearsals that no version took yet, oldest first
placesAgentPlace[]- Where it runs, with the last 30 days
rehearsalsAgentRehearsalMark[]- Its newest rehearsals
renderer"voice" | "face"- What buyers get: the voice, or voice and face Default
"voice". replacesAgentFactReplaces[] | null- What the facts it shows (the draft's, else the live version's) replace in the public docs; null while they are being checked
retiredbooleanRequired- Paused: it meets no buyer anywhere until resumed
runs("embed" | "outbound" | "link")[]- The defaults it holds; it can't pause until they move
scriptAgentScriptOutRequiredscript_of"draft" | "live"Required- Which version
scriptshows testAgentTest | nullRequired- Its running test between its versions
tests_startedAgentTestMark[]- Its tests between versions
unansweredAgentAsked[]- What its buyers asked in the last 30 days that the docs held no answer to
versionintegerRequiredversionsAgentVersionOut[]Required- Oldest first
weeksAgentWeek[]- Its last 12 weeks, oldest first
AgentDraftIn
What changes in the agent's draft; anything left out stays as the draft (or, with no draft, the live version) has it.
audiencestring | nullcounts"qualified" | "meeting" | null- What reaching the goal is: the buyer qualifies, or asks to meet the team
factsAgentFact[] | null- Replaces all its facts
goalstring | nullinstructionsstring | nullscriptAgentScriptIn | nulltone"brief" | "warm" | "expert" | "pack" | null- pack: as the brief says
voicesobject<string, string> | null- Voice id per language; Solacia only
AgentDraftOut
atstringRequiredbehindbooleanRequired- Another version went live after it was started: publishing is refused
bystring | nullRequiredcontentAgentVersionContentRequiredfaultsstring[]Required- Why its own lines can't go live yet; empty: it can be published
sinceintegerRequired- The version it was started from
AgentFact
namestringRequired- What it is about; one named like the docs' replaces it Up to 80 characters.
textstringRequired- What the agent says about it Up to 600 characters.
AgentFactReplaces
A public passage one of the agent's facts contradicts, left out of its calls' docs.
factstringRequired- The fact's name
pagestringRequired- The page's title
saysstringRequired- The page's sentence the fact replaces
urlstringRequiredwhatstringRequired- What the two state differently, in a few words
AgentIn
A new agent: the pack run another way. It runs nothing until a channel is given to it.
copy_ofstring | null- Start from this agent's tone, instructions, facts and voices
namestringRequired- Up to 200 characters.
priceinteger | null- US cents a demo; Solacia only. Left out: the list price
renderer"voice" | "face"- Default
"voice".
AgentLeverssolacia.agents.v0
What a test on the agent can learn, a lever at a time, from its last 30 days. In preview.
schemastring- Default
"solacia.agents.v0". agentstringRequiredbuyersintegerRequired- Its real buyers of the last 30 days
leversLever[]Required
AgentLine
ownbooleanRequired- The agent's own words; false: the product's
packstring | null- The product's words it replaces, when it is the agent's own
textstringRequired
AgentNote
atstringRequiredbystringRequireddonestring | null- The version it went into, or dropped; null while open
idstringRequiredquotestringRequired- The turn's words when it was left
sessionstringRequired- The rehearsal it was left on
tag"script" | "answer" | "screen" | "buyer"RequiredtextstringRequiredturnintegerRequired- The turn it is about (AgentTurn.n)
AgentNoteIn
sessionstringRequired- Up to 80 characters.
textstringRequired- Up to 1000 characters.
turnintegerRequired
AgentNotessolacia.agents.v0
schemastring- Default
"solacia.agents.v0". notesAgentNote[]Required
AgentNumbers
demosnumberRequiredengagednumberRequiredmeetingsnumberRequired- Demos where the buyer asked for a meeting
minutesnumberRequiredspendnumber | nullRequired- US cents: each demo at the price of the agent that ran it, when it ran. Solacia's people only; null for everyone else
AgentOut
audiencestring- Who its demos are for, in the team's words
basebooleanRequired- The first agent, the product's pack: every other one is built on it
changed_atstring | nullRequiredchanged_bystring | nullRequiredcostinteger | nullRequired- US cents a demo. Solacia's people only; null for everyone else
counts"qualified" | "meeting"- What reaching its goal is Default
"qualified". factsAgentFact[]Required- What only it knows, said at once like the docs
goalstring- What a demo with it is for, in the team's words
idstringRequiredinstructionsstringRequired- What it does differently on a call, in the team's words
last_30_daysAgentNumbersRequiredlist_priceinteger | nullRequired- US cents a demo at the list price for its renderer. Solacia's people only; null otherwise
namestringRequired- The team's name for it; buyers meet the guide by its own name
placedAgentPlaced- How many places of each kind it meets buyers in
renderer"voice" | "face"Required- What buyers get: the guide's voice, or voice and face
retiredbooleanRequired- Paused: it meets no buyer anywhere until resumed
runs("embed" | "outbound" | "link")[]Required- The channels whose demos it runs
state"testing" | "draft" | "live" | "idle" | "paused"- testing: in a running test; draft: a draft waits to go live; live: meets buyers; idle: meets nobody; paused: retired, its places sending buyers on until it resumes Default
"live". tone"brief" | "warm" | "expert" | nullRequired- How it talks; null: as the product's brief says
versioninteger- Its live version; GET /v1/agents/{id} has every one Default
1. voicesobject<string, string>Required- Its voice id per language, where not the product's
AgentPart
idstringRequiredintroobject<string, AgentLine>Required- Language -> the agent's own introduction, said after the name; the product has none
nameobject<string, string>- Language -> the sentence the part opens on, said by the call
showsbooleanRequired- In the agent's focus; the ones it shows come first, in its order
titleobject<string, string>Required
AgentPlace
One place the agent meets buyers, with its last 30 days: rule, a website rule on where buyers came from (when source) or the page (when page); website, the website's buyers no rule picks; campaign, the personal links of one campaign made with it; links, personal links with no campaign (with the account's default, also links that name no agent); address, the product's own demo address.
campaignstring | nulldemosinteger- Default
0. kind"rule" | "website" | "campaign" | "links" | "address"Requiredlinksinteger | null- Links made, for a campaign or single links
matchstring | nullreachedinteger- Demos that reached the agent's goal Default
0. when"source" | "page" | null
AgentPlaced
How many places of each kind an agent meets buyers in; GET /v1/agents/{id} lists each.
addressboolean- It meets buyers on the product's own demo address Default
false. campaignsinteger- Campaigns whose personal links were made with it Default
0. linksinteger- Personal links made with it outside any campaign Default
0. outreachboolean- Personal links made with no agent named meet it Default
false. pagesinteger- Website rules on a page Default
0. sourcesinteger- Website rules on where buyers came from Default
0. websiteboolean- It meets the website's buyers no rule picks Default
false.
AgentRehearsalsolacia.agents.v0
A rehearsal read back, turn by turn, with the notes on it. In preview.
schemastring- Default
"solacia.agents.v0". atstringRequiredbystringRequirednotesAgentNote[]Requiredofinteger | "draft"RequiredpartsAgentScriptPart[]RequiredsessionstringRequiredturnsAgentTurn[]RequiredurlstringRequired- The demo, to go on with it
AgentRehearsalMark
atstringRequiredbystringRequirednotesintegerRequired- Open notes on it
ofinteger | "draft"Required- What it ran: a version, or the draft as it was then
sessionstringRequiredurlstringRequired- The demo, to go on with it
AgentRehearseIn
ofinteger | "draft"- A version's number, or the draft as it is now Default
"draft".
AgentRouteIn
agentstringRequired- The id of the agent to run the channel's demos Up to 80 characters.
AgentRule
One website rule: buyers who came from match (when source: one of your own tags by its name such as utm_campaign=spring-launch, a tag's value in any tag such as spring-launch, a referring site such as linkedin, or a channel such as paid or social), or who opened the demo on a page under match (when page: a path such as /card), meet agent.
agentstringRequired- Up to 80 characters.
matchstringRequired- Up to 120 characters.
when"source" | "page"Required
AgentRulesIn
The website's rules, in order: the whole list, replacing the one before. Empty: every website buyer meets the embed channel's agent.
rulesAgentRule[]Required
AgentScriptIn
What changes of the agent's script; each field sent replaces that field whole.
choicesAgentChoiceIn[] | null- Its own buttons under the opening; []: the product's
introobject<string, string> | null- Its own opening per language; {}: the product's
linesobject<string, object<string, string>> | null- Its own introduction to a part, per language; {}: the product's
orderstring[] | null- The parts it shows, in order; []: all of the product's
AgentScriptOut
The script as a buyer meets it, each line marked when it is the agent's own.
buttonsobject<string, AgentButton[]>Requiredfirst_deckstring | nullRequired- A deck that starts the demo by itself, so the opening asks nothing
openingobject<string, AgentLine>Requiredown_buttonsbooleanRequiredpartsAgentPart[]Required
AgentScriptPart
idstringRequiredtitlestringRequired
AgentSuggestion
A test worth running, read from what the agent's buyers did in the last 30 days.
buyersintegerRequired- The buyers the pattern is about
idstringRequired- opening, or part:<part id>: what a test would change
kind"left_on_part" | "left_early"Required- left_on_part: buyers who stayed past the first minute and left without the goal left while this part was on; left_early: buyers left in the first minute, in the opening
ofintegerRequired- Out of: every demo for left_early, the ones that left without the goal otherwise
partstring | nulltitleobject<string, string> | null- The part's title per language
AgentSuggestionssolacia.agents.v0
schemastring- Default
"solacia.agents.v0". suggestionsAgentSuggestion[]Required
AgentTest
agentstring | null- The agent whose versions are the sides, wherever it is placed
armsTestArm[]Requiredbystring | nullRequiredchancesnumber[]- The best challenger against A: worse, about the same, better
channel"embed" | "outbound" | "link" | nullRequired- Null: a test between one agent's versions
endedbooleanRequired- Past its end and not stopped: new buyers meet side A, one side waits to be kept
endsstring | nullRequired- When it stops taking buyers; null: when the team stops it
guardrailsTestGuardrail[]- Between an agent's versions: what the test must not make worse, side A against B
highnumberRequiredidstringRequiredkeptstring | nullRequired- The agent kept for the channel when it stopped
leaderstring | nullRequiredlever"message" | "features" | "pricing" | "offer" | "qualification" | null- What it is to learn, when it was started from a lever
liftnumberRequired- The best challenger's meeting rate minus A's
looksTestLook[]- Week by week, oldest first
lownumberRequired- 95% interval of that difference, valid however often it is read
meetings_from"demo" | "form" | "crm" | "qualified"- What counts as a meeting. demo: asking in the demo; form: that, or sending the vendor's own demo form (the website against no demo); crm: a meeting the account's CRM shows booked after the prospect's link was made (outreach against no demo); qualified: the buyer qualified, hot or warm, which asking for a meeting also is (a test between versions) Default
"demo". min_buyersintegerRequired- Buyers each side needs before any verdict
moreintegerRequired- Buyers each side still needs: before any verdict when early, to decide when ahead
per_side_weeknumber | null- Buyers a week on its smallest side, from its whole weeks so far
questionstringRequiredrule"unless_worse" | "proven"- How it decides. proven: a side goes live once it beats the others past chance; unless_worse (between an agent's versions): a challenger may go live once keeping it would cost under 0.2 points on average if it were worse, read at the end of each week Default
"proven". saysstringRequired- The readout in one sentence
sidesTestSide[]- Between an agent's versions: how far each side's buyers got
srmnumberRequired- p-value of the sample-ratio check
startedstringRequiredstoppedstring | nullRequiredverdict"early" | "ahead" | "winner" | "even" | "safe" | "broken"Required- winner: one side beats every other past chance, on an interval that holds however often the test is read; safe (unless_worse): at the end of one of its weeks a challenger risked under 0.2 points if worse, so it may go live (
leader); even: the gap is proven under 2 points; broken: the buyers did not fall on the sides as the shares say weeks_leftinteger | null- Weeks until
morebuyers a side arrive at that pace; null when not counting
AgentTestCrmCheck
checkedintegerRequired- Prospects whose meetings this check read
detailstringRequired- Why nothing could be read; empty when the CRM answered
markedinteger- Contacts newly marked with their side in the CRM's Solacia test group field Default
0. meetingsintegerRequired- Of them, the ones with a meeting booked since their link was made
AgentTestIn
A test on one channel: side A is the agent that runs it now; two or three sides, each a different agent with at least 10% of buyers, adding to 100.
armsTestArmIn[]Requiredchannel"embed" | "outbound" | "link"Requiredmin_buyersinteger- Buyers each side needs before any verdict 20 to 100000. Default
20. questionstring- Up to 200 characters.
weeksinteger | null- How long it takes buyers; left out: until stopped
AgentTestMark
idstringRequiredkeptstring | nullRequiredstartedstringRequiredstoppedstring | nullRequired
AgentTestPlan
What a test of the agent's versions would catch at its pace, before it starts. Simulated.
agentstringRequiredcounts"qualified" | "meeting"Required- What its goal counts, the test's primary metric
gapsTestPlanGap[]Requiredguardrails("meetings" | "minutes" | "left_early")[]Required- What the test watches beside its goal
per_weekintegerRequired- Buyers a week it meets, from its last four weeks
ratenumberRequired- Its rate on what its goal counts: qualified, or asked to meet
rate_knownbooleanRequired- False: it has too few buyers yet, so 20% is assumed
shareintegerRequired- Percent of buyers on the challenger
weeksintegerRequired- How long each simulated test may run
AgentTestStopIn
keepstring | null- The agent to run the channel from now on; in a test between an agent's versions, the side (A, B or C) whose version goes live
AgentTurn
atstringRequiredcheck"backed" | "drifted" | "wrong" | "unchecked" | null- An answer: what the docs made of it
nintegerRequired- Its place in the rehearsal, from 1
ownstring | null- In a script turn, the words in it that were the agent's own
partstring | null- The part of the script it belongs to, when known
sourcesstring[]- An answer's pages, or the details nothing backed
tag"script" | "answer" | "screen" | "buyer"Required- Where its words came from: script (said as written), answer (the agent's own), screen (what it showed), buyer
textstringRequired
AgentVersionContent
A version: what a buyer gets from the agent. Script fields left empty are the pack's.
audiencestringRequired- Who its demos are for, in the team's words
choicesAgentChoiceOut[]Required- Its own buttons under the opening
counts"qualified" | "meeting"- What reaching the goal is, as a test of its versions reads it Default
"qualified". factsAgentFact[]RequiredgoalstringRequired- What a demo with it is for, in the team's words
instructionsstringRequiredintroobject<string, string>Required- Its own opening per language
linesobject<string, object<string, string>>Required- Its own introduction to a part, per language
orderstring[]Required- The parts it shows, in order; empty: all of the product's
tone"brief" | "warm" | "expert" | nullRequiredvoicesobject<string, string>Required
AgentVersionOut
atstring | nullRequired- When it went live; null for the pack's own first version
bystring | nullRequiredchangedstring[]- What it changed from the version before, in the team's words, such as Opening or Order of parts; or that it put an older version back. Empty for the first.
livebooleanRequirednumberintegerRequired
AgentVersionTestIn
A test between one agent's versions, wherever it is placed: side A is its live version; two or three sides, each a different version or its draft, with at least 10% of buyers, adding to 100. Read on the share of buyers who qualified.
lever"message" | "features" | "pricing" | "offer" | "qualification" | null- What it is to learn (GET /agents/{id}/levers): it is read on that lever's goal
min_buyersinteger- Buyers each side needs before any verdict 20 to 100000. Default
20. questionstring- Up to 200 characters.
rule"unless_worse" | "proven"- unless_worse: a challenger may go live unless it is worse; proven: only once it is proven better Default
"unless_worse". sidesVersionSideIn[]Requiredweeksinteger | null- How long it takes buyers; left out: until stopped
AgentWeek
demosintegerRequiredmeetingsintegerRequiredreachedintegerRequired- Buyers who did what its goal counts
startstringRequired- Its Monday
Agentssolacia.agents.v0
The account's agents, and the agent each channel runs: embed (the vendor's website), outbound (personal links from outreach) and link (the demo's own address). Then each channel's pace, and the tests between agents, newest first.
schemastring- Default
"solacia.agents.v0". agentsAgentOut[]Requireddefaultsobject<string, string>- The agent each teammate sends links with unless they pick another, by their email
languagesstring[]Required- The languages the demo's calls speak
list_pricesobject<string, integer> | nullRequired- US cents a demo for each renderer. Solacia's people only; null for everyone else
paceobject<string, ChannelPace>Requiredroutesobject<string, string>RequiredrulesAgentRule[]- The website's rules, in order: which agent a buyer meets by where they came from (the first that matches), then by the page the demo opened on (the most specific)
testsAgentTest[]Requiredtonesobject<string, ToneOut>Requiredvoice_poolobject<string, VoicePool>- The voices an agent can have, per language the demo speaks; empty when the product speaks with voices outside the pool
Analyticssolacia.analytics.v0
The team's analytics for the last days days against the days before: KPIs, activity by day, the funnel, what buyers told us, what they saw and asked, every session, companies. Shape v0: fields beyond these may still change; the Analytics screen owns them.
schemastring- Default
"solacia.analytics.v0". endstringRequiredperiod_daysintegerRequiredstartstringRequired
Anchor
atstringRequired- When that second was heard, ISO 8601.
snumberRequired- Seconds into the sound.
ApiBudgetUse
One window of a key's budget, as it stands now.
limitintegerRequired- Units the key may spend in the window.
usedintegerRequired- Units spent in the window so far.
window"minute" | "day"Required
ApiCall
One call a key made. No network address is kept.
atstringRequired- When it arrived, ISO 8601.
clientstringRequired- The caller's User-Agent, cut short.
countrystringRequired- Where it came from, as the host reads it: two letters, or empty.
msinteger | nullRequired- How long it took to answer, in milliseconds.
operationstringRequiredrequest_idstringRequired- Its X-Request-Id, to match the caller's own logs.
statusinteger | nullRequired- The HTTP status it answered with; null while it runs.
ApiCallDay
One day (UTC) of a key's calls, by how they answered.
daystringRequired- YYYY-MM-DD.
failedintegerRequired- Failed on our side (5xx), or never answered.
limitedintegerRequired- Over the key's budget (429).
okintegerRequired- Answered.
refusedintegerRequired- Refused: the key, its scopes or the input; the caller's to fix.
ApiKey
A key that can call this account's API, or one that could. Solacia keeps its hash, never the key.
atstring- When it was made, ISO 8601.
bystring- Who made it.
calls_30dinteger- The calls it made in the last 30 days, refused ones included. Default
0. daily_callsinteger[]- Its calls on each of the last 30 days (UTC), oldest first; the last is today.
ended_atstring- When it stopped working, ISO 8601; empty while it works.
ended_bystring- Who revoked it.
ended_why"" | "revoked" | "rolled" | "leaked" | "expired"- Why it stopped:
revokedby a person,rolledinto a new key,leaked(found in public and revoked by Solacia), orexpired; empty while it works. expires_atstring | null- When it stops working, ISO 8601; null: never.
hintstring- The key's prefix and last four characters,
sol_live_clara_…z1x9; empty for older keys. idstringRequired- The key's id: a prefix of its hash. Revoke, edit and roll it by this.
last_used_atstring | null- When it last made a call, ISO 8601; null: never.
leaksApiKeyLeak[]- Each place it was found in public, oldest first.
made_by_solaciaboolean- Made by Solacia for a script or a partner. Default
false. namestringRequired- What it is for.
rolled_fromstring- The id of the key this one replaced in a roll.
scopesstring[]Requiredstate"active" | "expired" | "revoked"- Whether it works:
expiredis past its end,revokedwas stopped. Default"active". yoursboolean- The key making this call. Default
false.
ApiKeyChange
What to change on a key; a field left out stays as it is.
expires_in_days7 | 30 | 90 | null- A new end, this many days from now: 7, 30 or 90; null for never. Leave out to keep it.
namestring | null- A new name.
scopesstring[] | null- Fewer scopes: a key is narrowed, never widened.
ApiKeyIn
expires_in_days7 | 30 | 90 | null- Days until it stops working: 7, 30 or 90; null for never. 90 when left out. Default
90. namestringRequired- What it is for: "Zapier", "Data warehouse". Up to 40 characters.
scopesstring[]Required- What it may do; see
scopesin the list.
ApiKeyLeak
One place a key was found in public, as GitHub's secret scanning reported it.
atstringRequired- When GitHub reported it, ISO 8601.
placestringRequired- The same in words:
a commit,an npm package,public code. revokedbooleanRequired- This report revoked the key; false when it had already stopped.
sourcestringRequired- What it was found in, in GitHub's words:
commit,content,npm, ... urlstringRequired- Where it was found; empty when GitHub gave no public address.
ApiKeyMade
endedApiKey[]- Revoked keys and keys past their end, the latest 50, newest first.
idstringRequired- The new key's id.
keysApiKey[]Requiredlifetimes(integer | null)[]- How many days a new key can work; null is never.
scopesApiScope[]RequiredsecretstringRequired- The key, shown this once: Solacia keeps only its hash.
ApiKeyRoll
overlap"now" | "1h" | "24h" | "7d"Required- How long the old key keeps working beside the new one;
nowstops it at once.
ApiKeyUsage
What one key did in the last 30 days: its calls by day and by operation, its latest calls, the demo links it made and the demos they brought, and its budget now.
budgetApiBudgetUse[]Required- Its budget per minute and per day; empty when the API counts none.
callsintegerRequired- Calls in the last 30 days, refused ones included.
daysApiCallDay[]Required- The last 30 days (UTC), oldest first; the last is today.
demos_causedintegerRequired- Demos in the last 30 days that came in by a link it made, whenever it made it.
keyApiKeyRequiredlinks_madeintegerRequired- Personal demo links it made in the last 30 days.
operationsApiOperationUse[]Required- What it called, the most called first.
recentApiCall[]Required- Its latest 50 calls, newest first.
ApiKeys
Every key that can call this account's API, newest first, the keys that stopped working, and what a new one can be.
ApiOperationUse
One operation a key called in the last 30 days.
callsintegerRequiredfailedintegerRequiredlimitedintegerRequiredoperationstringRequired- The operation's name, as in the contract:
leads.list. refusedintegerRequired
ApiScope
canstringRequired- What a key with it can do, in words.
namestringRequired- The scope, as a key carries it:
leads:read.
AppCheckResult
The explorer's last check of the vendor's app, signed in as the sandbox user: when, how many screens it reached, what changed since the check before, or why it could not check.
changesstring[]checkedstringRequiredcomparedboolean- False on the first check: nothing before it to compare with. Default
true. errorstringscreensintegerRequired
AppConnection
The vendor's own app, connected so the explorer can check the demo against it (in preview): its address and the sandbox user it signs in as. The password is never sent back. connected is false when none is.
atstringbystringcheckAppCheckResult | nullconnectedbooleanRequiredemailstringurlstring
AppConnectionIn
emailstringRequired- A sandbox user made for Solacia. Up to 200 characters.
passwordstringRequired- That user's password: kept sealed. Up to 200 characters.
urlstringRequired- The app's sign-in page, https://. Up to 500 characters.
AudiencePicksIn
pickedstring[]Required- The refs of the audiences picked.
Billing
What the account is billed for: its plan and counter, and one line per buyer per day with the reason it counts or not. A demo is a conversation of two minutes or more between one buyer and the agent, or a shorter one in which the buyer booked a meeting, once per buyer per Eastern day; tests never count, and neither does a call that ended on Solacia's side unless a meeting was booked. In preview.
countBillingCountRequired- Over every line of the days, whatever the page.
endstring (date)Requiredfinal_throughstring (date) | nullRequired- The last day closed; null: no day is final yet.
itemsBillingLine[]Required- The lines, newest first.
next_cursorstring | nullRequiredplanBillingPlan | nullRequired- Null: the account has no plan yet.
rulesstringRequired- The version of the counting rules.
startstring (date)Requiredtotalinteger- Lines of the days, over every page. Default
0.
BillingCorrection
A correction Solacia made to a final line: the line counts as it says from then on.
atstringRequired- When, ISO 8601.
reasonstringRequired
BillingCount
The days read, in the five words every report uses, and why the other lines did not count. Tests are left out of all of them and counted apart.
bookedinteger- Of
demos, the ones under two minutes that count by a booked meeting. Default0. correctedintegerRequired- Demos a correction took out.
demosintegerRequired- The billed unit: buyers on a day with two minutes of conversation or more, or with a meeting booked in a shorter one.
meetingsintegerRequired- Buyers on a day who asked for the account's team. Reported, never billed.
noneintegerRequired- Lines with no conversation.
openedintegerRequired- Times the demo was opened.
our_sideintegerRequired- Lines whose calls ended on Solacia's side.
qualifiedintegerRequired- Demos whose buyer fits the account's rules. Reported, never billed.
shortintegerRequired- Lines under two minutes.
talkedintegerRequired- Buyers on a day with any conversation.
testsintegerRequired- Lines left out as tests.
timed_outintegerRequired- Lines whose calls timed out with nothing heard.
BillingLine
One buyer on one Eastern day, and whether it counts as a demo.
atstringRequired- The first word, ISO 8601; the first opening when nobody talked.
audience"buyer" | "vendor" | "made_up" | "test" | "staff" | "try" | "rehearsal"Required- Who the demo is for. buyer: someone the vendor could sell to. vendor: a prospect's own people on a link Solacia made. made_up: a made-up buyer on dev. test: an address at the vendor's or Solacia's domain. staff: opened by Solacia's team. try: opened by a try link. rehearsal: the team rehearsing an agent.
testis true for test, staff, try and rehearsal. bookedboolean- The buyer booked a meeting with the account's team that day, in the demo. Default
false. buyerstringRequired- Their work email; "" for an anonymous buyer.
callsintegerRequiredcorrectionBillingCorrection | null- The correction that stands, if any.
countedbooleanRequired- It is a demo: the billed unit.
cutintegerRequired- Seconds of calls that ended on Solacia's side: never counted.
daystring (date)Required- The Eastern day.
demosstring[]Required- That day's demos of this buyer, oldest first: ids for GET /v1/demos/{id}.
doorstring | nullRequired- How they arrived, as on a demo.
finalbooleanRequired- Its day is closed: the line no longer changes, except by a correction.
linkstringRequired- The link they used; "" with none.
meetingbooleanRequired- The buyer asked for the account's team.
qualifiedbooleanRequiredreasonstringRequiredwhyin words, in English.secondsintegerRequired- The conversation that counts: calls that held, and typing.
silentintegerRequired- Seconds of calls that timed out with nothing heard: never counted.
talkedbooleanRequiredtypedintegerRequired- Of
seconds, typed. unendedintegerRequired- Calls with no ending on record, counted by their length.
why"demo" | "booked" | "test" | "our_side" | "timed_out" | "short" | "none" | "corrected"Required- The one reason it counts or not.
demo: two minutes or more.booked: under two minutes, and the buyer booked a meeting.
BillingMonth
One month of the plan, and how it stands.
carriedintegerRequired- Demos left by the month before; in month 1, brought in with the plan.
currentbooleanRequired- Today (Eastern Time) is one of its days.
firststring (date)RequiredincludedintegerRequired- The plan's demos a month.
laststring (date)RequiredleftintegerRequired- included + carried - used. Below zero: demos over the plan.
nintegerRequired- 1 is the plan's first month.
usedintegerRequired- Demos counted in its days so far.
BillingPlan
The account's plan: demos a month from a first day, and its counter. A month runs from the plan's day of the month to the day before it in the next, in Eastern Time. What a month leaves is added to the next; a month that ends over its plan takes nothing from it.
carriedintegerRequired- Demos brought in from an earlier plan, added to month 1.
counterBillingMonth[]Required- Every month that has begun, oldest first.
demosintegerRequired- Demos a month.
firststring (date)Required- The day month 1 begins.
laststring (date) | nullRequired- Its last day; null with no end.
monthsinteger | nullRequired- How many months it runs; null: no end.
standing"not_started" | "running" | "ended"Requireduncounted_beforestring (date) | null- Days before this one that are not final are not in the counter yet. Null: none.
BriefLink
The link to the buyer's brief that opens without a console account, to a work email at the account proven by a code, when a hand-off sent one.
ended_atstring | nullended_bystring | nullmadeintegerRequired- Links made for this demo's brief.
openbooleanRequired- One still opens: none ended since.
opensBriefOpen[]Required
BriefLinkEndIn
End every link a demo's brief went out with. The next hand-off makes a new one.
demostringRequired- Up to 120 characters.
BriefLinkMade
A new link to a demo's brief that opens without a console account, for the team to send a rep by hand. It opens to whoever proves a work email at the account (or at Solacia) with a code sent there, until it ends or the team ends it on Handoff.
ends_atstringRequired- When it stops opening, ISO 8601.
urlstringRequired
BriefOpen
One read of a brief link: when, by whom, and roughly where, as the host saw it.
atstringRequiredcitystring | nullcountrystring | nullplayedboolean- The call's recording started playing, rather than the brief being read. Default
false. readerstring | null- The work email the reader proved with a code sent to it.
regionstring | nullvisitorstring | null- The reader's address and browser, hashed: the same reader reads the same.
Buyer
One row of the console's Buyers list, one per buyer (their demos joined by work email): who they are, three facts, their main question and where it stands. In preview.
action"book" | "prep" | "follow_up" | null- What a seller does next: book the call they asked for, prep the call they booked, or send the follow-up; empty when there is no way to reach them. In preview.
agentstring | nullRequiredaskedBuyerAsked | nullRequiredaudience"buyer" | "vendor" | "made_up" | "test" | "staff" | "try" | "rehearsal"- Who the demo is for. buyer: someone the vendor could sell to. vendor: a prospect's own people on a link Solacia made. made_up: a made-up buyer on dev. test: an address at the vendor's or Solacia's domain. staff: opened by Solacia's team. try: opened by a try link. rehearsal: the team rehearsing an agent.
testis true for test, staff, try and rehearsal. Default"buyer". callsintegerRequired- Voice calls with the agent.
companystring | nullRequiredcrmbooleanRequireddemosintegerRequired- Their demos in all; 2 or more means they came back.
doneboolean- The action is done: a teammate marked it, or the call they booked has begun. A new demo or a new action brings it back. In preview. Default
false. doorstring | nullRequiredemailstring | nullRequiredfactsstring[]Required- Three things about their business.
first_atstringRequiredfitstringRequiredfollow_upbooleanRequiredfoundBuyerFound | null- With
q: what it met in what they said; empty when their name met it. idstringRequired- Their newest demo with their email (their newest, when none has it).
labelstringRequired- The outcome in words.
last_atstringRequiredlogostring | null- Their company's logo (Brandfetch's CDN), linked, never copied. In preview.
minutesnumberRequired- Active minutes in the demo.
namestring | nullRequired- The person, when their link's brief or their email names them.
numberinteger | nullRequiredoutcome"meeting" | "qualified" | "nurture" | "anonymous"RequiredqualifiedbooleanRequiredquestionsintegerRequiredreachintegerRequired- How far the demo went: opened, saw, asked, talked, asked to meet. 1 to 5.
rolestring | nullRequiredscoreintegerRequired- Orders buyers within an outcome: higher is more promising.
seenintegerRequired- The parts of the product they saw.
sessionsstring[]Required- Their demos in the period:
idfirst, then the rest newest first. Demos share a work email, or ran in the same browser before they gave one. sizestringRequired- Enterprise, Mid-market, SMB, or empty when unknown.
slotstring | nullRequired- The meeting time the buyer picked.
testbooleanRequiredunansweredintegerRequired
BuyerAsked
answered"yes" | "partly" | "no"RequiredtextstringRequired- Their main question, in their own words.
BuyerDone
action"book" | "prep" | "follow_up"RequireddonebooleanRequiredidstringRequired
BuyerDoneIn
A teammate marks the one thing to do for a buyer done, or takes the mark back.
action"book" | "prep" | "follow_up"Required- The action they did, as the row gave it.
doneboolean- False takes the mark back (Undo). Default
true.
BuyerFound
Where a search met the buyer: what they said (or a fact the demo learned), cut around the words, with where each word sits.
atstring | nullRequired- When they said it; empty for a fact.
demostringRequired- The demo they said it in.
marksinteger[][]Required- [start, end) of each matched word in
text. textstringRequiredwhere"call" | "chat" | "tapped" | "fact"Required- Said on a call, written in the chat, a suggested question they tapped, or a fact.
Buyers
buyersBuyer[]RequireddaysintegerRequiredhidden_testsintegerRequired- Test demos left out; ask with tests=true to see them.
next_cursorstring | null- Pass it as
cursorfor the buyers after these; empty on the last page. totalinteger- Buyers that matched, over every page. Default
0.
Call
endedstring | nullRequired- goodbye, left, idle, limit, timeout, error; null when unknown.
minutesnumberRequiredmodelstring | null- Always null. Kept so v1 answers stay the same shape.
started_atstringRequiredvoicestring | null- Always null. Kept so v1 answers stay the same shape.
CallAsked
answerstringRequired- The rep's answer, true for every buyer.
questionstringRequiredsaidstringRequired- The rep's own sentence, from the transcript.
CallMove
movestringRequiredsaidstringRequired
CallObjection
handlingstringRequiredobjectionstringRequiredsaidstringRequired
CallPicksIn
pickedstring[]Required- The refs of the folders or spaces picked.
CallPlace
A Granola folder or space, or a Fathom team or meeting type, that may hold the vendor's sales calls.
kindstringRequired- folder or space (Granola); team, meeting_type or every (Fathom)
namestringRequiredrefstringRequired- kind:id, as picked.
CallPlaces
The folders and spaces the key reaches, and those picked.
pickedstring[]- The refs picked.
placesCallPlace[]Required
CampaignResult
What one campaign's links have brought so far.
campaignstringRequired- Empty for links made without one.
linksintegerRequiredopenedintegerRequired- Links whose prospect ran at least one demo.
qualifiedintegerRequired- Prospects whose hottest demo is hot or warm.
team_requestsintegerRequired- Prospects who asked to talk to your team.
ChannelPace
crmCrmPace | null- Outreach only: the same for a test against no demo, whose meetings come from the CRM
demosintegerRequired- Demos the channel labelled in the last 30 days, test demos left out
meetingsintegerRequiredper_sideintegerRequired- Buyers each side of a test needs to see that rate rise by half
per_side_doubleintegerRequired- Buyers each side needs to see it double
per_weeknumberRequiredratenumberRequired- The channel's meeting rate; 10% until it has 20 demos of its own
ChapterOut
atstringRequired- When the chapter's first line was said, ISO 8601, on the transcript's clock.
titlestringRequired- Its name, a few words.
Chapters
A recorded call's parts, in order, each named; empty when the call has none to show. Named once per recording and language. In preview.
chaptersChapterOut[]Required
ChatbotConnection
A chatbot (Claude, ChatGPT, any MCP client) a person connected to this account by OAuth. It acts as that person, with no more than they allowed and their role allows.
atstringRequired- When it was connected, ISO 8601.
bystringRequired- The email of the person who connected it.
calls_30dinteger- The calls it made in the last 30 days, refused ones included. Default
0. clientstringRequired- The chatbot's name, as it gave it.
daily_callsinteger[]- Its calls on each of the last 30 days (UTC), oldest first; the last is today.
ended_atstring- When it stopped working, ISO 8601; empty while it works.
ended_bystring- Who revoked it.
ended_why"" | "revoked" | "leaked" | "reused" | "signed_out" | "expired"- Why it stopped:
revokedby a person,leaked(its token found in public),reused(a spent token came back, so it may be stolen),signed_out(its person signed out everywhere, changed their password or left), orexpired(unused for 90 days). idstringRequired- The connection's id. Revoke it by this.
last_used_atstring | null- When it last made a call, ISO 8601; null: never.
scopesstring[]Required- What the person allowed it.
state"active" | "ended"- Whether it still works. Default
"active". yoursboolean- Connected by the person making this call. Default
false.
ChatbotConnections
The chatbots connected to this account, newest first, and the latest that stopped. An owner sees everyone's; anyone else sees their own.
connectionsChatbotConnection[]RequiredendedChatbotConnection[]- Connections that stopped working, the latest 50, newest first.
ChiliPiperIn
Chili Piper, as its admin made it for Solacia: an Edge API token with Concierge permissions.
tokenstringRequired- Up to 2000 characters.
ChiliPiperRouter
A Concierge router: its id, the name the API routes by (slug), its name, and where each of its fields (Chili Piper's data fields) gets its value ("" for nothing; one of ChiliPiperRouters.sources). listed_fields: Chili Piper named its fields; false, they are its standard data fields (PersonEmail, ...).
defsRouterField[]- Each field's type and, for a dropdown, the values it takes.
fieldsobject<string, string>RequiredidstringRequiredlabelsobject<string, string>- Each field's label in Chili Piper; a custom field's key is its UUID.
listed_fieldsboolean- Default
true. namestringRequiredslugstringRequiredtrigger"" | "InAppButton" | "ThirdPartyForm" | "RouterLink"- How the router is told the buyer came, which its field keys fit; empty: an in-app button.
ChiliPiperRouterIn
The router buyers go through (its slug, id or link) and where each of its fields gets its value (one of ChiliPiperRouters.sources, or "" for nothing); without fields, matched from their names and types.
fieldsobject<string, string> | nullrouterstringRequired- Up to 300 characters.
ChiliPiperRouters
The router buyers go through, and the token's routers to pick from. listed false: the token can't list routers, so the router is named by hand. typed false: the token can't read the data fields' types (Data fields: Read), so only the router's own form gives them.
chosenChiliPiperRouter | nullRequiredlistedbooleanRequiredroutersChiliPiperRouter[]RequiredsourcesFieldSource[]typedboolean- Default
true.
ClayKeyMade
keybooleanRequired- Whether a Clay key is live.
key_atstring- When it was made, ISO 8601.
key_bystring- Who made the live key.
last_link_atstring | null- When Clay last made one, ISO 8601; null before the first.
linksintegerRequired- Prospects whose link Clay made.
pathstringRequired- Where Clay's HTTP column sends each row, on this site: the account's own API, which passes a key straight to its engine.
secretstringRequired- The key, shown this once: Solacia keeps only its hash.
ClayStatus
Whether Clay can make links for this account, and what it has made: the console's proof that a Clay column is really connected.
keybooleanRequired- Whether a Clay key is live.
key_atstring- When it was made, ISO 8601.
key_bystring- Who made the live key.
last_link_atstring | null- When Clay last made one, ISO 8601; null before the first.
linksintegerRequired- Prospects whose link Clay made.
pathstringRequired- Where Clay's HTTP column sends each row, on this site: the account's own API, which passes a key straight to its engine.
Concern
dealbreakerbooleanRequiredtextstringRequired
Contact
companystring | nullRequired- From the email's domain.
countrystring | null- Where their company is based (ISO 3166 code), when the buyer said it.
emailstring | nullRequiredemployeesinteger | null- How many people their company has: what the buyer said, else the company lookup's.
rolestring | nullRequired
CraftLinkIn
A Craft API connection the vendor made for the documents the agent may answer from.
keystring- The connection's API key, when it has one. Up to 500 characters.
urlstringRequired- Up to 300 characters.
CrmField
One field of your CRM that Solacia may write (a Salesforce Lead field, a HubSpot contact property), as your CRM describes it.
choicesstring[]Required- A closed list's active values, as your CRM spells them.
kind"list" | "text" | "boolean" | "date" | "datetime"RequiredlabelstringRequired- What your team calls it.
lengthintegerRequired- The most characters it holds (text).
namestringRequired- Its API name (Salesforce) or internal name (HubSpot).
CrmFields
Your CRM's fields Solacia may write, by name, for a field map. In preview.
connectedbooleanRequired- Your CRM is connected and answered; when not, the list is empty.
itemsCrmField[]Requirednext_cursorstring | nulltotalintegerRequired
CrmList
idstringRequirednamestringRequiredsizeintegerRequired- People on it (a campaign's contacts and leads), as the CRM last counted them.
updatedstringRequired- When it last changed, ISO 8601, as the CRM says it.
CrmListLinks
madeDemoLink[]Requirednextstring- Pass as
afterfor the next page; empty after the last. no_emailinteger- Contacts on this page without an email: no link. Default
0. no_fieldboolean- Salesforce: the org has no Solacia_Demo_Link__c URL field on Contact and Lead, so the links were made but not saved on the records. Default
false. refusedLinkRefused[]refused_by_crmstring- Why the CRM refused the write, in its words.
writtenbooleanRequired- Whether each link reached its record: HubSpot's Solacia demo link property, Salesforce's Solacia Demo Link field.
CrmListLinksIn
Personal links for one page of a CRM list's contacts, written back onto each contact.
afterstring- Where this page starts: the last answer's
next. Up to 256 characters. agentstring | null- The agent they meet; left out: the sender's default.
campaignstring- Up to 80 characters.
daysinteger- How long the links open the demo. 1 to 90. Default
30. list_idstringRequired- Up to 64 characters.
CrmLists
The lists in the account's CRM a send can start from: HubSpot's contact lists, Salesforce's campaigns.
connectedbooleanRequired- Whether Solacia holds a connection to it.
crmstringRequired- The account's CRM (
hubspot,salesforce), or empty when none is chosen. listsCrmList[] | nullRequired- Its contact lists, most recently changed first; null when the CRM refused, such as a HubSpot connection made before Solacia asked to read lists.
refusedstring- Why the CRM refused, in its words.
CrmPace
per_sideintegerRequiredper_side_doubleintegerRequiredratenumberRequired- The meeting rate assumed for cold outreach
Deal
A deal the buyer is on in the account's CRM, as the team keeps it there.
amountstringRequired- As the CRM holds it; empty when none.
closed_atstringRequired- When it was won or lost, ISO 8601; empty while open.
currencystringRequiredidstringRequirednamestringRequiredstagestringRequired- Its stage, as the CRM names it.
state"open" | "won" | "lost"Required
Deleted
deletedbooleanRequired
Demosolacia.demo.v1
One run of the demo, by one buyer, as the record shows it: when, how long, in what language, whether they left an email, what calls it had.
schemastring- Default
"solacia.demo.v1". audience"buyer" | "vendor" | "made_up" | "test" | "staff" | "try" | "rehearsal"- Who the demo is for. buyer: someone the vendor could sell to. vendor: a prospect's own people on a link Solacia made. made_up: a made-up buyer on dev. test: an address at the vendor's or Solacia's domain. staff: opened by Solacia's team. try: opened by a try link. rehearsal: the team rehearsing an agent.
testis true for test, staff, try and rehearsal. Default"buyer". callsCall[]RequiredcontactbooleanRequired- Whether the buyer left an email; the lead has it.
first_atstringRequiredidstringRequiredlanguagestring | nullRequiredlast_atstringRequiredminutesnumberRequirednumberinteger | nullRequiredpriority"hot" | "warm" | "nurture" | "cold"RequiredproductstringRequiredstagesstring[]RequiredtestbooleanRequiredturnsintegerRequired- What the buyer typed or said, as turns.
DemoLink
A personal link: it opens the demo without the password and records the demo under the prospect's email. With what the prospect has done since it was made.
agentstring | null- The agent the link was made with; null: the outbound channel's.
anonymousboolean- Default
false. campaignstringcompanystringRequireddemosinteger- Demos the prospect ran since the link was made. Default
0. emailstringRequiredexpires_atstringRequired- ISO 8601, UTC.
last_demo_atstring | null- ISO 8601; null before a demo.
made_atstringRequired- ISO 8601.
made_bystringRequirednamestringRequirednotesstringRequiredpriority"hot" | "warm" | "nurture" | "cold" | null- The hottest of those demos; null before one.
rolestringRequiredsent_tostringteam_requestedboolean- They asked to talk to your team in one of them. Default
false. teststring | null- The outreach test that sorted them when the link was made.
try_outboolean- A try link, kept for your team to try the demo. Default
false. urlstringRequired- The link to send; empty when the site cannot sign links.
with_demoboolean- False while an outreach test puts this prospect on its side with no demo: send them the same email without the demo link.
urlis then empty. Defaulttrue.
DemoLinkIn
A personal demo link for one prospect, and who they are. Everything but the email is optional; what is given, the agent reads before the call. An anonymous link needs no email and names nobody.
agentstring | null- The agent the prospect meets: its id. Left out: the sender's default agent, else the outbound channel's.
anonymousboolean- A link for someone unnamed: its demos are filed under an address made up for it, and a buyer who asks for your team gives their own email. Default
false. campaignstring- The list, segment or sequence the link goes out in, such as CFOs Mexico Q4. Your team's label: the agent never sees it; the lead record carries it. Up to 80 characters.
companystring- Up to 80 characters.
daysinteger- How long the link opens the demo. 1 to 90. Default
30. emailstring- The prospect's work email; none for an anonymous link. Up to 254 characters.
namestring- Their name, to greet them by. Up to 80 characters.
notesstring- What the rep knows that should shape the demo. The agent checks it with the buyer before relying on it and never quotes it. Up to 600 characters.
rolestring- Their job, such as CFO. Up to 80 characters.
sent_tostring- Who you sent the link to: a company, a person or both. Your team's label: the agent never sees it. Up to 80 characters.
try_outboolean- A try link, Solacia's team only: one we keep to try the demo ourselves, never sent to a buyer. Its demos never post to Slack or reach the CRM. Anyone else is refused. Default
false.
DemoLinks
The links made from the console or the API, newest first, one per prospect, and what each campaign has brought.
campaignsCampaignResult[]- One row per campaign over every link, most links first.
linksDemoLink[]Requirednext_cursorstring | null- Pass it as
cursorfor the links after these; empty on the last page. totalinteger- Links that matched, over every page. Default
0.
DemoLinksIn
Personal demo links for a list of prospects, made in one request: a file a rep dropped, or a sequence's export. Each row is one prospect, as for a single link.
rowsDemoLinkIn[]Required- Up to 500 prospects.
DemoLinksMade
What a batch made: a link per prospect, in the order given, and the rows refused.
madeDemoLink[]RequiredrefusedLinkRefused[]
DemoPage
itemsDemo[]Requirednext_cursorstring | nullRequiredtotalinteger- Demos that matched, over every page. Default
0.
DemoTheme
The colours the demo wears now (colours), and the product's own (default), which a reset goes back to.
coloursThemeColoursRequiredcustombooleanRequired- Whether the team picked these, rather than the product's own
defaultThemeColoursRequired
Dictation
textstringRequired- What was said, punctuated; empty when nothing was heard
DictationIn
A recording of someone saying an answer, base64, as the browser recorded it.
audiostringRequired- The recording, base64, up to 3 MB Up to 4200000 characters.
typestring- Up to 100 characters. Default
"audio/webm".
DisputeSide
Where one side of a dispute says it: the section of an internal document, or a public docs page.
documentstring- The internal document's title; empty for a public page.
saysstringRequired- Its sentence that states it, as written there.
titlestringRequired- The internal section's heading, or the public page's title.
urlstring- The public page's address; empty for an internal document.
DocsDispute
A fact an internal document and the public docs state two ways.
internalDisputeSideRequiredpublicDisputeSideRequiredwhatstringRequired
DocsDisputes
The side the agent follows, what is in dispute, and how many internal documents are still to be checked against the public docs (POST /internal-docs/check until 0).
disputesDocsDispute[]prefer"internal" | "public"Requireduncheckedinteger- Default
0.
DocsLive
atstringRequired- When it was made live, ISO 8601.
bystringRequired- Who made it live.
versionstringRequired- The id of the version the agent answers from.
whystring
DocsLiveIn
versionstringRequired- The id of a kept version. Up to 64 characters.
whystring- Why: shown with the version. Up to 300 characters.
DocsVersion
The vendor's docs as fetched once and kept: the pages the agent can answer from.
atstring- When it was published, ISO 8601.
bystring- Who or what published it: the weekly docs check, or a person.
fetchedstringRequired- The day its pages were fetched, YYYY-MM-DD.
idstringRequired- The version's id: the same pages with the same text are the same version.
pagesintegerRequired
DocsVersions
Which docs version the agent answers from, and the latest ones kept, newest first.
liveDocsLive | nullRequired- None until a version is published: the release's own copy answers.
versionsDocsVersion[]Required
Embed
One key that puts the demo on the vendor's own site. The key is public: it sits in the page.
calls_per_dayinteger | null- Voice calls a day it allows; null: no own limit.
keystringRequiredpausedbooleanRequired- Paused: the site shows no demo until Solacia resumes it.
sitesstring[]Required- The origins it answers on, such as https://www.acme.com; empty: any.
snippetstringRequired- The script tag to paste into the site's HTML, before </body>.
Embeds
The account's website embeds. Solacia makes the keys and their sites; none until it has.
embedsEmbed[]Required
EventType
One of the connected scheduler's event types (Calendly).
idstringRequired- The event type's id in the scheduler
kindstring- round robin, group, or empty for one person
minutesinteger- Default
0. namestringRequiredurlstringRequired- Its booking page
EventTypeIn
The event buyers book: one the connected scheduler lists.
idstringRequired- Up to 500 characters.
EventTypes
The event buyers book through a connected scheduler (chosen, none until one is picked) and the event types it offers.
FathomKeyIn
A Fathom user's API key: an admin's who can view all shared calls reaches the whole team.
keystringRequired- The key, as Fathom showed it. Up to 500 characters.
FieldMap
Which of your own CRM fields get where each buyer came from, in the map's order. In preview.
atstring | nullbystring | nullcheckedbooleanRequired- The rows were checked against your CRM (it is connected and answered).
crm"salesforce" | "hubspot"RequireditemsFieldMapItem[]RequiredlastFieldMapLast | null- What the map wrote on the last lead, when one was sent: a real buyer's values, so only for a caller who may read leads (leads:read).
next_cursorstring | nulltotalintegerRequired
FieldMapAnswer
answerstringRequired- Up to 2000 characters.
questionstringRequired- Up to 1000 characters.
FieldMapDraft
A field map drafted from your document, not saved: each row checked against your CRM when it is connected, the rows left out and why, and what the document leaves open. Save it with PUT /integrations/{crm}/field-map once a person has read it. In preview.
checkedbooleanRequired- The rows were checked against your CRM (it is connected and answered).
crm"salesforce" | "hubspot"RequireditemsFieldMapDraftItem[]Requiredleft_outstring[]Required- Rows the draft had that a map can't hold, each with why.
next_cursorstring | nullquestionsstring[]Required- What the document leaves open, for the person who saves the map.
totalintegerRequired
FieldMapDraftIn
Your account of your CRM process, to draft your field map from: the file itself (content, base64) or its text.
answersFieldMapAnswer[]- Your answers to the draft's questions.
contentstring- The file, base64: .pdf, .docx, .html, .md or .txt, up to 3 MB Up to 4200000 characters.
language"en" | "es" | "pt"- The language the questions are written in. Default
"en". namestringRequired- Up to 200 characters.
rowsFieldMapRow[]- The draft as you edited it, to change only where your answers do.
textstring- Or its text, instead of the file Up to 200000 characters.
FieldMapDraftItem
One drafted row, with the document's words it rests on.
basisstring- The document's words the row rests on.
bookedstring | nullfieldstringRequired- The field's API name. Up to 80 characters.
fixedstring | nullfollowsstring | null- Another row's field: this one is written only together with that row, on a new lead or when that row moves the lead on.
foundboolean | null- Your CRM has the field and lets Solacia write it; null when it was not checked.
missingstring[]- Labels the row sends that your closed list lacks.
moves_fromstring[]- On a lead your team already has: the values this row may replace. Any other value is never touched. Left out, a row with
fixedand another value moves on fromfixedonly. object"Lead"- Default
"Lead". swapobject<string, string>- Text in the value and what replaces it, such as underscores for spaces.
takestring | null- utm_source, utm_medium, utm_campaign, utm_term, utm_content, utm_id, an ad click id (gclid, msclkid, fbclid, oppref, ...), fbc (Meta's click id as fb.1.<ms>.<fbclid>), arrival_url (the page that brought the buyer, with its tags), demo_page, referrer_url or meeting_at (when the meeting they booked starts); or how the demo went: priority (Hot, Warm, Nurture, Cold), fit, brief (its link), last_demo (the day), asked_meeting (true or false). Ad click ids are sent whole or not at all.
valuesobject<string, string>- For a closed list: each tag value (any case) and the label it reads as. A value not here leaves the field empty.
whenobject<string, string>- A value for each outcome of the demo; of those that apply, the strongest wins (booked, asked_meeting, hot, warm, nurture, cold), else
any.fixedisany's value andbookedis booked's.
FieldMapIn
The whole map, replacing the one before. Empty: Solacia fills none of your own fields.
rowsFieldMapRow[]Required
FieldMapItem
One row of the map, with how it stands against your CRM now.
bookedstring | nullfieldstringRequired- The field's API name. Up to 80 characters.
fixedstring | nullfollowsstring | null- Another row's field: this one is written only together with that row, on a new lead or when that row moves the lead on.
foundboolean | null- Your CRM has the field and lets Solacia write it; null when it was not checked.
missingstring[]- Labels the row sends that your closed list lacks.
moves_fromstring[]- On a lead your team already has: the values this row may replace. Any other value is never touched. Left out, a row with
fixedand another value moves on fromfixedonly. object"Lead"- Default
"Lead". swapobject<string, string>- Text in the value and what replaces it, such as underscores for spaces.
takestring | null- utm_source, utm_medium, utm_campaign, utm_term, utm_content, utm_id, an ad click id (gclid, msclkid, fbclid, oppref, ...), fbc (Meta's click id as fb.1.<ms>.<fbclid>), arrival_url (the page that brought the buyer, with its tags), demo_page, referrer_url or meeting_at (when the meeting they booked starts); or how the demo went: priority (Hot, Warm, Nurture, Cold), fit, brief (its link), last_demo (the day), asked_meeting (true or false). Ad click ids are sent whole or not at all.
valuesobject<string, string>- For a closed list: each tag value (any case) and the label it reads as. A value not here leaves the field empty.
whenobject<string, string>- A value for each outcome of the demo; of those that apply, the strongest wins (booked, asked_meeting, hot, warm, nurture, cold), else
any.fixedisany's value andbookedis booked's.
FieldMapLast
What the map wrote on the last lead Solacia sent your CRM: the map's proof.
atstringRequireddroppedstring[]- The map's fields your CRM refused; the lead was written without them.
fieldsobject<string, string | boolean>Required- Each field the map wrote, by API name, with its value.
newbooleanRequired- A lead Solacia made; false: one your team already had, which gets only its empty fields.
refusedstring- Your CRM refused some of the map's fields, in its words.
FieldMapPreview
What a new lead from that buyer would get in each of your own fields. Nothing is written.
checkedbooleanRequired- Checked against your CRM's own fields (it is connected and answered).
itemsFieldMapPreviewLine[]Requirednext_cursorstring | nulltotalintegerRequired
FieldMapPreviewIn
A link a buyer opens, to see what your saved map would send for them.
meeting"none" | "asked" | "booked"- Whether the buyer asked for a meeting in the demo, or booked one. Default
"none". pagestringRequired- The page the buyer opens, with its tags. Up to 2000 characters.
priority"hot" | "warm" | "nurture" | "cold" | null- How Solacia rated the buyer after the demo.
referrerstring | null- The site that sent them.
rowsFieldMapRow[] | null- A map to preview instead of the saved one, such as a draft before it is saved.
FieldMapPreviewLine
One row of the map for that buyer: what it would send, or why the field stays empty.
fieldstringRequiredgivenstringRequired- The value before your CRM's field had its say; empty when there was none.
status"sent" | "no_value" | "not_in_table" | "not_in_list" | "no_field" | "too_long" | "unfit" | "on_booking" | "other_outcome" | "follows"Required- sent; or why it stays empty: no_value (the visit had no such tag), not_in_table (the row's labels lack the value), not_in_list (your CRM's list lacks the label), no_field (your CRM has no such field we may write), too_long (an ad click id longer than the field, never cut), unfit (not a yes/no or a date), on_booking (only once the buyer books), other_outcome (a value only for other outcomes of the demo), follows (written only with the row it follows, which stays empty).
valuestring | boolean | nullRequired- What a new lead gets in the field; null when it stays empty.
FieldMapRow
One of your CRM's fields and what Solacia puts in it: one of its values (take), or a fixed value (fixed, with booked in its place once the buyer books a meeting). A lead your team already has gets only its empty fields, except a step up from fixed to booked; a row that follows that row is written with the step up and only with it.
bookedstring | nullfieldstringRequired- The field's API name. Up to 80 characters.
fixedstring | nullfollowsstring | null- Another row's field: this one is written only together with that row, on a new lead or when that row moves the lead on.
moves_fromstring[]- On a lead your team already has: the values this row may replace. Any other value is never touched. Left out, a row with
fixedand another value moves on fromfixedonly. object"Lead"- Default
"Lead". swapobject<string, string>- Text in the value and what replaces it, such as underscores for spaces.
takestring | null- utm_source, utm_medium, utm_campaign, utm_term, utm_content, utm_id, an ad click id (gclid, msclkid, fbclid, oppref, ...), fbc (Meta's click id as fb.1.<ms>.<fbclid>), arrival_url (the page that brought the buyer, with its tags), demo_page, referrer_url or meeting_at (when the meeting they booked starts); or how the demo went: priority (Hot, Warm, Nurture, Cold), fit, brief (its link), last_demo (the day), asked_meeting (true or false). Ad click ids are sent whole or not at all.
valuesobject<string, string>- For a closed list: each tag value (any case) and the label it reads as. A value not here leaves the field empty.
whenobject<string, string>- A value for each outcome of the demo; of those that apply, the strongest wins (booked, asked_meeting, hot, warm, nurture, cold), else
any.fixedisany's value andbookedis booked's.
FieldSource
Where a router's field can get its value: the buyer's contact, a fact the call gathers, or the call read for that field ("call").
labelstringRequiredvaluestringRequired
Flow
Where every buyer of the last days days went: each way a demo can go (every way is listed, with 0 when nobody went it), each demo with its way, newest first, the agents and doors of the period with their counts (before those filters narrow it), and the test demos. In preview.
agentsFlowAgent[]RequireddaysintegerRequireddemosFlowDemo[]RequireddoorsFlowDoor[]Requiredendstring (date)RequiredpathsFlowWay[]Requiredstartstring (date)RequiredtestsFlowTestsRequiredunopenedFlowClick[]- Clicks on the website's demo button whose demo never appeared, counted in the way opened → left before seeing it; none when an agent filter is set, since no agent ran.
FlowAgent
demosintegerRequirednamestringRequired
FlowClick
A click on the website's demo button whose demo never appeared: the buyer left before seeing the product, most likely while it loaded (domain/metrics.py unopened).
atstringRequired- When they clicked, ISO 8601.
doorstringRequired
FlowDemo
One demo in the flow: the way it went and who it was.
agentstring | nullRequiredcallsintegerRequiredcompanystring | nullRequireddoorstring | nullRequiredemailstring | nullRequiredidstringRequiredlaststringRequiredminutesnumberRequiredoutcomestringRequiredprioritystringRequiredquestionsintegerRequiredrolestring | nullRequiredstartedstringRequiredstepsstring[]Requiredtestboolean- One of our own test demos (counted only with
tests). Defaultfalse.
FlowDoor
A door demos were opened through in the period, and how many.
demosintegerRequiredidstringRequired
FlowTests
countintegerRequired- Test demos in the period, counted or not.
includedbooleanRequired
FlowWay
One way a demo can go, from opening it to where the buyer is now, and how many went it.
nintegerRequiredstepsstring[]Required
FollowUp
bodystring | nullRequiredsubjectstring | nullRequired
FollowUpDraft
The demo's follow-up email as it now stands. In preview.
atstringRequiredbodystringRequirededited_bystring | null- Who edited it last; none when it is as drafted.
languagestringRequiredsubjectstringRequired
FollowUpIn
The follow-up email as a teammate edited it.
bodystringRequired- Up to 10000 characters.
subjectstringRequired- Up to 300 characters.
Foundation
What the account's customers say, quote by quote, graded by who said it, and what nobody has said yet. The ground every demo script is written from.
claimsFoundationClaim[]Required- Strongest and widest first
codesFoundationCodeOut[]Requiredgapsstring[]Required- What no customer has told us yet
kindsFoundationKindOut[]RequiredpeopleintegerRequired- Customers and buyers heard, each once
sourcesFoundationSourceOut[]RequiredvendorstringRequiredvoicesFoundationVoicesRequired- Sources by whose words they carry
FoundationAdded
foundationFoundationRequiredreadFoundationRead | nullRequired- The first part's read; none when it was read before
FoundationClaim
bystringRequiredcode"alternative" | "pain" | "outcome" | "capability" | "proof" | "anxiety" | "habit" | "loss"RequiredidstringRequiredmeasuredbooleanRequired- A quote behind it carries a number
quotesFoundationQuote[]RequiredreachintegerRequired- Customers and buyers behind it, each once
rolesstring[]RequiredsayablebooleanRequired- A public source backs it, so buyers may hear it
strength"many" | "one" | "vendor" | "ours"Required- Several customers or buyers; one; only the vendor's published material; only our reading
textstringRequired
FoundationClaimIn
goneboolean- Drop it Default
false. intostring | null- Fold it into this claim: its quotes count there
textstring | null- Its new wording
FoundationCodeOut
id"alternative" | "pain" | "outcome" | "capability" | "proof" | "anxiety" | "habit" | "loss"RequiredmeansstringRequiredmissingstringRequired- What the gap is called while no customer has said it
titlestringRequired
FoundationKindOut
id"won_call" | "lost_call" | "interview" | "crm_note" | "ticket" | "review" | "usage" | "case_study" | "vendor_page" | "our_note"RequiredlabelstringRequiredpublicbooleanRequired- Quotable to buyers unless the team says otherwise
voice"customer" | "buyer" | "vendor" | "ours"Required- Whose words it carries
FoundationQuote
customerstringRequireddatestringRequiredidstringRequiredkind"won_call" | "lost_call" | "interview" | "crm_note" | "ticket" | "review" | "usage" | "case_study" | "vendor_page" | "our_note"RequiredrolestringRequiredsourcestringRequiredtitlestringRequiredwordsstringRequired- The source's own words, cut from it exactly
FoundationRead
droppedstring[]Required- What the model cut that was not the source's own words, and why
keptintegerRequired- Quotes kept from this part
leftinteger[]Requirednew_claimsintegerRequiredpartintegerRequiredpartsintegerRequiredsourcestringRequired
FoundationReadIn
partintegerRequired- 0 to 100.
FoundationSourceIn
Raw evidence: a call's transcript, an interview, a CRM note, a ticket, a review, usage data, or the vendor's own page. Kept whole; the first part is read at once.
customerstring- Whose words: the company Up to 80 characters.
datestring- YYYY-MM-DD Up to 10 characters.
kind"won_call" | "lost_call" | "interview" | "crm_note" | "ticket" | "review" | "usage" | "case_study" | "vendor_page" | "our_note"Requiredpublicboolean | null- May be quoted to buyers; left out: by its kind
rolestring- Who spoke Up to 80 characters.
textstringRequired- Up to 200000 characters.
titlestring- Up to 120 characters.
FoundationSourceOut
atstringRequiredbystringRequiredcharsintegerRequiredcustomerstringRequired- Whose words: a company; two sources from one count once
datestringRequired- When it happened, YYYY-MM-DD, or empty
idstringRequiredkind"won_call" | "lost_call" | "interview" | "crm_note" | "ticket" | "review" | "usage" | "case_study" | "vendor_page" | "our_note"Requiredkind_labelstringRequiredleftinteger[]Required- Parts not read yet: read each with POST .../read
partsintegerRequired- The parts it is read in
publicbooleanRequiredquotesintegerRequired- Quotes kept from it
rolestringRequired- Who spoke: finance lead, controller, the person who spends
titlestringRequiredvoice"customer" | "buyer" | "vendor" | "ours"Required
FoundationVoices
buyerintegerRequiredcustomerintegerRequiredoursintegerRequiredvendorintegerRequired
Gapsolacia.gap.v1
A question the agent could not settle from the vendor's sources, counted across buyers; the team closes it once with an answer the agent then uses for everyone, or dismisses it.
schemastring- Default
"solacia.gap.v1". answerstringRequiredanswered_atstringRequiredareastring | null- The product area buyers' askings were routed to.
askedintegerRequiredbuyersGapBuyer[]- Who asked, newest first.
dismissed_atstring- When the team dismissed it; empty unless status is dismissed.
dismissed_bystring- Who dismissed it.
keystringRequiredkind"question" | "coverage"Requiredlisted_bystring[]RequirednamestringRequirednot_listed_bystring[]RequiredquestionstringRequiredreasonstringRequiredsaidstringRequiredsessionsstring[]Requiredstatus"open" | "closed" | "dismissed"Requiredvariantsstring[]RequiredwherestringRequired
GapAnswerIn
The team's answer to a question the agent couldn't answer. From then on the agent gives it, in its own words, to every buyer who asks it in any wording.
answerstringRequired- What buyers should be told, as the team would say it: facts only, no quotes. Up to 2000 characters.
keystringRequired- The gap's key Up to 2000 characters.
GapBuyer
A buyer who asked a gap's question: who, how their demo ended, and whether they left right after asking.
asked_atstringRequiredcompanystring | nullRequireddemostringRequiredemailstring | nullRequiredleft_after_snumber | null- Seconds from asking to their last activity.
left_soonboolean- They stopped within 90 seconds of asking. Default
false. outcome"meeting" | "qualified" | "nurture" | "anonymous"Requiredrolestring | nullRequiredtestbooleanRequired
GapCallsIn
keystringRequired- The gap's key Up to 2000 characters.
questionstring- The question as asked; left out: the gap's Up to 2000 characters.
GapDismissIn
Set a gap aside (a wrong flag, a test, something buyers are never told), or restore it. It leaves the open list and count; the guide's answers don't change.
dismissedboolean- false restores it to the open list Default
true. keystringRequired- The gap's key Up to 2000 characters.
reason"unpublished" | null- unpublished: the vendor deliberately doesn't publish this (a margin, a custom price), so the agent keeps handing it to the team (ADR 0009)
GapDocument
What the document says about the gap's question: whether it answers it (the judge), the passages nearest it, and the answer drafted from them alone when it does. Nothing is said to buyers until the team saves an answer.
answersbooleanRequireddraftstring | nullRequired- The answer drafted from the passages, checked against them
passagesGapDocumentPassage[]RequiredtitlestringRequired
GapDocumentIn
A document the team attaches to a gap: the file itself (content, base64) or, for a program or an agent that has it as text, its text. Kept in the product's docs store.
contentstring- The file, base64: .pdf, .docx, .html, .md or .txt, up to 3 MB Up to 4200000 characters.
keystringRequired- The gap's key Up to 2000 characters.
namestringRequired- Up to 200 characters.
questionstring- The question as asked; left out: the gap's Up to 2000 characters.
textstring- Or its text, instead of the file Up to 1000000 characters.
GapDocumentPassage
textstringRequiredtitlestringRequired- The document's name and the heading the passage sits under
GapList
built_atnumberRequireditemsGap[]Requirednext_cursorstring | null- Pass it as
cursorfor the questions after these; empty on the last page. openintegerRequiredtopicsobject<string, string>- The product's areas (a gap's or a question's
area) named as topics, inlanguage. totalinteger- Questions that matched, over every page. Default
0.
GranolaKeyIn
A Granola API key the vendor made: a workspace key, or a member's.
keystringRequired- The key, as Granola showed it. Up to 500 characters.
Handoff
crmHandoffCrm | nulldaysintegerRequiredfunnelHandoffFunnelRequiredhidden_testsinteger- Test demos' requests left out; ask with tests=true to see them. Default
0. next_cursorstring | null- Pass it as
cursorfor the requests after these; empty on the last page. requestsHandoffRequest[]Requiredtotalinteger- Requests in the window, over every page; the funnel counts them all. Default
0.
HandoffCrm
Whether the leads could be read in the CRM; when not, why (why, in words).
crmstring | nullRequiredmediannumber | null- Seconds from asking to the first dated sign, median.
movedinteger- Default
0. readbooleanRequiredstalledinteger- Default
0. waitinginteger- Default
0. whystring
HandoffFunnel
The requests by state, and the seconds from asking to the first person told.
askedintegerRequiredcrm_onlyintegerRequiredfailedintegerRequiredmediannumber | nullRequirednot_recordedintegerRequiredopen_mediannumber | nullopen_p90number | nullopenedinteger- Default
0. p90number | nullRequiredreachedintegerRequired
HandoffMoved
Whether the lead moved in the CRM after asking. state: moved (any sign), waiting (none yet, asked less than 7 days ago), stalled (none in 7 days). found: the CRM has the contact. first: seconds from asking to the first dated sign.
firstnumber | nullfoundbooleanRequiredsignsHandoffSign[]Requiredstate"moved" | "waiting" | "stalled"Required
HandoffRequest
A buyer who asked for the team. state: reached (a person was told: the routed email, the channel, or a booking), crm_only (the CRM took it, nobody was told), failed (every step stopped; each says why), not_recorded (asked before steps were kept, 2026-10-20). seconds: from asking to the first person told. went: the rule that took them then; now: where today's rules send them.
asked_atstringRequiredbrief_linkBriefLink | nullcompanystring | nullRequiredemailstring | nullRequiredmovedHandoffMoved | nullnowHandoffRouteRequiredopenednumber | nullprioritystringRequiredsecondsnumber | nullRequiredsessionstringRequiredslotstring | nullRequiredstate"reached" | "crm_only" | "failed" | "not_recorded"RequiredstepsHandoffStep[]RequiredwentHandoffRouteRequired
HandoffRoute
A routing rule's verdict: the rule (number from 1; 0: none), who it named, the CRM owner when a rule asked, and, for today's rules, why (because, condition by condition).
becausestring[]hoststring | nullnumberintegerRequiredownerstring | nullroutestring | nullRequiredtostring[]Required
HandoffSign
One sign the team took the lead on after they asked: a meeting or a logged call or email (at), a lifecycle stage past a lead (value, in words), or deals (value, how many).
atstring | nullkind"meeting" | "contacted" | "stage" | "deals"Requiredvaluestring
HandoffStep
One way a request went out. kind: slack, webhook, channel (none set), email (the routed one), crm, booking; or SES's word on that email: delivered, opened, clicked, bounced, complained, rejected, delayed. why: in words, when it didn't go. to: who the email named, or who it bounced from.
atstringRequiredkindstringRequiredokbooleanRequiredtostring[]RequiredwhystringRequired
IntegrationChoice
Which provider the account uses for a kind of integration, and where that came from: picked here or in the console ("console"), or the account's setup ("setup").
kind"crm" | "scheduling"Requiredproviderstring | nullRequiredprovidersstring[]Requiredsource"console" | "setup" | "none"Required
IntegrationChoiceIn
The provider to use: an id the kind offers, or "off".
providerstringRequired- Up to 40 characters.
IntegrationConnect
Where to send the account's owner to approve the connection in the provider's own app. They come back to the console, which finishes it (PUT /integrations/{id}/connection).
providerstringRequiredurlstringRequired
IntegrationConnection
A connection the account's owner made by signing in to the provider: which of the vendor's accounts it reaches (label), who made it and when. connected is false once it is removed.
atstringbystringconnectedbooleanRequiredlabelstringproviderstringRequired
IntegrationConnectionIn
What the provider sent the owner back with.
codestringRequired- Up to 2000 characters.
pickedstring- Google Drive: the ids of the files picked in Google's picker, comma-separated (picked_file_ids), as Google sent them back. Up to 20000 characters.
statestringRequired- Up to 500 characters.
IntegrationEvent
idstringRequired- The event type's id in the scheduler
namestringRequiredurlstringRequired- Its booking page
IntegrationFile
modifiedstringRequiredtitlestringRequired
IntegrationGroup
idstringRequireditemsIntegrationOut[]RequiredtitlestringRequired
IntegrationMadeBy
atstringRequired- When, ISO 8601.
bystringRequired- Who connected it.
labelstringRequired- What it is connected to, such as the HubSpot portal.
IntegrationOut
One integration as the console's Integrations page shows it.
callsinteger | null- Sales calls: how many were read, once something is picked.
connectbooleanRequired- An owner connects it by signing in there.
connectionIntegrationMadeBy | nullRequiredcrmstring | nullRequired- The CRM it is, when it is one.
detailstringRequired- One line on what it holds once connected, or why it was lost.
docsstring | nullRequiredeventIntegrationEvent | nullRequired- Calendly or Cal.com: the event buyers book.
eventsbooleanRequired- Calendly or Cal.com: its event types can be picked.
filesIntegrationFile[] | nullRequired- Internal docs: the files last read.
howstringRequired- How it is set up.
idstringRequiredlinestringRequired- What it does, in one line.
linkstring | nullRequired- HubSpot Meetings: the meeting link buyers book.
linksbooleanRequired- HubSpot Meetings: its meeting links can be picked.
namestringRequiredpastebooleanRequired- Connected by pasting a link (internal docs).
routerstring | null- Chili Piper: the router buyers go through.
routersboolean- Chili Piper, its token pasted: its routers can be picked. Default
false. routingbooleanRequired- Email alerts: set up on the Routing page.
schedulerstring | nullRequired- The scheduler it is, when it is one.
sign_in_againboolean- Zendesk, connected by an API token where it now connects by signing in: an owner signs in (POST /integrations/zendesk/sign-in) to keep it, and the audiences picked carry over. Default
false. skippedstring[]Requiredsnippetstring | nullRequired- The website embed's script tag, once it has a key.
status"connected" | "not_connected" | "planned"RequiredwhatstringRequired
IntegrationPicked
chosenstring | nullRequired- The provider picked, or off; null before a pick.
sourcestringRequired- Picked in the console, or the setup's.
Integrations
Every integration with its state, grouped as the console's Integrations page shows them, and the scheduler and CRM the account picked.
calendarIntegrationPickedRequiredcrmIntegrationPickedRequiredgroupsIntegrationGroup[]Required
InternalDoc
A document the agent answers from: its title and when its source last changed it.
modifiedstringtitlestringRequired
InternalDocs
What a source of internal docs holds at its last read, and what that read left out.
atstringconnectedbooleanRequireddocsInternalDoc[]labelstringproviderstringRequiredskippedstring[]- Each "Title: why" it was not read.
InternalDocsChoice
Which side the agent follows where the vendor's internal docs and its public docs state one thing two ways: the other side's passage is left out of what it answers from.
prefer"internal" | "public"Required
Leadsolacia.lead.v1
One buyer, as of at: who they are, why the lead matters, what they saw and asked, whether they want the team, and the follow-up drafted for them. The same record a CRM receives.
schemastring- Default
"solacia.lead.v1". activityActivityRequiredatstringRequiredcallsCall[] | null- With include=calls.
campaignstring | null- The campaign of the personal demo link the buyer came in by, if it named one.
concernsConcern[]RequiredcontactContactRequireddealsDeal[] | null- With include=deals: the buyer's deals in the account's CRM, read now.
eventstringRequired- lead.snapshot when read here; lead.contact, lead.team_request or lead.call_ended when pushed.
factsLeadFact[]Requiredfitstring | nullRequiredfollow_upFollowUp | nullRequiredlinkstringRequired- The team's page for this buyer.
networkNetwork | null- The company the buyer's network address was looked up as when they gave their email, if it was. An office network can name the company; home, mobile and VPN addresses mostly name none.
next_meetingstring[]Requirednumberinteger | null- Which try of the demo this is; #1 is the first.
priority"hot" | "warm" | "nurture" | "cold"RequiredproductstringRequiredquestionsLeadQuestion[]RequiredreasonsReason[]Requiredseenstring[]RequiredsessionstringRequired- The demo's id; the same as a demo's
id. sourceLeadSource | null- Where the buyer came from; null when nobody knows.
stagesstring[]Required- How far the demo went: email, call, saw, asked, team.
team_requestTeamRequestRequiredtestbooleanRequired- One of the vendor's or our own test demos.
transcriptLine[] | null- With include=transcript.
vendorstringRequired
LeadFact
groupstringRequiredlabelstringRequiredsourcestringRequired- said, confirmed or inferred
valuestringRequired
LeadPage
countsobject<string, integer>Required- Leads per priority, over the whole filter.
itemsLead[]Requirednext_cursorstring | nullRequiredtotalinteger- Leads that matched, over every page. Default
0.
LeadQuestion
answerstring | nullRequired- Only an answer that held; null when the team owes it.
answeredbooleanRequiredatstringRequiredchannelstringRequiredquestionstringRequired
LeadSource
Where the buyer came from: your own campaign tags as you wrote them, the campaign, the page that brought them to the demo, and Solacia's reading of a channel.
arrival_urlstring | null- The page that brought the buyer, with the tags Solacia kept from its address.
arrived_atstring | null- When that visit was, ISO 8601, when the site kept it.
campaignstring | null- The demo link's campaign, else the page's utm_campaign.
channelstringRequired- Solacia's reading of where the buyer came from, beside your own tags, never in their place: outbound (a personal demo link), paid, email, social, ai_assistant, organic, referral, campaign or direct; by the visit that first brought the buyer to the site when known, else the page the demo opened on.
click_idstring | null- Which ad click id the visit carried (gclid, msclkid, fbclid, li_fat_id, ...), if any.
click_idsobject<string, string>- The ad click ids of that visit, by name (gclid, msclkid, fbclid, oppref, ...).
embeddedboolean- The demo was opened from the embed on the vendor's own site. Default
false. first_touchSourceTouch | nulllanding_pagestring | null- The page the demo was opened on.
last_touchSourceTouch | nullreferrerstring | nullutmobject<string, string>- Your utm_source, utm_medium, utm_campaign, utm_term and utm_content, exactly as you wrote them, of the visit that first brought the buyer to the site when known, else of the page the demo opened on. Each touch below has its own.
Lever
changesstring[]Required- The parts of a version it changes
counts"qualified" | "meeting"Required- The goal its test is read on
id"message" | "features" | "pricing" | "offer" | "qualification"Required- message: what it says and how; features: what it shows first; pricing: what it charges (its facts); offer: what it asks the buyer to do (its goal); qualification: who it is for and what it asks them (audience, rules)
readingsLeverReading[]Required
LeverReading
What the agent's buyers did that a lever's test starts from: n of of buyers.
keystring | null- The part or the product area it is about
kind"left_early" | "left_on_part" | "asked_about" | "met_after_prices" | "met_without_prices" | "qualified_not_met" | "qualified" | "met_unqualified"Required- left_early: left in the first minute without the goal, of every buyer; left_on_part: left during part
keywithout asking to meet, of those who stayed a minute; asked_about: asked about areakey, of every buyer; met_after_prices / met_without_prices: asked to meet, of those shown the prices or not; qualified_not_met: did not ask to meet, of those who qualified; qualified: of every buyer; met_unqualified: did not qualify, of those who asked to meet nintegerRequiredofintegerRequiredtitleobject<string, string> | null- The part's title per language
Line
atstringRequiredkindstring- An event's kind: opened, played, source, showed, presented, team, call_started or call_ended.
notestringtextstringRequiredwhatstring- The screen, place or deck the event names, or how the call ended.
who"buyer" | "guide" | "event"Required
LinkRefused
A row no link was made for, and why: the same answer a single link would get.
codestringRequiredinvalid_email,personal_emailorinvalid_days.detailstringRequiredemailstringRequiredrowintegerRequired- The row's place in
rows, from 0.
MailEventTaken
What came of it: confirmed (the subscription), kept (with its buyer), ignored (not an event we keep), unmatched (no product or buyer in its tags).
result"confirmed" | "kept" | "ignored" | "unmatched"Required
MailEventsHeard
atstringRequired- When, ISO 8601.
eventstring- The SES event it carried, as Handoff's steps name it.
productstring- The account whose buyer it named.
resultstringRequired- What came of SNS's last post: confirmed, kept, ignored or unmatched.
MailEventsKeyMade
events_setstringRequired- The SES configuration set every routed email names (MAIL_EVENTS_SET); empty: no events.
keybooleanRequired- Whether the key SNS posts with is live.
key_atstring- When, ISO 8601.
key_bystring- Who made it.
lastMailEventsHeard | null- SNS's last post; null before the first.
pathstringRequired- Where SNS posts, on this site.
secretstringRequired- The key, shown this once: Solacia keeps only its hash.
MailEventsStatus
Whether SES's events on the routed emails reach Solacia: the console's proof.
events_setstringRequired- The SES configuration set every routed email names (MAIL_EVENTS_SET); empty: no events.
keybooleanRequired- Whether the key SNS posts with is live.
key_atstring- When, ISO 8601.
key_bystring- Who made it.
lastMailEventsHeard | null- SNS's last post; null before the first.
pathstringRequired- Where SNS posts, on this site.
Me
Who the key or session is, and what it may do: the first call to make with a new key.
accountstringRequiredaccount_namestringRequiredactor"operator" | "api_key" | "user" | "connection"RequirednamestringRequiredproductsstring[]Requiredrolestring | nullRequiredscopesstring[]Required
MeLanguageIn
language"en" | "es" | "pt"Required- English, Spanish or Portuguese.
MeNameIn
namestringRequired- How the team sees them on Team and in Handoff. Up to 80 characters.
MePasswordIn
currentstringRequired- Up to 200 characters.
newstringRequired- At least 10 characters. Up to 200 characters.
MePictureIn
imagestringRequired- A JPEG, PNG or WebP as a base64 data: URL, at most 48 KB decoded (a square of about 160 px); empty takes the picture away. Up to 65536 characters.
MeetingLink
One of the connected HubSpot's meeting links.
kindstring- one rep, group or round robin
namestringRequiredurlstringRequired
MeetingLinkIn
The link buyers book: one the connected HubSpot lists.
urlstringRequired- Up to 500 characters.
MeetingLinks
The meeting link buyers book through HubSpot Meetings (url, empty until one is picked) and the links the connected HubSpot offers.
linksMeetingLink[]RequiredurlstringRequired
Network
companystring | nullRequired- Null when the lookup named no company.
confidencestring | nullRequired- The provider's grade: very high, high, moderate, low or very low.
domainstring | nullRequiredindustrystring | nullRequiredmatches_emailboolean | nullRequired- The company's domain is the email's; null when either is missing.
providerstringRequiredsizestring | nullRequired- Employees, as a range such as 51-200.
Nothing
The input of an operation that takes only its path.
None.
Person
The caller, a person who signs in to the console. In preview.
added_atstring- When they joined, ISO 8601.
emailstringRequiredlanguage"en" | "es" | "pt"- What their console speaks: their own pick, else the account's language. In preview. Default
"en". namestringRequiredpicturestring- Their picture as a data: URL (a small square JPEG, PNG or WebP), or empty.
role"owner" | "member" | "solacia"Required
PoolVoice
accentstringRequired- The locale it is native to, e.g. es-CO
gender"f" | "m" | ""Required- f or m; empty for a product voice outside the pool
idstringRequired- The voice's id at the speech provider
namestringRequired- Its name; empty for a product voice outside the pool
Questionsolacia.question.v1
schemastring- Default
"solacia.question.v1". answerstring | nullRequiredareastring | nullRequiredatstringRequiredchannelstringRequireddemostringRequiredstatus"sourced" | "partial" | "unsourced" | "spoken" | "wrong" | "none"RequiredtextstringRequired
QuestionPage
itemsQuestion[]Requirednext_cursorstring | nullRequiredtotalinteger- Questions that matched, over every page. Default
0.
Reason
textstringRequiredtone"intent" | "fit" | "caution"Required
RecordingOut
One call of the demo as recorded: the buyer's voice and the agent's. In preview.
anchorsAnchor[]- Where the sound was against the clock, every half minute: a moment's place in the sound is read between the two around it (after
beganalone when there are none). audiostringRequired- A link that plays it (Opus in WebM) for the next hour.
beganstringRequired- When the sound starts, ISO 8601: the transcript's times fall on it.
nintegerRequired- Its number among the demo's recordings, oldest first; it never changes.
screenstring | null- A link to the buyer's screen through the call for the next hour: rrweb's events, JSON compressed with gzip, their times on the same clock as
began. None when none was kept. secondsintegerRequired
Recordings
The demo's calls as recorded and still kept: 90 days, when the call ran 2 minutes or more, the buyer qualified or asked to meet. In preview.
recordingsRecordingOut[]Required
RoutedBuyer
One of the latest buyers, and the rule that takes them (number from 1; 0: none).
askedbooleanRequiredbookedbooleanRequiredcompanystring | nullRequiredemailstringRequiredhoststring | nullnumberintegerRequiredownerstring | nullprioritystringRequiredroutestring | nullRequiredsessionstringRequiredtostring[]Required
RouterField
One field of a router's form, as Chili Piper defines it: the key the form sends it under, the data field it fills, its label, its type and the values a dropdown takes.
data_fieldstringkeystringRequiredkind"text" | "number" | "email" | "phone" | "choice" | "many" | "yes_no" | "date"- Default
"text". labelstringoptionsstring[]
Routing
The account's rules, the people to pick from, the product's rules a condition can name, whether this environment sends email, and where the latest buyers go.
editablebooleanRequiredownersRoutingOwnersRequiredpeopleRoutingPerson[]RequiredpreviewRoutedBuyer[]RequiredroutesRoutingRule[]RequiredrulesRoutingRuleOption[]RequiredsendingbooleanRequiredunreadablestring[]- Default
[].
RoutingCondition
One condition of a rule; any of its values holds. kind: priority (hot, warm, nurture), rule (the product's own fit and intent rules, by id), booked (booked, asked, or left: never asked for the team, flag lead_owner), crm_owner (no values).
kindstringRequired- Up to 20 characters.
valuesstring[]
RoutingIn
The account's rules, in order: the first that fits a buyer decides.
routesRoutingRule[]Required
RoutingOwners
Whether a rule can name the buyer's owner in the CRM here (crm: HubSpot or Salesforce), and if not, what to do (why).
crmstring | nullRequiredreadybooleanRequiredwhystringRequired
RoutingPerson
emailstringRequirednamestringRequiredrolestringRequired
RoutingPreview
previewRoutedBuyer[]Required
RoutingRecipient
Who hears: an email address, owner for the buyer's owner in the CRM, or booked_with for the rep the scheduler booked the meeting with (a rule naming them needs the condition booked: [booked]). weight: their percentage share when the rule takes turns.
emailstringRequired- Up to 320 characters.
weightnumber- Default
1.
RoutingRule
A rule: when all its conditions hold (none: every buyer), who hears and how. share: all (everyone on it) or turns (one, by weight, the same one for the same buyer).
channelsstring[]idstringRequired- Up to 64 characters.
ownsboolean- The one person it picks for a buyer owns their new lead in the CRM: the rep they booked with, else its turn's pick (Salesforce; flag lead_owner). Default
false. sharestring- Up to 8 characters. Default
"all". toRoutingRecipient[]whenRoutingCondition[]
RoutingRuleOption
One of the product's own fit or intent rules a condition can name.
checkstringRequiredidstringRequiredkind"fit" | "intent"RequiredlabelstringRequired
RoutingTest
Whether the test went, to whom, and why not.
detailstringRequiredsentbooleanRequiredtostring[]Required
RoutingTestIn
routestringRequired- Up to 64 characters.
SalesCall
What one call holds for the agent. No names: the reading strips them.
askedCallAsked[]RequireddatestringRequiredobjectionsCallObjection[]RequiredpitchCallMove[]RequiredsalesbooleanRequired- A call with a buyer; false for an internal meeting.
titlestringRequiredurlstring- The call in Granola or Fathom, for the vendor's team.
SalesCalls
What a sales-call connection (Granola or Fathom) covers: the folders picked, the calls read, newest first, and how many are still to read (POST again while unread is above 0).
SalesCallsReadIn
listed_withininteger- Once every call is read, list the picked folders again only when the last listing is older than this many seconds (0: always). Above 0, a connection with no folders picked is no error. 0 to 86400. Default
0.
SnsPost
What SNS posts: a subscription to confirm, or a notification carrying one SES event in Message (JSON). Field names are SNS's own.
Messagestring- Up to 200000 characters.
MessageIdstring- Up to 100 characters.
Signaturestring- Up to 1000 characters.
SignatureVersionstring- Up to 4 characters.
SigningCertURLstring- Up to 500 characters.
Subjectstring | nullSubscribeURLstring- Up to 2000 characters.
Timestampstring- Up to 40 characters.
Tokenstring- Up to 1000 characters.
TopicArnstring- Up to 300 characters.
TypestringRequired- Up to 40 characters.
UnsubscribeURLstring- Up to 2000 characters.
SourceTouch
atstring | nullchannelstringRequired- Solacia's reading of this visit, as the lead's
channel. click_idstring | null- Which ad click id this visit carried, if any.
pagestringRequired- The page's address, without its query.
referrerstring | nullRequired- The host of the site that sent the buyer there, if another site did.
utmobject<string, string>- The utm_ tags this visit carried, exactly as you wrote them.
Standing
Where one demo stands, as the console's demo page heads it: what it came to, the meeting time the buyer picked, the agent that ran it, where it was opened, and what followed. In preview.
agentstring | nullRequiredcrmbooleanRequired- Sent to the account's CRM.
doorstring | nullRequired- Where it was opened: outbound, site:<host>, site (the embed, page unknown) or link.
fitstringRequiredfollow_upbooleanRequired- A follow-up email is drafted.
idstringRequiredlabelstringRequired- The outcome in words.
outcome"meeting" | "qualified" | "nurture" | "anonymous"RequiredqualifiedbooleanRequired- Hot or warm by the account's fit rules, whatever the outcome.
seenintegerRequired- The parts of the product they saw.
slotstring | nullRequired- The meeting time the buyer picked.
sourceLeadSource | null- Where the buyer came from, your own tags first, as on the lead; null when nobody knows.
Started
The caller's first steps in the console, each done or not; none once every one was done, for Solacia's own people, or for a key.
crmstring- The CRM the account picked, by name; empty until one is.
sitestring- The vendor's own domain, where the demo goes.
snippetstring- The script tag for the site, once the account has an embed key.
stepsStartedStep[]Required
StartedStep
donebooleanRequired- Done, from what is true: never ticked by hand.
id"demo" | "crm" | "slack" | "team" | "site" | "two_step" | "question"Requireddemotry your own demo,crmconnect the CRM,slackconnect Slack,teaminvite the team,siteput the demo on the site,two_stepturn on two-step sign-in,questionanswer the first question the agent couldn't.
Team
Who can sign in to the account's console, the invitations out, and whether the caller may change either. In preview: invitations and changes are off for most accounts.
invitationsTeamInvitation[]RequiredmanagebooleanRequired- The caller may invite people, change roles and remove people.
membersTeamMember[]RequiredreachTeamReach | nullrecipientsTeamRecipient[]- Addresses on Handoff rules that don't sign in. Default
[]. sendingbooleanRequired- Invitations go out by email here; otherwise share the link.
TeamHandOverIn
emailstringRequired- Whose place on the Handoff rules moves. Up to 254 characters.
tostringRequired- Who takes it: a teammate's or any work email. Up to 254 characters.
TeamHeard
What the routed emails sent this address over the last reach.days days.
buyersintegerRequired- Buyers who asked for the team that a routed email named them for.
last"sent" | "delivered" | "opened" | "bounced" | "failed" | null- How the latest went: SES's latest word on it, else whether it was sent.
last_atstring | null- When the latest went out, ISO 8601.
whystring- In words, when the latest didn't arrive.
TeamInvitation
An invitation not accepted yet. Its link was shown once, when it was made.
bystringRequired- Who sent it: their email.
by_namestringRequiredemailstringRequiredexpiredbooleanRequiredexpires_atstringRequiredheardTeamHeard | null- What reached them lately; none: no routed email named them.
placesTeamPlace[]- The Handoff rules that name them, in order; none: they get no buyers. Default
[]. recentTeamSent[]- The last few buyers sent to them, newest first. Default
[]. role"owner" | "member" | "solacia"Requiredsent_atstringRequired
TeamInviteIn
emailstringRequired- The person's work email. Up to 254 characters.
role"owner" | "member" | "solacia"solaciaonly for Solacia's own people. Default"member".
TeamInvited
The invitation made, and its link: shown this once. sent says whether the email went; when it didn't, detail says why and the link is for the caller to send.
detailstringRequiredemailstringRequiredlinkstringRequiredsentbooleanRequiredteamTeamRequired
TeamMember
added_atstringRequired- When they first joined, ISO 8601.
emailstringRequiredheardTeamHeard | null- What reached them lately; none: no routed email named them.
namestringRequiredpicturestring- Their picture as a data: URL, or empty.
placesTeamPlace[]- The Handoff rules that name them, in order; none: they get no buyers. Default
[]. recentTeamSent[]- The last few buyers sent to them, newest first. Default
[]. role"owner" | "member" | "solacia"Requiredtwo_stepboolean- They sign in with a code from an authenticator app too. Default
false. youbooleanRequired- The caller is this person.
TeamPlace
One Handoff rule that names this address.
labelstringRequired- The buyers the rule takes, in words: "Hot buyers", "Everyone else".
numberintegerRequired- The rule's place in the list, from 1.
othersTeamShare[]- Everyone else the rule names, in its order;
owneris the buyer's owner in the CRM. Default[]. routestringRequired- The rule's id, as GET /v1/routing names it.
share"all" | "turns"Required- Everyone on the rule hears, or one of them by turns.
turnsinteger | null- Their percentage of the turns, when the rule takes turns.
TeamReach
Where a buyer who asks for the team goes, in one line.
channelstring | null- The team's channel for every request: Slack's label, or a webhook.
crmstring | null- The CRM whose owner of the buyer hears too, when a rule tells them.
daysintegerRequired- The days
heardcounts over. emailsintegerRequired- Addresses the Handoff rules name, people or not.
TeamRecipient
An address a Handoff rule names that doesn't sign in to the console: an alias, or a teammate never invited. They get each buyer's brief by email.
TeamRequest
bookedobject | nullRequired- The meeting made in the vendor's scheduler.
requestedbooleanRequiredslotstring | nullRequired- The time they picked, ISO 8601 with offset.
TeamRoleIn
role"owner" | "member" | "solacia"Required
TeamSent
One buyer a routed email named this address for.
asked_atstringRequired- When they asked for the team, ISO 8601.
bookedbooleanRequired- They picked a time, rather than asking without one.
companystring | null- The buyer's company, from their email's domain.
emailstring | null- The buyer's email.
last"sent" | "delivered" | "opened" | "bounced" | "failed"Required- How this address's email about them went.
sessionstringRequired- The buyer's demo, as GET /v1/demos/{id} reads it.
whystring- In words, when it didn't arrive.
TeamShare
emailstringRequiredturnsinteger | null
TestArm
agentstringRequiredbestnumberRequired- The chance this side is the best of them (0 to 1)
buyersintegerRequired- Buyers put on this side who opened a demo; each counts once
costinteger | nullRequired- US cents a demo. Solacia's people only; null for everyone else
demosintegerRequiredkeystringRequired- A (what ran before), B, C
lossnumberRequired- Meeting rate lost on average by keeping this side, if another is better (0.004 = 0.4 points)
meetingsintegerRequired- Buyers who asked for a meeting
namestringRequiredratenumberRequired- meetings / buyers
renderer"voice" | "face"RequiredshareintegerRequired- Percent of buyers sent to this side
versioninteger | null- In a test between an agent's versions: this side's; null for its draft
TestArmIn
agentstringRequired- An agent's id, or "none": on the website no demo button, the vendor's usual Get a demo; in outreach the same email without the demo link Up to 80 characters.
shareintegerRequired- Percent of buyers 0 to 100.
TestGuardrail
One guardrail across a test's two sides, as a scorecard row: side A, side B, B minus A and its interval, read as the goal's is (valid however often it is read).
anumberRequireda_countinteger | null- Buyers who did it on side A; null for an average
bnumberRequiredb_countinteger | nullbetter"up" | "down"Required- Which way is better
gapnumberRequired- b minus a: points of share, or minutes
highnumber | nullRequiredid"meetings" | "minutes" | "left_early"Required- meetings: share who asked to meet the team; minutes: average minutes in the demo; left_early: share who left in the first minute
lownumber | nullRequired- Null until both sides have buyers
TestGuards
buyersintegerRequiredleft_earlynumberRequired- Share who left in the first minute
meetingsnumberRequired- Share who asked to meet the team
minutesnumberRequired- Average minutes in the demo
TestLook
The test as it stood at the end of one of its weeks.
atstringRequired- When that week ended
betternumberRequired- The chance it is better by over a point
buyersinteger[]Required- On each side, A first
gapnumberRequired- The best challenger's rate minus A's
highnumberRequiredlownumberRequiredratesnumber[]Requiredsafestring | null- Under unless_worse: the side that could go live at this week's end
samenumberRequired- The chance it is within a point either way
weekintegerRequired- 1: its first seven days
worsenumberRequired- The chance that challenger is worse than A, by over a point
TestPlanGap
gapnumberRequired- The challenger's true rate minus the live version's (0.07 = 7 points)
provenTestPlanRunRequiredunless_worseTestPlanRunRequired
TestPlanRun
by_weeknumber[]- Share of simulated tests gone live by the end of each week, from week 1
livenumberRequired- Share of simulated tests where the challenger went live in time
weeksinteger | nullRequired- Median week it went live; null when under half did
TestSide
One side of a test between an agent's versions, as its buyers went through it.
guardsTestGuardsRequiredkeystringRequiredpathsFlowWay[]Required- How many buyers went each way, as Home's flow reads demos; every way listed, zeros included
ThemeColours
The demo's colours, each #rrggbb: the call around the product and the popup's loading screen, never the product's own screens.
accentstringRequired- Links, the active item, focus rings
accent_deepstringRequired- The accent under the pointer, and on a tint
accent_softstringRequired- Tints behind highlighted things
backgroundstringRequired- Behind everything
buttonstringRequired- The main button, with white words on it
linestringRequired- Borders and dividers
mutedstringRequired- Secondary words: hints, labels, times
surfacestringRequired- Cards and panels
textstringRequired- The words
ThemeIn
New colours for the demo. One left out keeps the product's own. White words on the button and the accent, and the text on the background and panels, need 4.5:1 contrast.
accentstring | null- Links, the active item, focus rings
accent_deepstring | null- The accent under the pointer, and on a tint
accent_softstring | null- Tints behind highlighted things
backgroundstring | null- Behind everything
buttonstring | null- The main button, with white words on it
linestring | null- Borders and dividers
mutedstring | null- Secondary words: hints, labels, times
surfacestring | null- Cards and panels
textstring | null- The words
ThemeSiteIn
A website to take the demo's colours from.
urlstringRequired- Up to 300 characters.
ThemeSuggestion
Colours for the demo, read from a website: nothing is saved until they are chosen with PUT /demo/theme.
coloursThemeColoursRequiredfoundbooleanRequired- Whether the site showed a colour of its own
notesstring[]Required- What was found on the site, and what was changed to keep it readable
renderedbooleanRequired- Read as a visitor sees the page, rather than from its code
ToneOut
namestringRequiredsaysstringRequired- What the guide is told, word for word
Transcriptsolacia.transcript.v1
schemastring- Default
"solacia.transcript.v1". idstringRequiredlinesLine[]Required
TryLinkIn
Marks a link already made as a try link, or as one sent to a buyer again (Solacia's team only). The link and its demos stay as they are; only what its demos tell from now on follows the mark.
emailstringRequired- The email the link was made for, as the list of links gives it. Up to 254 characters.
try_outboolean- True: a try link, whose demos never post to Slack or reach your CRM. False: a link sent to a buyer. Default
true.
TryLinkMarked
emailstringRequiredtry_outbooleanRequired
TwoStepCodeIn
codestringRequired- A code from the app, or a backup code. Up to 40 characters.
TwoStepCodes
Backup codes, shown this once: each signs in once when the phone is lost.
backup_codesstring[]RequiredstateTwoStepStateRequired
TwoStepSetup
A new secret for the authenticator app: scan qr (an SVG data: URI) or type secret. Two-step sign-in turns on with the app's first code (POST /me/two-step/confirm).
qrstringRequired- The QR code, as an SVG data: URI an img can show.
secretstringRequireduristringRequired- The otpauth:// link the QR code holds.
TwoStepState
The caller's two-step sign-in. In preview.
availablebooleanRequired- The caller can turn it on here.
backup_codes_leftintegerRequiredonbooleanRequired- Sign-in asks for a code from their authenticator app after the password.
sincestringRequired- When it was turned on, ISO 8601; empty when off.
VersionSideIn
shareintegerRequired- Percent of the agent's buyers 10 to 90.
versioninteger | "draft"Required- A version number (side A: the live one), or draft: the draft as it is now
VoicePool
productstringRequired- The voice calls speak this language with when the agent picks none
voicesPoolVoice[]Required- The voices to pick from, the product's own first
VoiceSample
audiostringRequired- The line said, base64
linestringRequired- What the voice says: the start of the account's opening in that language
typestringRequired- The audio's media type
VoiceSampleIn
A voice to hear before it is picked.
agentstring | null- Say this agent's own opening, when it has one
languagestringRequired- Up to 8 characters.
voicestringRequired- An id from the agents' voice_pool Up to 100 characters.
ZendeskAudience
Who some of the help center's articles are for: a user segment, or everyone.
articlesintegerRequirednamestringRequired- The segment's name in Zendesk; empty for everyone, or when Zendesk won't list segments.
refstringRequired
ZendeskAudiences
audiencesZendeskAudience[]Requiredpickedstring[]- The refs picked.
ZendeskKeyIn
A Zendesk account and an API token its admin made, with the email it signs in as.
addressstringRequired- Up to 300 characters.
emailstringRequired- Someone who can see the articles. Up to 320 characters.
tokenstringRequired- The API token, as Zendesk showed it. Up to 500 characters.
ZendeskSignInIn
The Zendesk account to sign in to: its address, where the owner approves Solacia.
addressstringRequired- Up to 300 characters.
MCP tools
The same operations for an AI assistant, as MCP tools: each tool is one endpoint above, with the same scope, budget and output. Add https://app.solacia.ai/mcp to Claude, ChatGPT or any MCP client and sign in with your console account, or send an API key. In Claude Code:
claude mcp add --transport http solacia https://app.solacia.ai/mcp --header "Authorization: Bearer $SOLACIA_API_KEY"get_buyercalls GET /v1/leads/{id}
One buyer's full record by the id find_buyers gives: who they are, priority and why, what they saw and asked with the answers, concerns, meeting request and the drafted follow-up. include=transcript adds the conversation; include=calls adds the voice calls; include=deals adds their deals in the CRM, won, lost or open. The caller's account only; test demos are left out unless asked for.
idstringRequiredincludestring- Comma-separated: transcript, calls, deals. Up to 40 characters.
find_buyerscalls GET /v1/buyers
The buyers who took a demo in the last days days, one short row each: who they are, company, outcome (meeting, qualified, nurture, anonymous), fit, three facts, their main question, how far they went and when. q keeps the buyers whose name, company, role or anything they said holds every word. order=promising puts meetings and qualified buyers first. Pass a row's id to get_buyer for the full record. For the rows after these, pass the answer's next_cursor as cursor. The caller's account only; test demos are left out unless asked for.
cursorstring- The previous page's next_cursor; empty for the first page. Up to 2000 characters.
daysinteger- Demos that began in the last
daysdays, today included. 1 to 365. Default30. language"en" | "es" | "pt"- The language the rows' roles and facts are written in: English, Spanish or Portuguese. Default
"en". limitinteger- At most this many buyers; 0 for all of them. 0 to 500. Default
20. order"newest" | "promising"- newest: by their latest demo. promising: meetings first, then qualified, nurture and no email, each by score. Default
"promising". qstring- Only the buyers whose name, address, company, role, or anything they said or told the demo (calls included) holds every word of it; case and accents don't matter. Up to 120 characters.
testsboolean- Default
false.
edit_follow_upcalls PUT /v1/demos/{id}/follow-up
Replace the follow-up email drafted for a buyer (the id find_buyers gives) with this subject and body, kept as the person's edit. Nothing is sent: the team sends it. Given only a change, read the draft with get_buyer first and keep the rest.
bodystringRequired- Up to 10000 characters.
idstringRequiredsubjectstringRequired- Up to 300 characters.
list_questionscalls GET /v1/questions
Questions buyers asked in demos, newest first, each with the agent's answer and how well it was answered. q keeps questions holding those words; answered=false keeps the ones it could not answer. For those grouped, with how often each was asked, use list_unanswered_questions. The caller's account only; test demos are left out unless asked for.
answeredboolean- true: answered from a source or in the call; false: not.
cursorstring- The previous page's next_cursor; empty for the first page. Up to 2000 characters.
freshboolean- Default
false. limitinteger- 1 to 200. Default
20. qstring- Up to 200 characters.
sincestring- Only demos active at or after this time, ISO 8601 (e.g. 2026-10-01T00:00:00Z). Up to 40 characters.
testsboolean- Default
false.
list_unanswered_questionscalls GET /v1/gaps
Questions the agent could not answer from the vendor's own sources, grouped, most asked first, with how many times and what the agent said instead. status=closed lists the ones the team has answered since; dismissed, the ones it set aside. For the rows after these, pass the answer's next_cursor as cursor.
cursorstring- The previous page's next_cursor; empty for the first page. Up to 2000 characters.
freshboolean- Default
false. language"en" | "es" | "pt"- The language who asked is described in: English, Spanish or Portuguese. Default
"en". limitinteger- At most this many questions; 0 for all of them. 0 to 500. Default
20. status"open" | "closed" | "dismissed" | "all"- Default
"open".
answer_questioncalls POST /v1/gaps/answer
Give the agent the team's answer to a question it could not answer (a key list_unanswered_questions gives); from then on it tells every buyer who asks. Write only what the person said buyers should be told, never an answer you made up, and show it to them first.
answerstringRequired- What buyers should be told, as the team would say it: facts only, no quotes. Up to 2000 characters.
keystringRequired- The gap's key Up to 2000 characters.
dismiss_questioncalls POST /v1/gaps/dismiss
Set aside a question the agent could not answer (a key list_unanswered_questions gives): a wrong flag, a test, or something the team never tells buyers. It leaves the open list and the agent's answers stay as they are; dismissed=false brings it back.
dismissedboolean- false restores it to the open list Default
true. keystringRequired- The gap's key Up to 2000 characters.
reason"unpublished"- unpublished: the vendor deliberately doesn't publish this (a margin, a custom price), so the agent keeps handing it to the team (ADR 0009)
get_numberscalls GET /v1/analytics
The demos' numbers for the last days days against the period before: sessions, calls, minutes, goals reached, conversion, the funnel, and the topics buyers asked about most.
daysinteger- 1 to 365. Default
30. demosboolean- false leaves out each demo's row and the demos behind each question: the numbers alone. Default
false. freshboolean- Default
false. testsboolean- Default
false.
list_integrationscalls GET /v1/integrations
Which tools this account has connected and how: its CRM (HubSpot, Salesforce), scheduler, Slack, email alerts, internal docs, the website embed and API keys, each connected or not, with what and by whom, and the CRM and scheduler buyers go to. Connecting one is done in the console.
language"en" | "es" | "pt"- The language its words are in. Default
"en".
get_website_embedcalls GET /v1/embed
The script tag that puts this account's live demo on its own website, ready to paste into the site's HTML before </body>, with the sites it answers on and whether it is paused. An empty list: Solacia has not made the account's embed yet.
None.
list_agentscalls GET /v1/agents
The account's demo agents: what each says and how (tone, instructions, facts, voices), which channel each runs (the website, outreach links, the demo's own address) and the rules that pick one, its last 30 days, and the A/B tests between them. Pass an agent's id to get_agent for its versions, draft and script.
None.
get_agentcalls GET /v1/agents/{id}
One agent (an id list_agents gives): its live version and unpublished draft, every version with who changed what, the script a buyer meets (opening, parts, buttons), the questions it couldn't answer, where it runs, and the team's notes on its calls.
idstringRequired
change_agentcalls PUT /v1/agents/{id}/draft
Change an agent's draft (an id list_agents gives): how it talks, its instructions, facts, who it's for, its goal and its script. Only the fields given change; buyers keep meeting the live version until publish_agent. Change only what the person asked for in their own words, never what a buyer said in a demo.
audiencestring- Up to 200 characters.
counts"qualified" | "meeting"- What reaching the goal is: the buyer qualifies, or asks to meet the team
factsAgentFact[]- Replaces all its facts
goalstring- Up to 200 characters.
idstringRequiredinstructionsstring- Up to 1000 characters.
scriptAgentScriptIntone"brief" | "warm" | "expert" | "pack"- pack: as the brief says
voicesobject<string, string>- Voice id per language; Solacia only
publish_agentcalls POST /v1/agents/{id}/draft/publish
Make an agent's draft its live version: every demo that starts from now on meets it. Show the person what changed (get_agent) and publish only when they say so.
idstringRequired
test_agentcalls POST /v1/agents/{id}/tests
Split real buyers between an agent's live version (side A) and its draft or other versions, each buyer always on the same side, and read which qualifies more of them. Shares add to 100, at least 10 each.
idstringRequiredlever"message" | "features" | "pricing" | "offer" | "qualification"- What it is to learn (GET /agents/{id}/levers): it is read on that lever's goal
min_buyersinteger- Buyers each side needs before any verdict 20 to 100000. Default
20. questionstring- Up to 200 characters.
rule"unless_worse" | "proven"- unless_worse: a challenger may go live unless it is worse; proven: only once it is proven better Default
"unless_worse". sidesVersionSideIn[]Requiredweeksinteger- How long it takes buyers; left out: until stopped 1 to 26.
rehearse_agentcalls POST /v1/agents/{id}/rehearsals
A link to a demo of an agent's draft (or one of its versions) for the person to run as a buyer would, before publishing. Never counted in results; nothing in it reaches the team or the CRM.
idstringRequiredofinteger | "draft"- A version's number, or the draft as it is now Default
"draft".
stop_agent_testcalls POST /v1/agent-tests/{id}/stop
Stop an A/B test (an id list_agents gives under tests). With keep, that agent, or that side's version, runs the channel from the next demo.
idstringRequiredkeepstring- The agent to run the channel from now on; in a test between an agent's versions, the side (A, B or C) whose version goes live Up to 80 characters.
make_demo_linkscalls POST /v1/demo-links/batch
Make a personal demo link for each prospect: a work email, and their name, company, role and what the rep knows, which the agent reads before the demo. Each link opens the demo without a password and records it under that prospect. Nothing is sent: give the links back to the person. Rows that are not a work email come back refused.
rowsDemoLinkIn[]Required- Up to 500 prospects.
list_crm_listscalls GET /v1/crm/lists
The lists in the account's CRM that demo links can be made for (HubSpot contact lists, Salesforce campaigns), with how many people each holds. Pass a list's id to make_crm_list_links.
qstring- Words in the list's name. Up to 80 characters.
make_crm_list_linkscalls POST /v1/demo-links/from-crm-list
Make a personal demo link for each person on a CRM list (a list_id list_crm_lists gives) and write it onto their CRM record, where the team's own sequence picks it up. Nothing is sent to anyone. One page per call: call again with after set to the answer's next until it is empty.
afterstring- Where this page starts: the last answer's
next. Up to 256 characters. agentstring- The agent they meet; left out: the sender's default. Up to 80 characters.
campaignstring- Up to 80 characters.
daysinteger- How long the links open the demo. 1 to 90. Default
30. list_idstringRequired- Up to 64 characters.
list_demo_linkscalls GET /v1/demo-links
The personal demo links made so far, newest first: who each is for, the link, and what that prospect has done since (demos, how hot, whether they asked for your team), with what each campaign has brought over all its links. For the rows after these, pass the answer's next_cursor as cursor.
campaignstring- Only this campaign's links; an empty value, those without one. Up to 80 characters.
cursorstring- The previous page's next_cursor; empty for the first page. Up to 2000 characters.
limitinteger- At most this many links, newest first; 0 for all of them. 0 to 500. Default
20.