Skip to main content
POST
/
conversations
Start a conversation
curl --request POST \
  --url https://api.findly.ai/v1/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "How much stock did we sell last week?",
  "propertyId": "<string>",
  "workspaceName": "my-workspace"
}
'
{
  "conversationId": "xxx-yyy-zzz",
  "publicUrl": "https://dashboard/findly.ai"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
question
string
required

The question you want Findly to answer

Example:

"How much stock did we sell last week?"

​
propertyId
string
required

Which data source to query, by property ID

​
workspaceName
string

Optionally specify workspace name, otherwise default will be used

Example:

"my-workspace"

Response

200 - application/json

Success

​
conversationId
string
Example:

"xxx-yyy-zzz"

​
publicUrl
string<url>
Example:

"https://dashboard/findly.ai"