notes voice status

GET

/api/v1/notes/voice/status

const url = 'https://example.com/api/v1/notes/voice/status';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/notes/voice/status \
  --header 'Authorization: Bearer <token>'

Route: /api/v1/notes/voice/status. Inputs: . Do not automatically replay this operation after an uncertain result.

Authorizations

installationBearer
browserSession

Responses

200

application/json

object

backfill_paused

required

boolean

download_completed_bytes

required

integer format: int64

download_pending

required

boolean

download_total_bytes

required

integer format: int64

models_ready

required

boolean

preferences

required

A User’s local Voice defaults.

object

context

string

default: general

Allowed values: general email

download_enabled

boolean

default: true

structure

string

default: prose

Allowed values: prose lists

style

string

default: semi-formal

Allowed values: casual semi-casual semi-formal formal

Example

{
  "preferences": {
    "context": "general",
    "download_enabled": true,
    "structure": "prose",
    "style": "casual"
  }
}