Skip to content
Bottle

Read an answer in the owner interview

POST
/rounds/learned/interview
curl --request POST \
  --url https://example.com/rounds/learned/interview \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "answer": "example" }'

Splits the owner’s typed answer into statements to check. Sends a model that answer and nothing else, and keeps nothing, unless the caller sends an Idempotency-Key, which keeps the reply for a week. The office app does not.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
answer
required
string
>= 1 characters <= 2000 characters

Example generated

{
  "answer": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

The statements, for the owner to check

Media typeapplication/json
object
statements
required
Array<string>
leftOut
required
Array<object>
object
reason
required
string
Allowed values: sensitive contactDetails
word
required
string | null
read
required
boolean

Example 

{
  "leftOut": [
    {
      "reason": "sensitive"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not the owner in the office app, or on a plan without rounds

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

The words can’t be kept, with the reason

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}