suggested-questions

Api Get Suggested Questions

Get suggested questions by filter parameters. If multiple parameters are provided, the most specific one will be used (ID > Node ID > URL).

get/v1/suggested-questions/{application_id}

Request

  • Base URL: https://api.branchly.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.branchly.io/v1/suggested-questions/{application_id}
  • Auth: HTTP bearer

Path parameters

application_idstring uuid required

Query parameters

urlstring uri nullable

The URL of the content to get suggested questions for.

idstring uuid nullable

The ID of the suggested questions to retrieve.

node_idstring uuid nullable

The ID of the node to get suggested questions for.

localestring nullable

The locale of the suggested questions to retrieve.

Response

Successful Response

questionsstring[] required

List of suggested questions users might ask the chatbot

content_hashesstring[]

Hashes of the content used to generate the suggested questions

vertex_idsstring[]

IDs of the vertices used to generate the suggested questions

idstring uuid required
application_idstring uuid required

The ID of the application

urlstring uri required

The URL associated with the node

localestring nullable

The locale of the suggested questions

session_idstring uuid nullable

The session ID if these questions are personalized for a specific session

timestampstring date-time required

When the suggested questions were generated

Changes

No recorded changes to this operation across all 1 revision of this API.