tools.*

tools.add_destination

Add a destination to the trip

Data Schema

type: object

Properties

Name	Type	Required	Description
requestId	string	yes	Arbitrary ID (for response matching)
params	object	yes

Example

{
  "kind": "tools.add_destination",
  "data": {
    "requestId": "myrequest-123",
    "params": {
      "query": "cafe sara"
    }
  }
}

tools.change_given_name

Change the user’s given name

Data Schema

type: object

Properties

Name	Type	Required	Description
requestId	string	yes	Arbitrary ID (for response matching)
params	object	yes

Example

{
  "kind": "tools.change_given_name",
  "data": {
    "requestId": "myrequest-123",
    "params": {
      "givenName": "string"
    }
  }
}

tools.change_languages

Change the user’s language preferences

Data Schema

type: object

Properties

Name	Type	Required	Description
requestId	string	yes	Arbitrary ID (for response matching)
params	object	yes

Example

{
  "kind": "tools.change_languages",
  "data": {
    "requestId": "myrequest-123",
    "params": {
      "languages": [
        "en-US"
      ]
    }
  }
}

tools.change_travel_mode

Set the travel mode for navigation

Data Schema

type: object

Properties

Name	Type	Required	Description
requestId	string	yes	Arbitrary ID (for response matching)
params	object	yes

Example

{
  "kind": "tools.change_travel_mode",
  "data": {
    "requestId": "myrequest-123",
    "params": {
      "travelMode": "BICYCLE"
    }
  }
}

tools.change_unit_system

Change the user’s language preference and start speaking a different language

Data Schema

type: object

Properties

Name	Type	Required	Description
requestId	string	yes	Arbitrary ID (for response matching)
params	object	yes

Example

{
  "kind": "tools.change_unit_system",
  "data": {
    "requestId": "myrequest-123",
    "params": {
      "unitSystem": "LOCAL"
    }
  }
}

tools.get_clarification

Get clarification on which way to go

Data Schema

type: object

Properties

Name	Type	Required	Description
requestId	string	yes	Arbitrary ID (for response matching)
params	object	yes

Example

{
  "kind": "tools.get_clarification",
  "data": {
    "requestId": "myrequest-123",
    "params": {
      "question": "where do I turn?"
    }
  }
}

tools.remove_destination

Remove a destination from the trip

Data Schema

type: object

Properties

Name	Type	Required	Description
requestId	string	yes	Arbitrary ID (for response matching)
params	object	yes

Example

{
  "kind": "tools.remove_destination",
  "data": {
    "requestId": "myrequest-123",
    "params": {
      "destination": "cafe sara"
    }
  }
}

tools.reorder_destinations

Reorder the destinations within a trip

Data Schema

type: object

Properties

Name	Type	Required	Description
requestId	string	yes	Arbitrary ID (for response matching)
params	object	yes

Example

{
  "kind": "tools.reorder_destinations",
  "data": {
    "requestId": "myrequest-123",
    "params": {
      "desiredOrder": "Cafe Sara, then Astrup Fearnley"
    }
  }
}

tools.search_map

Search the map for places, addresses, businesses, etc.

Data Schema

type: object

Properties

Name	Type	Required	Description
requestId	string	yes	Arbitrary ID (for response matching)
params	object	yes

Example

{
  "kind": "tools.search_map",
  "data": {
    "requestId": "myrequest-123",
    "params": {
      "query": "coffee shop on the way"
    }
  }
}

tools.start_navigation

Start navigation mode

Data Schema

type: object

Properties

Name	Type	Required	Description
requestId	string	yes	Arbitrary ID (for response matching)
params	object	yes

Example

{
  "kind": "tools.start_navigation",
  "data": {
    "requestId": "myrequest-123",
    "params": {}
  }
}

tools.stop_navigation

Stop navigation mode

Data Schema

type: object

Properties

Name	Type	Required	Description
requestId	string	yes	Arbitrary ID (for response matching)
params	object	yes

Example

{
  "kind": "tools.stop_navigation",
  "data": {
    "requestId": "myrequest-123",
    "params": {}
  }
}