API referenceV1
Skip, edit, restart, stop, submit, undo a screen-out, or resend a verification code
AuthorizationBearer <token>
A server-side secret key. Never send one from a browser — a request carrying an Origin header is refused for this reason.
In: header
Path Parameters
sid*string
Query Parameters
deadlineMs?number
How long to wait for the turn, in milliseconds, before answering 202 with what is done so far. Unparseable values are ignored.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/sessions/string/actions" \ -H "Content-Type: application/json" \ -d '{ "action": "skip" }'{ "accepted": true, "complete": true, "awaitingSubmit": true, "assistantMessages": [ "string" ], "question": { "id": "string", "ref": "string", "type": "string", "title": "string", "required": true, "imageKey": "string", "media": null, "property1": null, "property2": null }, "ending": { "ref": "string", "title": "string", "bodyMd": "string", "kind": "success", "requirements": [ "string" ], "property1": null, "property2": null }, "validation": { "ref": "string", "code": "string", "message": "string" }, "answers": { "property1": null, "property2": null }, "collected": 0, "pendingVerification": { "ref": "string", "channel": "sms", "sentTo": "string", "sentAt": 0 }, "pendingPayment": { "ref": "string", "recordId": "string", "provider": "cashfree", "amountMinor": 0, "amount": 0, "currency": "string", "display": "string", "launch": { "kind": "cashfree_sdk", "orderId": "string", "paymentSessionId": "string", "mode": "sandbox" }, "expiresAt": 0 }, "events": [ { "v": 0, "seq": 0, "ts": 0, "type": "string", "data": null } ], "sinceSeq": 0, "property1": null, "property2": null}