Mint a short-lived, read-only token for some of the project's widgets
vg_session<token>The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.
orgId*stringAuthorised orgId; the server must verify organisation/project ownership before any read.
1 <= lengthprojectId*stringAuthorised projectId; the server must verify organisation/project ownership before any read.
1 <= lengthapplication/json- body
widgets*array<>The widgets the token opens. A recent-calls frame whose rows open a call needs both recent-calls and call.
1 <= itemsorigin*stringThe one site that may frame the widgets, one of the project's allowedOrigins.
expiresInSeconds?integerHow long the token is valid.
60 <= value <= 864003600transcriptsAndAudio?booleanShare what was said with the framing site: the one-call view's turn text, span attributes (prompts, transcripts, tool arguments), the SDK call fields and recording audio. Off by default, when the call widget shows timings only and listCalls refuses the field filter. Needs the call widget, and an Admin or a project key.
falseThe token, shown in this answer only.
application/json- response
token*stringvge_ followed by a signed JWT. Put it in the frame's address as ?token=. Shown once; VoiceGateway does not store it.
expiresAt*stringWhen the token stops working.
date-timewidgets*array<>The widgets the token opens.
origin*stringThe origin the token may be framed by, normalised.
transcriptsAndAudio*booleanWhether the token shares turn text, span attributes and recording audio.
curl -X POST 'https://example.com/api/v1/org/string/project/string/embed-tokens' \ -H 'Content-Type: application/json' \ -d '{ "widgets": [ "answer-time" ], "origin": "string"}'{ "token": "string", "expiresAt": "2019-08-24T14:15:22Z", "widgets": [ "answer-time" ], "origin": "string", "transcriptsAndAudio": true}Was this page helpful?