Make a personal link
A link for one person to a call with a character, on a page of ours.
secretKeyAuthorizationBearer <sk_live_… or sk_test_… (a prefix and 40 base62 characters)>A secret key from the dashboard, sent as Authorization: Bearer sk_live_…. Live keys run real, charged calls; test keys (sk_test_…) run calls of at most 60 seconds, 20 a day per organization, never charged. Each key sees only its own env's calls, meetings, webhooks, memories and analytics. Publishable keys (pk_…) are refused.
Idempotency-Key?stringAny string of 1 to 200 bytes (surrounding spaces are trimmed), unique per call you mean to start, such as a UUID. The same key gives back the same call. While the first request with it is still starting: 409 idempotency_in_progress; if it failed: 409 idempotency_failed (send a new key); used for another character: 422 idempotency_mismatch. Only the character is compared: a different max_seconds or metadata with the same key still gives back the first call. Keys are kept with the call, per organization and env: a test key and a live key sending the same value each get their own call (or meeting), never the other's. Use plain ASCII: a value that isn't is ignored, as if no key were sent.
1 <= length <= 200application/json- body
character_id*CharacterIdA character's id.
^chr_[0-9A-Za-z]{20}$"chr_4fT9kQ2mXw7LbN3pZs8V"name?|The person's name: the greeting and {{caller_name}}.
length <= 120email?|emailexternal_id?|Your own id for the person.
length <= 200context?|Plain text the character should know about this call (the candidate, the order, the account). It reaches the prompt before the greeting; the person never sees it.
length <= 4000"Candidate Sara Ahmadi""applying for data engineer. Five years of Spark."variables?|Values for {{name}} in the character's instructions and greeting. Names are letters, digits and _ (not starting with a digit), up to 40; at most 30, each value up to 500 characters, 4,000 together. A number or true/false is taken as its text. An unknown {{name}} becomes nothing (a space before punctuation goes with it). {{caller_name}} is built in.
{ "role": "data engineer", "first_name": "Sara"}language?|The call's language; the person can't change it.
expires_at?||Unix seconds or an RFC 3339 time, in the future and within a year. Left out is never.
max_uses?integerAttempts.
1 <= value <= 1001resume_minutes?integerHow long a dropped call can come back without using an attempt.
0 <= value <= 144060memory_key?|nullmetadata?|Any JSON object of at most 4 KB; on the link and its calls.
The link.
application/json- response
id*string"lnk_8Hq2Lm5VtR9xPc3NwZ7k"url*|The person's address.
uricharacter_id*CharacterIdA character's id.
^chr_[0-9A-Za-z]{20}$"chr_4fT9kQ2mXw7LbN3pZs8V"env*string"live""test"status*LinkStatus"unused""started""completed""expired""revoked"name?stringemail?stringexternal_id?stringcontext?stringvariables?language?string|nullmemory_key?string|nullmetadata?max_uses*integeruses*integerAttempts begun.
resume_minutes*integerresume_until_unix?|Until when a dropped call can come back.
expires_unix?integer|nullopened_unix?integer|nullconsented_unix?|When the notice was last accepted.
completed_unix?integer|nullrevoked_unix?integer|nullcreated_unix*integerlast_call_id?string|nullin_call?booleancalls?array<>getLink only: its calls, oldest first.
curl -X POST 'https://api.daxov.com/v1/links' \ -H 'Idempotency-Key: 5f0c7a52-3d1e-4b8a-9f61-2c4d8e7b9a10' \ -H 'Content-Type: application/json' \ -d '{ "character_id": "chr_4fT9kQ2mXw7LbN3pZs8V"}'{ "id": "lnk_8Hq2Lm5VtR9xPc3NwZ7k", "url": "http://example.com", "character_id": "chr_4fT9kQ2mXw7LbN3pZs8V", "env": "live", "status": "unused", "name": "string", "email": "string", "external_id": "string", "context": "string", "variables": { "property1": "string", "property2": "string" }, "language": "string", "memory_key": "string", "metadata": {}, "max_uses": 0, "uses": 0, "resume_minutes": 0, "resume_until_unix": 0, "expires_unix": 0, "opened_unix": 0, "consented_unix": 0, "completed_unix": 0, "revoked_unix": 0, "created_unix": 0, "last_call_id": "string", "in_call": true, "calls": [ { "id": "call_2Gx7Mb9KpQ4sVn1ZrT6e", "resumed": true, "end_reason": "string", "settled_unix": 0, "created_unix": 0 } ]}