Create a greeting
curl --request POST \
--url https://api.meetdarwin.ai/v1/greetings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "<string>",
"page": "<string>",
"show_to": [
{
"values": []
}
],
"links": [
"<string>"
],
"name": "<string>",
"buttons": [
{
"label": "<string>",
"message": "<string>"
}
],
"agent_note": "<string>",
"outcome": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
text: '<string>',
page: '<string>',
show_to: [{values: []}],
links: ['<string>'],
name: '<string>',
buttons: [{label: '<string>', message: '<string>'}],
agent_note: '<string>',
outcome: '<string>'
})
};
fetch('https://api.meetdarwin.ai/v1/greetings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.meetdarwin.ai/v1/greetings"
payload = {
"text": "<string>",
"page": "<string>",
"show_to": [{ "values": [] }],
"links": ["<string>"],
"name": "<string>",
"buttons": [
{
"label": "<string>",
"message": "<string>"
}
],
"agent_note": "<string>",
"outcome": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "gr_yjh2jw",
"object": "greeting",
"type": "page",
"name": "<string>",
"text": "Comparing plans? Give me a rough count of meetings a month and I'll find your cheapest fit.",
"buttons": [
{
"label": "<string>",
"message": "<string>"
}
],
"agent_note": "<string>",
"outcome": "<string>",
"page": "<string>",
"links": [
"<string>"
],
"show_to": [
{
"field": "<string>",
"op": "<string>",
"values": [
"<string>"
]
}
],
"audience": "Page is any of /pricing",
"stays": "match",
"status": "live",
"testing": "auto",
"position": 0,
"created_by_darwin": true,
"test": {
"id": "<string>",
"name": "<string>",
"status": "<string>",
"unit": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}Greetings
Create a greeting
Requires the agent:write scope.
type page needs page; type audience needs show_to; type link takes links (lk_…). Live at once unless status is draft. Changes the live website.
POST
/
greetings
Create a greeting
curl --request POST \
--url https://api.meetdarwin.ai/v1/greetings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "<string>",
"page": "<string>",
"show_to": [
{
"values": []
}
],
"links": [
"<string>"
],
"name": "<string>",
"buttons": [
{
"label": "<string>",
"message": "<string>"
}
],
"agent_note": "<string>",
"outcome": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
text: '<string>',
page: '<string>',
show_to: [{values: []}],
links: ['<string>'],
name: '<string>',
buttons: [{label: '<string>', message: '<string>'}],
agent_note: '<string>',
outcome: '<string>'
})
};
fetch('https://api.meetdarwin.ai/v1/greetings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.meetdarwin.ai/v1/greetings"
payload = {
"text": "<string>",
"page": "<string>",
"show_to": [{ "values": [] }],
"links": ["<string>"],
"name": "<string>",
"buttons": [
{
"label": "<string>",
"message": "<string>"
}
],
"agent_note": "<string>",
"outcome": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "gr_yjh2jw",
"object": "greeting",
"type": "page",
"name": "<string>",
"text": "Comparing plans? Give me a rough count of meetings a month and I'll find your cheapest fit.",
"buttons": [
{
"label": "<string>",
"message": "<string>"
}
],
"agent_note": "<string>",
"outcome": "<string>",
"page": "<string>",
"links": [
"<string>"
],
"show_to": [
{
"field": "<string>",
"op": "<string>",
"values": [
"<string>"
]
}
],
"audience": "Page is any of /pricing",
"stays": "match",
"status": "live",
"testing": "auto",
"position": 0,
"created_by_darwin": true,
"test": {
"id": "<string>",
"name": "<string>",
"status": "<string>",
"unit": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}{
"type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
"title": "<string>",
"status": 0,
"code": "insufficient_scope",
"detail": "<string>",
"request_id": "req_8m2k4p0q1x7z9c3v5b6n",
"param": "<string>",
"required_plan": "growth",
"feature": "fit_rules",
"upgrade_url": "<string>"
}Authorizations
A secret key (dk_live_…). Scopes: conversations:read, contacts:read, contacts:write, meetings:read, analytics:read, events:read, webhooks:write, knowledge:read, knowledge:write, agent:read, agent:write, experiments:read, experiments:write, privacy:write, chat:write.
Headers
Retry safely: the first response is replayed for 24 hours (not for streamed answers).
Maximum string length:
255Body
application/json
page: one page; audience: visitors who match show_to; link: people who open its personal links.
Available options:
page, audience, link What the chat says first. Openings shown beside the launcher read best under 120 characters. Link greetings may use {first|there}, {company|your team}, {title}, {last}.
Required string length:
1 - 300For type page: the page, such as /pricing, or its address.
Required string length:
1 - 500For type audience: filters, all of which must match (a filter's values are any of).
Maximum array length:
12Show child attributes
Show child attributes
For type link: personal links (lk_…) that open with it.
Maximum array length:
200Pattern:
^lk_[a-z0-9]{4,16}$What your team calls it. Defaults to the page or type.
Required string length:
1 - 80Up to four reply buttons. Their label is what the visitor taps; message is what it sends (the label when left out).
Maximum array length:
4Show child attributes
Show child attributes
What the agent should know about people who see it. Null removes it.
Maximum string length:
500What it steers toward: "meeting" or an outcome form id (out_…). Null keeps the chat's usual.
How long it stays once it matched: match (only matching pages), visit (this visit), return (every visit for 90 days).
Available options:
match, visit, return live greets visitors; draft and paused don't.
Available options:
live, draft, paused auto: Darwin may test new openings on it (one-page greetings and the default); off: it keeps these words.
Available options:
auto, off Response
OK
Pattern:
^gr_Example:
"gr_yjh2jw"
Allowed value:
"greeting"page: one page. audience: visitors who match show_to. link: people who open its personal links. default: everyone else (the catch-all), one per workspace.
Available options:
page, audience, link, default What the chat says first.
Example:
"Comparing plans? Give me a rough count of meetings a month and I'll find your cheapest fit."
Reply buttons. Your locked buttons (Agent Studio) are added when it is shown.
Show child attributes
Show child attributes
What the agent is told about people shown this greeting.
What it steers toward: "meeting" or an outcome form (out_…). Null: the chat's usual.
For type page: the page it shows on.
For type link: the personal links (lk_…) that open with it.
For type audience: the filters a visit must all match.
Show child attributes
Show child attributes
Who sees it, in words.
Example:
"Page is any of /pricing"
match: only on pages it matches. visit: the rest of the visit. return: every visit for 90 days.
Available options:
match, visit, return Available options:
live, draft, paused, archived auto: Darwin may test new openings on it (one-page greetings and the default). off: it keeps these words.
Available options:
auto, off Order among greetings of the same kind, lowest first.
Required range:
-9007199254740991 <= x <= 9007199254740991The test running on it now (exp_…); read it with GET /experiments/{id}.
Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$