chatformdocs
API referenceV1

Every moment the AI helped a respondent, with counts per kind

GET
/v1/forms/{id}/ai-assists

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

Query Parameters

limit?integer
Range1 <= value <= 100
Default25
cursor?string
since?integer
Range-9007199254740991 <= value <= 9007199254740991
until?integer
Range-9007199254740991 <= value <= 9007199254740991

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/forms/string/ai-assists"
{  "data": [    {      "id": "string",      "kind": "converted",      "createdAt": 0,      "sessionId": "string",      "submissionId": "string",      "submissionStatus": "string",      "blockRef": "string",      "question": "string",      "said": "string",      "result": null,      "detail": {        "method": "gate",        "reason": "string",        "sources": [          {            "sourceId": "string",            "title": "string",            "score": 0          }        ],        "hint": "string",        "from": null,        "finalSaid": "string",        "finalValue": null      }    }  ],  "has_more": true,  "next_cursor": "string",  "counts": {    "converted": 0,    "followed_up": 0,    "answered_from_knowledge": 0,    "answered_question": 0,    "fixed_invalid": 0,    "changed_answer": 0  }}