chatformdocs
API referenceV1

Open a conversation on a published form

POST
/v1/forms/{id}/sessions

Authorization

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

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Default{}

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/forms/string/sessions" \  -H "Content-Type: application/json" \  -d '{}'
{  "sessionId": "string",  "respondentToken": "string",  "expiresAt": 0,  "streamUrl": "string",  "greeting": "string",  "question": {    "id": "string",    "ref": "string",    "type": "string",    "title": "string",    "required": true,    "imageKey": "string",    "media": null,    "property1": null,    "property2": null  }}