Skip to main content
POST
/
v1
/
interviews
Submit interview data
curl --request POST \
  --url https://api.vistaly.com/v1/interviews \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": "<string>",
  "cardIds": [
    "<string>"
  ],
  "feedbackProviders": [
    {
      "email": "jsmith@example.com",
      "firstName": "<string>",
      "lastName": "<string>"
    }
  ],
  "feedbackReceivers": [
    {
      "email": "jsmith@example.com"
    }
  ],
  "parseMarkdown": true,
  "timestamp": "2023-11-07T05:31:56Z",
  "url": "https://vistaly.com"
}
'
{
  "message": "Interview created"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vistaly.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
body
string

The interview's notepad

​
cardIds
string[]

An array of card IDs to associate with this interview's notepad

​
feedbackProviders
object[]

An array of individuals who provided the interview, each with their first name (optional), last name (optional), and email

​
feedbackReceivers
object[]

An array of individuals who conducted the interview. If the individual isn't a member of your Vistaly organization, their value will be ignored.

​
parseMarkdown
boolean

Whether to parse the body content as markdown and convert to structured format (defaults to false)

​
timestamp
string<date-time>

The timestamp of when the interview was captured (defaults to current timestamp if not provided)

​
url
string<uri>

The url where the interview came from

Example:

"https://vistaly.com"

Response

Interview data submitted successfully

​
message
string
Example:

"System provided message"