WebSocket API for use by mobile clients
Production Monolith Server
Development Monolith Server
Channel for user state communication
Available only on servers:
Accepts the following message:
Identify the device
Metadata about the identity of the device
Opaque stable identifier for the device. Typically randomly generated and stored on the device, or provided by the operating system.
Additional properties are allowed.
Additional properties are allowed.
{
"kind": "ident",
"data": {
"deviceId": "BjOMoUPZiCEYkzDXX2Ep89HyI1",
"clientName": "Wysp iOS",
"clientVersion": "1.2.16"
}
}
Channel for user state communication
Available only on servers:
Accepts the following message:
Report the current status of the device
Metadata about the current state of a client device
Device battery level in % (0-100)
Whether or not the device is currently in a "navigating" mode.
Additional properties are allowed.
Additional properties are allowed.
{
"kind": "device.status",
"data": {
"batteryLevel": 89,
"isNavigating": true
}
}
Channel for user state communication
Available only on servers:
Accepts the following message:
Append fixes
List of fixes to submit
Positional fix from GPS
Latitude in degrees
Longitude in degrees
Estimated direction the user is facing. North at 0 degress, clockwise to 360.
Course over ground in degrees. North at 0 degress, clockwise to 360.
Velocity in meters per second
Meters above sea level
Accuracy of location in meters
Accuracy of altitude in meters
Additional properties are allowed.
Additional properties are allowed.
{
"kind": "fixes.append",
"data": [
{
"lat": 59.92875,
"lng": 10.77887,
"fixedAt": "2019-08-24T14:15:22Z",
"heading": 26,
"course": 27,
"velocity": 2.4,
"altitude": 141,
"locationAccuracy": 3,
"altitudeAccuracy": 20
}
]
}
Channel for user state communication
Available only on servers:
Accepts the following message:
Set user context
Updates to the user's context.
Unstructured text that is likely to contain useful information for the user. In general, this is a place to dump content that couldn't be adequately mapped to other fields. Behind the scenes, we mine this text for relevant delivery details, as well as use it for general LLM context. This is a good place for transcripts of previous conversations the customer has had with delivery users.
Definition of an action that the user can perform using their voice. These actions typically correlate to primary buttons that are active in the screen UI.
Name of the action. Typically this name would match an enum of action names that your application is ready to handle.
Description of the action's outcome
Arguments (if any) required to fulfill the action
Display name of the argument
Describe the arguments contents
Additional properties are allowed.
Additional properties are allowed.
List of currently active objectives for the user.
A transfer objective models the pickup/dropoff of physical goods, or intangibles such as information and services.
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Whether the transfer is incoming to the user, or outgoing from the user
Description of any requirements or limits on the transfer that the user should be reminded of - such as ID verification or signature gathering.
Whether or not the transferrables are ready for transfer
Time at which the transferrables are expected to be ready
Weight in kilograms
Width in centimeters
Depth in centimeters
Height in centimeters
Arbitrary kind of object (box, document, paper bag etc)
Visual description of package that differentiates it from others that may be in the user's posession
Description of package contents
Special instructions for handling that wouldn't be otherwise marked or obvious
Additional properties are allowed.
List of intangible items (such as verbal information or services) to be included in the transfer
Description of the item to be transferred
Additional properties are allowed.
Target transfer at a role or class of persons
Description of the role
Additional properties are allowed.
Target transfer at an individual person
Individual person's name
Individual person's phone number
Additional properties are allowed.
Target transfer at a physical location such as a dropbox, mail slot, or hiding place
Description of the role
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A presence objective models the task of arriving to a specific place
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Street address of the destination
Primary coordinates of the destination
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Recognizable name of the destination
Detailed arrival metadata for destinations
Coordinates of vehicle parking
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Coordinates of center of the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Coordinates of the ideal ingress point to the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Visual description by which the building can be differentiated from the surrounding buildings
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Number of floor on which unit entry is located
The natural identifier of the unit, such as an apartment or room number.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Travel mode influences routing, statement timing, verbosity, and other characteristics.
Additional properties are allowed.
Additional properties are allowed.
{
"kind": "state.context.set",
"data": {
"brief": null,
"actions": [
{
"name": "EXTEND_SHIFT",
"description": "Extend the user's shift by a certain number of hours",
"arguments": [
{
"name": "hours",
"kind": "number",
"description": "Number of hours to add to the shift duration"
}
]
},
{
"name": "ACCEPT_ORDER",
"description": "Accept the currently offered order"
}
],
"objectives": [
{
"kind": "TRANSFER",
"expectedTime": "2019-08-24T14:15:22Z",
"expectedDuration": 660,
"direction": "INCOMING",
"requirements": "string",
"isReady": true,
"estimatedReadyAt": "2019-08-24T14:15:22Z",
"objects": [
{
"weight": 0,
"width": 0,
"depth": 0,
"height": 0,
"kind": "PAPER_BAG",
"visualDescription": "string",
"contentDescription": "string",
"handlingInstructions": "Keep warm"
}
],
"intangibles": [],
"target": {
"description": "Front of house staff"
}
}
],
"travelMode": "BICYCLE:ELECTRIC"
}
}
Channel for user state communication
Available only on servers:
Accepts the following message:
On socket connection, server sends the entire state object. The client should hold this in memory, merging in deltas over time as they arrive in state.delta messages
Description of the user's situation, including their current objectives and actions.
Unstructured text that is likely to contain useful information for the user. In general, this is a place to dump content that couldn't be adequately mapped to other fields. Behind the scenes, we mine this text for relevant delivery details, as well as use it for general LLM context. This is a good place for transcripts of previous conversations the customer has had with delivery users.
Definition of an action that the user can perform using their voice. These actions typically correlate to primary buttons that are active in the screen UI.
Name of the action. Typically this name would match an enum of action names that your application is ready to handle.
Description of the action's outcome
Arguments (if any) required to fulfill the action
Display name of the argument
Describe the arguments contents
Additional properties are allowed.
Additional properties are allowed.
List of currently active objectives for the user.
A transfer objective models the pickup/dropoff of physical goods, or intangibles such as information and services.
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Whether the transfer is incoming to the user, or outgoing from the user
Description of any requirements or limits on the transfer that the user should be reminded of - such as ID verification or signature gathering.
Whether or not the transferrables are ready for transfer
Time at which the transferrables are expected to be ready
Weight in kilograms
Width in centimeters
Depth in centimeters
Height in centimeters
Arbitrary kind of object (box, document, paper bag etc)
Visual description of package that differentiates it from others that may be in the user's posession
Description of package contents
Special instructions for handling that wouldn't be otherwise marked or obvious
Additional properties are allowed.
List of intangible items (such as verbal information or services) to be included in the transfer
Description of the item to be transferred
Additional properties are allowed.
Target transfer at a role or class of persons
Description of the role
Additional properties are allowed.
Target transfer at an individual person
Individual person's name
Individual person's phone number
Additional properties are allowed.
Target transfer at a physical location such as a dropbox, mail slot, or hiding place
Description of the role
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A presence objective models the task of arriving to a specific place
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Street address of the destination
Primary coordinates of the destination
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Recognizable name of the destination
Detailed arrival metadata for destinations
Coordinates of vehicle parking
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Coordinates of center of the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Coordinates of the ideal ingress point to the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Visual description by which the building can be differentiated from the surrounding buildings
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Number of floor on which unit entry is located
The natural identifier of the unit, such as an apartment or room number.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Travel mode influences routing, statement timing, verbosity, and other characteristics.
Additional properties are allowed.
GeoJSON describing the user's current position and planned routes.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
List of upcoming statements for a user
Statement to be made to the user, including all metadata needed to communicate it to them correctly
Plain text of the statement's content
ISO 639-1 language code and ISO 3166-1 country code joined by a "_"
ID of cloud-rendered audio clip
Statement trigger targeting a specific location
Additional properties are allowed.
Additional properties are allowed.
List of available HUD items for a user
Item to be displayed on the HUD within a specific geographic location
Text instruction to the user
Enumerated standard natures, to be used as keys for selecting standard graphics/icons
GeoJSON LineString or Polygon representing the area within which this HUD display should be active.
If geometry is a LineString, HUD item should be active while user is near the line AND has a similar bearing to the line.
If geometry is a Polygon, HUD item should be active while user is within the polygon.
Additional properties are allowed.
Lat/lng location of the subject of the item (typically the manoeuvre being instructed)
Additional properties are allowed.
Metadata about the current state of the server from the user's perspective
Whether the server is currently working on updates to the user's plan. While true, whatever existing plan may be cached on the client should be treated as invalid/disabled.
Currently applicable error message for display to user regarding a server-side issue. Expected to always be null. When set with a value, it's due to an unsolvable error that is going to keep Wysp from working.
Availability of wysp's various data sources for the user's current location/plan. User should be gently notified of PARTIAL availability, and warned strongly of LOW availability.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"kind": "state.bootstrap",
"data": {
"plan": null,
"context": {
"brief": null,
"actions": [
{
"name": "EXTEND_SHIFT",
"description": "Extend the user's shift by a certain number of hours",
"arguments": [
{
"name": "hours",
"kind": "number",
"description": "Number of hours to add to the shift duration"
}
]
},
{
"name": "ACCEPT_ORDER",
"description": "Accept the currently offered order"
}
],
"objectives": [
{
"kind": "TRANSFER",
"expectedTime": "2019-08-24T14:15:22Z",
"expectedDuration": 660,
"direction": "INCOMING",
"requirements": "string",
"isReady": true,
"estimatedReadyAt": "2019-08-24T14:15:22Z",
"objects": [
{
"weight": 0,
"width": 0,
"depth": 0,
"height": 0,
"kind": "PAPER_BAG",
"visualDescription": "string",
"contentDescription": "string",
"handlingInstructions": "Keep warm"
}
],
"intangibles": [],
"target": {
"description": "Front of house staff"
}
}
],
"travelMode": "BICYCLE:ELECTRIC"
},
"geometry": {
"fix": {},
"triggers": {},
"routeLines": {},
"routePoints": {}
},
"statements": [
{
"id": "string",
"decisionId": "string",
"transcript": "string",
"locale": "en-US",
"clipId": "string",
"trigger": {
"lat": 10,
"lng": 11,
"heading": 0
}
}
],
"hudItems": [
{
"id": "string",
"instruction": "string",
"nature": "MANOEUVRE:TURN:LEFT",
"trigger": "{\n \"coordinates\": [\n [\n 8.310242689008646,\n 47.05429444841852\n ],\n [\n 8.310504651721004,\n 47.05399445514598\n ],\n [\n 8.309440079847974,\n 47.05356534791096\n ],\n ],\n \"type\": \"LineString\"\n}",
"subjectLocation": {
"lat": 0,
"lng": 0
}
}
],
"server": {
"isPlanning": false,
"errorMessage": "Encountered an error while attempting to create travel plan.",
"dataAvailability": "FULL"
}
}
}
Channel for user state communication
Available only on servers:
Accepts the following message:
Changes to the state object since the last `state.bootstrap`
Description of the user's situation, including their current objectives and actions.
Unstructured text that is likely to contain useful information for the user. In general, this is a place to dump content that couldn't be adequately mapped to other fields. Behind the scenes, we mine this text for relevant delivery details, as well as use it for general LLM context. This is a good place for transcripts of previous conversations the customer has had with delivery users.
Definition of an action that the user can perform using their voice. These actions typically correlate to primary buttons that are active in the screen UI.
Name of the action. Typically this name would match an enum of action names that your application is ready to handle.
Description of the action's outcome
Arguments (if any) required to fulfill the action
Display name of the argument
Describe the arguments contents
Additional properties are allowed.
Additional properties are allowed.
List of currently active objectives for the user.
A transfer objective models the pickup/dropoff of physical goods, or intangibles such as information and services.
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Whether the transfer is incoming to the user, or outgoing from the user
Description of any requirements or limits on the transfer that the user should be reminded of - such as ID verification or signature gathering.
Whether or not the transferrables are ready for transfer
Time at which the transferrables are expected to be ready
Weight in kilograms
Width in centimeters
Depth in centimeters
Height in centimeters
Arbitrary kind of object (box, document, paper bag etc)
Visual description of package that differentiates it from others that may be in the user's posession
Description of package contents
Special instructions for handling that wouldn't be otherwise marked or obvious
Additional properties are allowed.
List of intangible items (such as verbal information or services) to be included in the transfer
Description of the item to be transferred
Additional properties are allowed.
Target transfer at a role or class of persons
Description of the role
Additional properties are allowed.
Target transfer at an individual person
Individual person's name
Individual person's phone number
Additional properties are allowed.
Target transfer at a physical location such as a dropbox, mail slot, or hiding place
Description of the role
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A presence objective models the task of arriving to a specific place
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Street address of the destination
Primary coordinates of the destination
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Recognizable name of the destination
Detailed arrival metadata for destinations
Coordinates of vehicle parking
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Coordinates of center of the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Coordinates of the ideal ingress point to the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Visual description by which the building can be differentiated from the surrounding buildings
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Number of floor on which unit entry is located
The natural identifier of the unit, such as an apartment or room number.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Travel mode influences routing, statement timing, verbosity, and other characteristics.
Additional properties are allowed.
GeoJSON describing the user's current position and planned routes.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
List of upcoming statements for a user
Statement to be made to the user, including all metadata needed to communicate it to them correctly
Plain text of the statement's content
ISO 639-1 language code and ISO 3166-1 country code joined by a "_"
ID of cloud-rendered audio clip
Statement trigger targeting a specific location
Additional properties are allowed.
Additional properties are allowed.
List of available HUD items for a user
Item to be displayed on the HUD within a specific geographic location
Text instruction to the user
Enumerated standard natures, to be used as keys for selecting standard graphics/icons
GeoJSON LineString or Polygon representing the area within which this HUD display should be active.
If geometry is a LineString, HUD item should be active while user is near the line AND has a similar bearing to the line.
If geometry is a Polygon, HUD item should be active while user is within the polygon.
Additional properties are allowed.
Lat/lng location of the subject of the item (typically the manoeuvre being instructed)
Additional properties are allowed.
Metadata about the current state of the server from the user's perspective
Whether the server is currently working on updates to the user's plan. While true, whatever existing plan may be cached on the client should be treated as invalid/disabled.
Currently applicable error message for display to user regarding a server-side issue. Expected to always be null. When set with a value, it's due to an unsolvable error that is going to keep Wysp from working.
Availability of wysp's various data sources for the user's current location/plan. User should be gently notified of PARTIAL availability, and warned strongly of LOW availability.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"kind": "state.delta",
"data": {
"plan": null,
"context": {
"brief": null,
"actions": [
{
"name": "EXTEND_SHIFT",
"description": "Extend the user's shift by a certain number of hours",
"arguments": [
{
"name": "hours",
"kind": "number",
"description": "Number of hours to add to the shift duration"
}
]
},
{
"name": "ACCEPT_ORDER",
"description": "Accept the currently offered order"
}
],
"objectives": [
{
"kind": "TRANSFER",
"expectedTime": "2019-08-24T14:15:22Z",
"expectedDuration": 660,
"direction": "INCOMING",
"requirements": "string",
"isReady": true,
"estimatedReadyAt": "2019-08-24T14:15:22Z",
"objects": [
{
"weight": 0,
"width": 0,
"depth": 0,
"height": 0,
"kind": "PAPER_BAG",
"visualDescription": "string",
"contentDescription": "string",
"handlingInstructions": "Keep warm"
}
],
"intangibles": [],
"target": {
"description": "Front of house staff"
}
}
],
"travelMode": "BICYCLE:ELECTRIC"
},
"geometry": {
"fix": {},
"triggers": {},
"routeLines": {},
"routePoints": {}
},
"statements": [
{
"id": "string",
"decisionId": "string",
"transcript": "string",
"locale": "en-US",
"clipId": "string",
"trigger": {
"lat": 10,
"lng": 11,
"heading": 0
}
}
],
"hudItems": [
{
"id": "string",
"instruction": "string",
"nature": "MANOEUVRE:TURN:LEFT",
"trigger": "{\n \"coordinates\": [\n [\n 8.310242689008646,\n 47.05429444841852\n ],\n [\n 8.310504651721004,\n 47.05399445514598\n ],\n [\n 8.309440079847974,\n 47.05356534791096\n ],\n ],\n \"type\": \"LineString\"\n}",
"subjectLocation": {
"lat": 0,
"lng": 0
}
}
],
"server": {
"isPlanning": false,
"errorMessage": "Encountered an error while attempting to create travel plan.",
"dataAvailability": "FULL"
}
}
}
Channel for user state communication
Available only on servers:
Accepts the following message:
Interjection to be played to the user ASAP
Interjection to be made to the user, including all metadata needed to communicate it to them correctly
Plain text of the interjection's content
ISO 639-1 language code and ISO 3166-1 country code joined by a "_"
Duration of audio in seconds
Signed URL of the rendered audio, expires after 10 minutes
Additional properties are allowed.
Additional properties are allowed.
{
"kind": "interjection",
"data": {
"key": "string",
"transcript": "string",
"locale": "en-US",
"duration": 4043,
"url": "https://cdn.wysp.ai/XYZ.mp3"
}
}
Channel for user state communication
Available only on servers:
Accepts the following message:
Control signal
Control signal
Additional properties are allowed.
Additional properties are allowed.
{
"kind": "signal",
"data": {
"signal": "START_NAVIGATION"
}
}
Channel for user state communication
Available only on servers:
Accepts the following message:
Debug data
Additional properties are allowed.
Additional properties are allowed.
{
"kind": "debug",
"data": {}
}
Channel for audio data transmission
Available only on servers:
Accepts one of the following messages:
Start an audio stream
Additional properties are allowed.
{
"kind": "audio.begin"
}
End an audio stream
Additional properties are allowed.
{
"kind": "audio.end"
}
Audio data
Base64-encoded PCM 24000 16bit LE
Additional properties are allowed.
{
"kind": "audio.data",
"data": "string"
}
Channel for audio data transmission
Available only on servers:
Accepts one of the following messages:
Start an audio stream
Additional properties are allowed.
{
"kind": "audio.begin"
}
End an audio stream
Additional properties are allowed.
{
"kind": "audio.end"
}
Audio data
Base64-encoded PCM 24000 16bit LE
Additional properties are allowed.
{
"kind": "audio.data",
"data": "string"
}
Control signal
Additional properties are allowed.
Interjection to be made to the user, including all metadata needed to communicate it to them correctly
Plain text of the interjection's content
ISO 639-1 language code and ISO 3166-1 country code joined by a "_"
Duration of audio in seconds
Signed URL of the rendered audio, expires after 10 minutes
Additional properties are allowed.
Description of the user's navigation plan
Duration of the navigation plan in seconds
Distance to travel in meters
Additional properties are allowed.
Metadata about the identity of the device
Opaque stable identifier for the device. Typically randomly generated and stored on the device, or provided by the operating system.
Additional properties are allowed.
Metadata about the current state of the server from the user's perspective
Whether the server is currently working on updates to the user's plan. While true, whatever existing plan may be cached on the client should be treated as invalid/disabled.
Currently applicable error message for display to user regarding a server-side issue. Expected to always be null. When set with a value, it's due to an unsolvable error that is going to keep Wysp from working.
Availability of wysp's various data sources for the user's current location/plan. User should be gently notified of PARTIAL availability, and warned strongly of LOW availability.
Additional properties are allowed.
Metadata about the current state of a client device
Device battery level in % (0-100)
Whether or not the device is currently in a "navigating" mode.
Additional properties are allowed.
List of available HUD items for a user
Item to be displayed on the HUD within a specific geographic location
Text instruction to the user
Enumerated standard natures, to be used as keys for selecting standard graphics/icons
GeoJSON LineString or Polygon representing the area within which this HUD display should be active.
If geometry is a LineString, HUD item should be active while user is near the line AND has a similar bearing to the line.
If geometry is a Polygon, HUD item should be active while user is within the polygon.
Additional properties are allowed.
Lat/lng location of the subject of the item (typically the manoeuvre being instructed)
Additional properties are allowed.
User
Array of languages spoken by User, in order of descending preference.
The given name (aka first name / forename / short name) of the user.
Additional properties are allowed.
Priority of statement, determining when it will be heard.
IMMEDIATE: Interrupt any on-going statement and speak immediately
ASAP: Wait for any on-going statements to finish, and speak directly after
OPTIMAL: Allow Wysp to select an optimal time within the next 3 minutes, combining the statement with other planned statements to create the best flow.
A URI reference that identifies the problem type.
The HTTP status code generated by the origin server for this occurrence of the problem.
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
An API specific error code aiding the provider team understand the error based on their own potential taxonomy or registry.
An array of error details to accompany a problem details response.
An object to provide explicit details on a problem towards an API consumer.
A granular description on the specific error related to a body property, query parameter, path parameters, and/or header.
A JSON Pointer to a specific request body property that is the source of error.
The name of the query or path parameter that is the source of error.
The name of the header that is the source of error.
A string containing additional provider specific codes to identify the error context.
Additional properties are allowed.
Additional properties are allowed.
Plain text of question
Priority of statement, determining when it will be heard.
IMMEDIATE: Interrupt any on-going statement and speak immediately
ASAP: Wait for any on-going statements to finish, and speak directly after
OPTIMAL: Allow Wysp to select an optimal time within the next 3 minutes, combining the statement with other planned statements to create the best flow.
List of expected answers to which the user's response should be cast if possible.
Additional properties are allowed.
Transcript of the user's response
If castResponse was set in the request, the cast response will be populated if possible. May be null if casting was not possible.
Additional properties are allowed.
Positional fix from GPS
Latitude in degrees
Longitude in degrees
Estimated direction the user is facing. North at 0 degress, clockwise to 360.
Course over ground in degrees. North at 0 degress, clockwise to 360.
Velocity in meters per second
Meters above sea level
Accuracy of location in meters
Accuracy of altitude in meters
Additional properties are allowed.
Metadata about the state of an user, including their device health, reachability, scheduled statements, and latest location.
Network connection to the user is stable
GPS has good accuracy
GPS updates are frequent
Device has low battery
Device has usable audio input
Latest recent fix. Latest fix is only retained for 30 minutes, after which it is nulled out.
Positional fix from GPS
Latitude in degrees
Longitude in degrees
Estimated direction the user is facing. North at 0 degress, clockwise to 360.
Course over ground in degrees. North at 0 degress, clockwise to 360.
Velocity in meters per second
Meters above sea level
Accuracy of location in meters
Accuracy of altitude in meters
Additional properties are allowed.
Timestamp of latest recent location update
Timestamp of last time the user was reached
Additional properties are allowed.
ISO 639-1 language code and ISO 3166-1 country code joined by a "_"
Statement to be made to the user, including all metadata needed to communicate it to them correctly
Plain text of the statement's content
ISO 639-1 language code and ISO 3166-1 country code joined by a "_"
ID of cloud-rendered audio clip
Statement trigger targeting a specific location
Additional properties are allowed.
Additional properties are allowed.
List of upcoming statements for a user
Statement to be made to the user, including all metadata needed to communicate it to them correctly
Plain text of the statement's content
ISO 639-1 language code and ISO 3166-1 country code joined by a "_"
ID of cloud-rendered audio clip
Statement trigger targeting a specific location
Additional properties are allowed.
Additional properties are allowed.
Unstructured text that is likely to contain useful information for the user. In general, this is a place to dump content that couldn't be adequately mapped to other fields. Behind the scenes, we mine this text for relevant delivery details, as well as use it for general LLM context. This is a good place for transcripts of previous conversations the customer has had with delivery users.
Definition of an action that the user can perform using their voice. These actions typically correlate to primary buttons that are active in the screen UI.
Name of the action. Typically this name would match an enum of action names that your application is ready to handle.
Description of the action's outcome
Arguments (if any) required to fulfill the action
Display name of the argument
Describe the arguments contents
Additional properties are allowed.
Additional properties are allowed.
Definition of an action that the user can perform using their voice. These actions typically correlate to primary buttons that are active in the screen UI.
Name of the action. Typically this name would match an enum of action names that your application is ready to handle.
Description of the action's outcome
Arguments (if any) required to fulfill the action
Display name of the argument
Describe the arguments contents
Additional properties are allowed.
Additional properties are allowed.
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
A transfer objective models the pickup/dropoff of physical goods, or intangibles such as information and services.
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Whether the transfer is incoming to the user, or outgoing from the user
Description of any requirements or limits on the transfer that the user should be reminded of - such as ID verification or signature gathering.
Whether or not the transferrables are ready for transfer
Time at which the transferrables are expected to be ready
Weight in kilograms
Width in centimeters
Depth in centimeters
Height in centimeters
Arbitrary kind of object (box, document, paper bag etc)
Visual description of package that differentiates it from others that may be in the user's posession
Description of package contents
Special instructions for handling that wouldn't be otherwise marked or obvious
Additional properties are allowed.
List of intangible items (such as verbal information or services) to be included in the transfer
Description of the item to be transferred
Additional properties are allowed.
Target transfer at a role or class of persons
Description of the role
Additional properties are allowed.
Target transfer at an individual person
Individual person's name
Individual person's phone number
Additional properties are allowed.
Target transfer at a physical location such as a dropbox, mail slot, or hiding place
Description of the role
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Detailed arrival metadata for destinations
Coordinates of vehicle parking
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Coordinates of center of the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Coordinates of the ideal ingress point to the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Visual description by which the building can be differentiated from the surrounding buildings
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Number of floor on which unit entry is located
The natural identifier of the unit, such as an apartment or room number.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Street address of the destination
Primary coordinates of the destination
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Recognizable name of the destination
Detailed arrival metadata for destinations
Coordinates of vehicle parking
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Coordinates of center of the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Coordinates of the ideal ingress point to the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Visual description by which the building can be differentiated from the surrounding buildings
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Number of floor on which unit entry is located
The natural identifier of the unit, such as an apartment or room number.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A presence objective models the task of arriving to a specific place
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Street address of the destination
Primary coordinates of the destination
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Recognizable name of the destination
Detailed arrival metadata for destinations
Coordinates of vehicle parking
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Coordinates of center of the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Coordinates of the ideal ingress point to the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Visual description by which the building can be differentiated from the surrounding buildings
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Number of floor on which unit entry is located
The natural identifier of the unit, such as an apartment or room number.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
List of currently active objectives for the user.
A transfer objective models the pickup/dropoff of physical goods, or intangibles such as information and services.
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Whether the transfer is incoming to the user, or outgoing from the user
Description of any requirements or limits on the transfer that the user should be reminded of - such as ID verification or signature gathering.
Whether or not the transferrables are ready for transfer
Time at which the transferrables are expected to be ready
Weight in kilograms
Width in centimeters
Depth in centimeters
Height in centimeters
Arbitrary kind of object (box, document, paper bag etc)
Visual description of package that differentiates it from others that may be in the user's posession
Description of package contents
Special instructions for handling that wouldn't be otherwise marked or obvious
Additional properties are allowed.
List of intangible items (such as verbal information or services) to be included in the transfer
Description of the item to be transferred
Additional properties are allowed.
Target transfer at a role or class of persons
Description of the role
Additional properties are allowed.
Target transfer at an individual person
Individual person's name
Individual person's phone number
Additional properties are allowed.
Target transfer at a physical location such as a dropbox, mail slot, or hiding place
Description of the role
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A presence objective models the task of arriving to a specific place
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Street address of the destination
Primary coordinates of the destination
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Recognizable name of the destination
Detailed arrival metadata for destinations
Coordinates of vehicle parking
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Coordinates of center of the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Coordinates of the ideal ingress point to the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Visual description by which the building can be differentiated from the surrounding buildings
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Number of floor on which unit entry is located
The natural identifier of the unit, such as an apartment or room number.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Travel mode influences routing, statement timing, verbosity, and other characteristics.
Description of the user's situation, including their current objectives and actions.
Unstructured text that is likely to contain useful information for the user. In general, this is a place to dump content that couldn't be adequately mapped to other fields. Behind the scenes, we mine this text for relevant delivery details, as well as use it for general LLM context. This is a good place for transcripts of previous conversations the customer has had with delivery users.
Definition of an action that the user can perform using their voice. These actions typically correlate to primary buttons that are active in the screen UI.
Name of the action. Typically this name would match an enum of action names that your application is ready to handle.
Description of the action's outcome
Arguments (if any) required to fulfill the action
Display name of the argument
Describe the arguments contents
Additional properties are allowed.
Additional properties are allowed.
List of currently active objectives for the user.
A transfer objective models the pickup/dropoff of physical goods, or intangibles such as information and services.
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Whether the transfer is incoming to the user, or outgoing from the user
Description of any requirements or limits on the transfer that the user should be reminded of - such as ID verification or signature gathering.
Whether or not the transferrables are ready for transfer
Time at which the transferrables are expected to be ready
Weight in kilograms
Width in centimeters
Depth in centimeters
Height in centimeters
Arbitrary kind of object (box, document, paper bag etc)
Visual description of package that differentiates it from others that may be in the user's posession
Description of package contents
Special instructions for handling that wouldn't be otherwise marked or obvious
Additional properties are allowed.
List of intangible items (such as verbal information or services) to be included in the transfer
Description of the item to be transferred
Additional properties are allowed.
Target transfer at a role or class of persons
Description of the role
Additional properties are allowed.
Target transfer at an individual person
Individual person's name
Individual person's phone number
Additional properties are allowed.
Target transfer at a physical location such as a dropbox, mail slot, or hiding place
Description of the role
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A presence objective models the task of arriving to a specific place
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Street address of the destination
Primary coordinates of the destination
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Recognizable name of the destination
Detailed arrival metadata for destinations
Coordinates of vehicle parking
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Coordinates of center of the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Coordinates of the ideal ingress point to the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Visual description by which the building can be differentiated from the surrounding buildings
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Number of floor on which unit entry is located
The natural identifier of the unit, such as an apartment or room number.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Travel mode influences routing, statement timing, verbosity, and other characteristics.
Additional properties are allowed.
Updates to the user's context.
Unstructured text that is likely to contain useful information for the user. In general, this is a place to dump content that couldn't be adequately mapped to other fields. Behind the scenes, we mine this text for relevant delivery details, as well as use it for general LLM context. This is a good place for transcripts of previous conversations the customer has had with delivery users.
Definition of an action that the user can perform using their voice. These actions typically correlate to primary buttons that are active in the screen UI.
Name of the action. Typically this name would match an enum of action names that your application is ready to handle.
Description of the action's outcome
Arguments (if any) required to fulfill the action
Display name of the argument
Describe the arguments contents
Additional properties are allowed.
Additional properties are allowed.
List of currently active objectives for the user.
A transfer objective models the pickup/dropoff of physical goods, or intangibles such as information and services.
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Whether the transfer is incoming to the user, or outgoing from the user
Description of any requirements or limits on the transfer that the user should be reminded of - such as ID verification or signature gathering.
Whether or not the transferrables are ready for transfer
Time at which the transferrables are expected to be ready
Weight in kilograms
Width in centimeters
Depth in centimeters
Height in centimeters
Arbitrary kind of object (box, document, paper bag etc)
Visual description of package that differentiates it from others that may be in the user's posession
Description of package contents
Special instructions for handling that wouldn't be otherwise marked or obvious
Additional properties are allowed.
List of intangible items (such as verbal information or services) to be included in the transfer
Description of the item to be transferred
Additional properties are allowed.
Target transfer at a role or class of persons
Description of the role
Additional properties are allowed.
Target transfer at an individual person
Individual person's name
Individual person's phone number
Additional properties are allowed.
Target transfer at a physical location such as a dropbox, mail slot, or hiding place
Description of the role
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A presence objective models the task of arriving to a specific place
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Street address of the destination
Primary coordinates of the destination
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Recognizable name of the destination
Detailed arrival metadata for destinations
Coordinates of vehicle parking
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Coordinates of center of the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Coordinates of the ideal ingress point to the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Visual description by which the building can be differentiated from the surrounding buildings
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Number of floor on which unit entry is located
The natural identifier of the unit, such as an apartment or room number.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Travel mode influences routing, statement timing, verbosity, and other characteristics.
Additional properties are allowed.
GeoJSON describing the user's current position and planned routes.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Time at which the user indicated this feedback
Standardized feedback intent from user to assistant.
Additional properties are allowed.
Audio clip
Clip ID
Audio duration in milliseconds
File size in bytes
Signed URL of the rendered audio, expires after 10 minutes
Additional properties are allowed.
Item to be displayed on the HUD within a specific geographic location
Text instruction to the user
Enumerated standard natures, to be used as keys for selecting standard graphics/icons
GeoJSON LineString or Polygon representing the area within which this HUD display should be active.
If geometry is a LineString, HUD item should be active while user is near the line AND has a similar bearing to the line.
If geometry is a Polygon, HUD item should be active while user is within the polygon.
Additional properties are allowed.
Lat/lng location of the subject of the item (typically the manoeuvre being instructed)
Additional properties are allowed.
Additional properties are allowed.
Base64-encoded PCM 24000 16bit LE
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Metadata about the current state of a client device
Device battery level in % (0-100)
Whether or not the device is currently in a "navigating" mode.
Additional properties are allowed.
Additional properties are allowed.
List of fixes to submit
Positional fix from GPS
Latitude in degrees
Longitude in degrees
Estimated direction the user is facing. North at 0 degress, clockwise to 360.
Course over ground in degrees. North at 0 degress, clockwise to 360.
Velocity in meters per second
Meters above sea level
Accuracy of location in meters
Accuracy of altitude in meters
Additional properties are allowed.
List of fixes to submit
Positional fix from GPS
Latitude in degrees
Longitude in degrees
Estimated direction the user is facing. North at 0 degress, clockwise to 360.
Course over ground in degrees. North at 0 degress, clockwise to 360.
Velocity in meters per second
Meters above sea level
Accuracy of location in meters
Accuracy of altitude in meters
Additional properties are allowed.
Additional properties are allowed.
Metadata about the identity of the device
Opaque stable identifier for the device. Typically randomly generated and stored on the device, or provided by the operating system.
Additional properties are allowed.
Additional properties are allowed.
Interjection to be made to the user, including all metadata needed to communicate it to them correctly
Plain text of the interjection's content
ISO 639-1 language code and ISO 3166-1 country code joined by a "_"
Duration of audio in seconds
Signed URL of the rendered audio, expires after 10 minutes
Additional properties are allowed.
Additional properties are allowed.
Control signal
Additional properties are allowed.
Additional properties are allowed.
Description of the user's situation, including their current objectives and actions.
Unstructured text that is likely to contain useful information for the user. In general, this is a place to dump content that couldn't be adequately mapped to other fields. Behind the scenes, we mine this text for relevant delivery details, as well as use it for general LLM context. This is a good place for transcripts of previous conversations the customer has had with delivery users.
Definition of an action that the user can perform using their voice. These actions typically correlate to primary buttons that are active in the screen UI.
Name of the action. Typically this name would match an enum of action names that your application is ready to handle.
Description of the action's outcome
Arguments (if any) required to fulfill the action
Display name of the argument
Describe the arguments contents
Additional properties are allowed.
Additional properties are allowed.
List of currently active objectives for the user.
A transfer objective models the pickup/dropoff of physical goods, or intangibles such as information and services.
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Whether the transfer is incoming to the user, or outgoing from the user
Description of any requirements or limits on the transfer that the user should be reminded of - such as ID verification or signature gathering.
Whether or not the transferrables are ready for transfer
Time at which the transferrables are expected to be ready
Weight in kilograms
Width in centimeters
Depth in centimeters
Height in centimeters
Arbitrary kind of object (box, document, paper bag etc)
Visual description of package that differentiates it from others that may be in the user's posession
Description of package contents
Special instructions for handling that wouldn't be otherwise marked or obvious
Additional properties are allowed.
List of intangible items (such as verbal information or services) to be included in the transfer
Description of the item to be transferred
Additional properties are allowed.
Target transfer at a role or class of persons
Description of the role
Additional properties are allowed.
Target transfer at an individual person
Individual person's name
Individual person's phone number
Additional properties are allowed.
Target transfer at a physical location such as a dropbox, mail slot, or hiding place
Description of the role
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A presence objective models the task of arriving to a specific place
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Street address of the destination
Primary coordinates of the destination
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Recognizable name of the destination
Detailed arrival metadata for destinations
Coordinates of vehicle parking
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Coordinates of center of the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Coordinates of the ideal ingress point to the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Visual description by which the building can be differentiated from the surrounding buildings
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Number of floor on which unit entry is located
The natural identifier of the unit, such as an apartment or room number.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Travel mode influences routing, statement timing, verbosity, and other characteristics.
Additional properties are allowed.
GeoJSON describing the user's current position and planned routes.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
List of upcoming statements for a user
Statement to be made to the user, including all metadata needed to communicate it to them correctly
Plain text of the statement's content
ISO 639-1 language code and ISO 3166-1 country code joined by a "_"
ID of cloud-rendered audio clip
Statement trigger targeting a specific location
Additional properties are allowed.
Additional properties are allowed.
List of available HUD items for a user
Item to be displayed on the HUD within a specific geographic location
Text instruction to the user
Enumerated standard natures, to be used as keys for selecting standard graphics/icons
GeoJSON LineString or Polygon representing the area within which this HUD display should be active.
If geometry is a LineString, HUD item should be active while user is near the line AND has a similar bearing to the line.
If geometry is a Polygon, HUD item should be active while user is within the polygon.
Additional properties are allowed.
Lat/lng location of the subject of the item (typically the manoeuvre being instructed)
Additional properties are allowed.
Metadata about the current state of the server from the user's perspective
Whether the server is currently working on updates to the user's plan. While true, whatever existing plan may be cached on the client should be treated as invalid/disabled.
Currently applicable error message for display to user regarding a server-side issue. Expected to always be null. When set with a value, it's due to an unsolvable error that is going to keep Wysp from working.
Availability of wysp's various data sources for the user's current location/plan. User should be gently notified of PARTIAL availability, and warned strongly of LOW availability.
Additional properties are allowed.
Additional properties are allowed.
Description of the user's situation, including their current objectives and actions.
Unstructured text that is likely to contain useful information for the user. In general, this is a place to dump content that couldn't be adequately mapped to other fields. Behind the scenes, we mine this text for relevant delivery details, as well as use it for general LLM context. This is a good place for transcripts of previous conversations the customer has had with delivery users.
Definition of an action that the user can perform using their voice. These actions typically correlate to primary buttons that are active in the screen UI.
Name of the action. Typically this name would match an enum of action names that your application is ready to handle.
Description of the action's outcome
Arguments (if any) required to fulfill the action
Display name of the argument
Describe the arguments contents
Additional properties are allowed.
Additional properties are allowed.
List of currently active objectives for the user.
A transfer objective models the pickup/dropoff of physical goods, or intangibles such as information and services.
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Whether the transfer is incoming to the user, or outgoing from the user
Description of any requirements or limits on the transfer that the user should be reminded of - such as ID verification or signature gathering.
Whether or not the transferrables are ready for transfer
Time at which the transferrables are expected to be ready
Weight in kilograms
Width in centimeters
Depth in centimeters
Height in centimeters
Arbitrary kind of object (box, document, paper bag etc)
Visual description of package that differentiates it from others that may be in the user's posession
Description of package contents
Special instructions for handling that wouldn't be otherwise marked or obvious
Additional properties are allowed.
List of intangible items (such as verbal information or services) to be included in the transfer
Description of the item to be transferred
Additional properties are allowed.
Target transfer at a role or class of persons
Description of the role
Additional properties are allowed.
Target transfer at an individual person
Individual person's name
Individual person's phone number
Additional properties are allowed.
Target transfer at a physical location such as a dropbox, mail slot, or hiding place
Description of the role
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A presence objective models the task of arriving to a specific place
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Street address of the destination
Primary coordinates of the destination
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Recognizable name of the destination
Detailed arrival metadata for destinations
Coordinates of vehicle parking
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Coordinates of center of the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Coordinates of the ideal ingress point to the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Visual description by which the building can be differentiated from the surrounding buildings
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Number of floor on which unit entry is located
The natural identifier of the unit, such as an apartment or room number.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Travel mode influences routing, statement timing, verbosity, and other characteristics.
Additional properties are allowed.
GeoJSON describing the user's current position and planned routes.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
List of upcoming statements for a user
Statement to be made to the user, including all metadata needed to communicate it to them correctly
Plain text of the statement's content
ISO 639-1 language code and ISO 3166-1 country code joined by a "_"
ID of cloud-rendered audio clip
Statement trigger targeting a specific location
Additional properties are allowed.
Additional properties are allowed.
List of available HUD items for a user
Item to be displayed on the HUD within a specific geographic location
Text instruction to the user
Enumerated standard natures, to be used as keys for selecting standard graphics/icons
GeoJSON LineString or Polygon representing the area within which this HUD display should be active.
If geometry is a LineString, HUD item should be active while user is near the line AND has a similar bearing to the line.
If geometry is a Polygon, HUD item should be active while user is within the polygon.
Additional properties are allowed.
Lat/lng location of the subject of the item (typically the manoeuvre being instructed)
Additional properties are allowed.
Metadata about the current state of the server from the user's perspective
Whether the server is currently working on updates to the user's plan. While true, whatever existing plan may be cached on the client should be treated as invalid/disabled.
Currently applicable error message for display to user regarding a server-side issue. Expected to always be null. When set with a value, it's due to an unsolvable error that is going to keep Wysp from working.
Availability of wysp's various data sources for the user's current location/plan. User should be gently notified of PARTIAL availability, and warned strongly of LOW availability.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Updates to the user's context.
Unstructured text that is likely to contain useful information for the user. In general, this is a place to dump content that couldn't be adequately mapped to other fields. Behind the scenes, we mine this text for relevant delivery details, as well as use it for general LLM context. This is a good place for transcripts of previous conversations the customer has had with delivery users.
Definition of an action that the user can perform using their voice. These actions typically correlate to primary buttons that are active in the screen UI.
Name of the action. Typically this name would match an enum of action names that your application is ready to handle.
Description of the action's outcome
Arguments (if any) required to fulfill the action
Display name of the argument
Describe the arguments contents
Additional properties are allowed.
Additional properties are allowed.
List of currently active objectives for the user.
A transfer objective models the pickup/dropoff of physical goods, or intangibles such as information and services.
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Whether the transfer is incoming to the user, or outgoing from the user
Description of any requirements or limits on the transfer that the user should be reminded of - such as ID verification or signature gathering.
Whether or not the transferrables are ready for transfer
Time at which the transferrables are expected to be ready
Weight in kilograms
Width in centimeters
Depth in centimeters
Height in centimeters
Arbitrary kind of object (box, document, paper bag etc)
Visual description of package that differentiates it from others that may be in the user's posession
Description of package contents
Special instructions for handling that wouldn't be otherwise marked or obvious
Additional properties are allowed.
List of intangible items (such as verbal information or services) to be included in the transfer
Description of the item to be transferred
Additional properties are allowed.
Target transfer at a role or class of persons
Description of the role
Additional properties are allowed.
Target transfer at an individual person
Individual person's name
Individual person's phone number
Additional properties are allowed.
Target transfer at a physical location such as a dropbox, mail slot, or hiding place
Description of the role
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A presence objective models the task of arriving to a specific place
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Street address of the destination
Primary coordinates of the destination
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Recognizable name of the destination
Detailed arrival metadata for destinations
Coordinates of vehicle parking
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Coordinates of center of the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Coordinates of the ideal ingress point to the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Visual description by which the building can be differentiated from the surrounding buildings
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Number of floor on which unit entry is located
The natural identifier of the unit, such as an apartment or room number.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Travel mode influences routing, statement timing, verbosity, and other characteristics.
Additional properties are allowed.
Additional properties are allowed.
Description of the user's situation, including their current objectives and actions.
Unstructured text that is likely to contain useful information for the user. In general, this is a place to dump content that couldn't be adequately mapped to other fields. Behind the scenes, we mine this text for relevant delivery details, as well as use it for general LLM context. This is a good place for transcripts of previous conversations the customer has had with delivery users.
Definition of an action that the user can perform using their voice. These actions typically correlate to primary buttons that are active in the screen UI.
Name of the action. Typically this name would match an enum of action names that your application is ready to handle.
Description of the action's outcome
Arguments (if any) required to fulfill the action
Display name of the argument
Describe the arguments contents
Additional properties are allowed.
Additional properties are allowed.
List of currently active objectives for the user.
A transfer objective models the pickup/dropoff of physical goods, or intangibles such as information and services.
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Whether the transfer is incoming to the user, or outgoing from the user
Description of any requirements or limits on the transfer that the user should be reminded of - such as ID verification or signature gathering.
Whether or not the transferrables are ready for transfer
Time at which the transferrables are expected to be ready
Weight in kilograms
Width in centimeters
Depth in centimeters
Height in centimeters
Arbitrary kind of object (box, document, paper bag etc)
Visual description of package that differentiates it from others that may be in the user's posession
Description of package contents
Special instructions for handling that wouldn't be otherwise marked or obvious
Additional properties are allowed.
List of intangible items (such as verbal information or services) to be included in the transfer
Description of the item to be transferred
Additional properties are allowed.
Target transfer at a role or class of persons
Description of the role
Additional properties are allowed.
Target transfer at an individual person
Individual person's name
Individual person's phone number
Additional properties are allowed.
Target transfer at a physical location such as a dropbox, mail slot, or hiding place
Description of the role
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A presence objective models the task of arriving to a specific place
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Street address of the destination
Primary coordinates of the destination
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Recognizable name of the destination
Detailed arrival metadata for destinations
Coordinates of vehicle parking
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Coordinates of center of the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Coordinates of the ideal ingress point to the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Visual description by which the building can be differentiated from the surrounding buildings
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Number of floor on which unit entry is located
The natural identifier of the unit, such as an apartment or room number.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Travel mode influences routing, statement timing, verbosity, and other characteristics.
Additional properties are allowed.
GeoJSON describing the user's current position and planned routes.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
List of upcoming statements for a user
Statement to be made to the user, including all metadata needed to communicate it to them correctly
Plain text of the statement's content
ISO 639-1 language code and ISO 3166-1 country code joined by a "_"
ID of cloud-rendered audio clip
Statement trigger targeting a specific location
Additional properties are allowed.
Additional properties are allowed.
List of available HUD items for a user
Item to be displayed on the HUD within a specific geographic location
Text instruction to the user
Enumerated standard natures, to be used as keys for selecting standard graphics/icons
GeoJSON LineString or Polygon representing the area within which this HUD display should be active.
If geometry is a LineString, HUD item should be active while user is near the line AND has a similar bearing to the line.
If geometry is a Polygon, HUD item should be active while user is within the polygon.
Additional properties are allowed.
Lat/lng location of the subject of the item (typically the manoeuvre being instructed)
Additional properties are allowed.
Metadata about the current state of the server from the user's perspective
Whether the server is currently working on updates to the user's plan. While true, whatever existing plan may be cached on the client should be treated as invalid/disabled.
Currently applicable error message for display to user regarding a server-side issue. Expected to always be null. When set with a value, it's due to an unsolvable error that is going to keep Wysp from working.
Availability of wysp's various data sources for the user's current location/plan. User should be gently notified of PARTIAL availability, and warned strongly of LOW availability.
Additional properties are allowed.
Additional properties are allowed.
Description of the user's situation, including their current objectives and actions.
Unstructured text that is likely to contain useful information for the user. In general, this is a place to dump content that couldn't be adequately mapped to other fields. Behind the scenes, we mine this text for relevant delivery details, as well as use it for general LLM context. This is a good place for transcripts of previous conversations the customer has had with delivery users.
Definition of an action that the user can perform using their voice. These actions typically correlate to primary buttons that are active in the screen UI.
Name of the action. Typically this name would match an enum of action names that your application is ready to handle.
Description of the action's outcome
Arguments (if any) required to fulfill the action
Display name of the argument
Describe the arguments contents
Additional properties are allowed.
Additional properties are allowed.
List of currently active objectives for the user.
A transfer objective models the pickup/dropoff of physical goods, or intangibles such as information and services.
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Whether the transfer is incoming to the user, or outgoing from the user
Description of any requirements or limits on the transfer that the user should be reminded of - such as ID verification or signature gathering.
Whether or not the transferrables are ready for transfer
Time at which the transferrables are expected to be ready
Weight in kilograms
Width in centimeters
Depth in centimeters
Height in centimeters
Arbitrary kind of object (box, document, paper bag etc)
Visual description of package that differentiates it from others that may be in the user's posession
Description of package contents
Special instructions for handling that wouldn't be otherwise marked or obvious
Additional properties are allowed.
List of intangible items (such as verbal information or services) to be included in the transfer
Description of the item to be transferred
Additional properties are allowed.
Target transfer at a role or class of persons
Description of the role
Additional properties are allowed.
Target transfer at an individual person
Individual person's name
Individual person's phone number
Additional properties are allowed.
Target transfer at a physical location such as a dropbox, mail slot, or hiding place
Description of the role
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A presence objective models the task of arriving to a specific place
Kind of the objective
Expected time by which the objective should be completed
Expected duration of objective in seconds
Additional properties are allowed.
Street address of the destination
Primary coordinates of the destination
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Recognizable name of the destination
Detailed arrival metadata for destinations
Coordinates of vehicle parking
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Coordinates of center of the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Coordinates of the ideal ingress point to the building
Geographic coordinates
Latitude in degrees
Longitude in degrees
Additional properties are allowed.
Visual description by which the building can be differentiated from the surrounding buildings
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Number of floor on which unit entry is located
The natural identifier of the unit, such as an apartment or room number.
Metadata about an interactive ingress that an user must perform
Kind of ingress interaction.
Datapoint required for the interaction. Provide the bare intercom number, phone number, etc. If the interaction is kind unknown, the value can be a plain text description of what the user should do.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Travel mode influences routing, statement timing, verbosity, and other characteristics.
Additional properties are allowed.
GeoJSON describing the user's current position and planned routes.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
List of upcoming statements for a user
Statement to be made to the user, including all metadata needed to communicate it to them correctly
Plain text of the statement's content
ISO 639-1 language code and ISO 3166-1 country code joined by a "_"
ID of cloud-rendered audio clip
Statement trigger targeting a specific location
Additional properties are allowed.
Additional properties are allowed.
List of available HUD items for a user
Item to be displayed on the HUD within a specific geographic location
Text instruction to the user
Enumerated standard natures, to be used as keys for selecting standard graphics/icons
GeoJSON LineString or Polygon representing the area within which this HUD display should be active.
If geometry is a LineString, HUD item should be active while user is near the line AND has a similar bearing to the line.
If geometry is a Polygon, HUD item should be active while user is within the polygon.
Additional properties are allowed.
Lat/lng location of the subject of the item (typically the manoeuvre being instructed)
Additional properties are allowed.
Metadata about the current state of the server from the user's perspective
Whether the server is currently working on updates to the user's plan. While true, whatever existing plan may be cached on the client should be treated as invalid/disabled.
Currently applicable error message for display to user regarding a server-side issue. Expected to always be null. When set with a value, it's due to an unsolvable error that is going to keep Wysp from working.
Availability of wysp's various data sources for the user's current location/plan. User should be gently notified of PARTIAL availability, and warned strongly of LOW availability.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.