API Reference

Create intent

post
https://api.sandbox.buoyhealth.com/symptom-checker/v2/intents/

Creates a new intent.

Intents gathered at the start of an interview (or after entering complaints) should be submitted with the "INTERVIEW_START" event. Intents gathered at the end of an interview should be submitted with the "INTERVIEW_RESULT" event. An empty string ("") should always be submitted in the detail parameter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

A UUID-formatted token uniquely identifying an interview instance.

string
enum
required

A string indicating whether an intent was captured at the start of an interview ("INTERVIEW_START") or after results have been shown ("INTERVIEW_RESULT").

Allowed:
string
enum
required

A string clarifying the type of care a user intends to seek.

Responses

Updated about 5 years ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 years ago

Did this page help you?