Path parameters
Path parameters replace {placeholders} in your tool URL with values the model collects from the conversation — for example {order_id} in /orders/{order_id}.
Define path params
Section titled “Define path params”- Include
{param_name}in the URL. - Add a matching parameter in the tool schema with location: path.
- Set type, description, and whether it is required.
Schema fields
Section titled “Schema fields”| Field | Guidance |
|---|---|
| Name | Must match the URL placeholder exactly (order_id ↔ {order_id}) |
| Type | string, number, or integer |
| Description | Tell the model what to ask for — e.g. “Customer order number, digits only” |
| Required | Usually true for path params |
Example
Section titled “Example”URL: https://api.yourstore.com/orders/{order_id}
| Param | Type | Required | Description |
|---|---|---|---|
order_id | string | yes | Order number the visitor provides |
When a visitor asks “Where is order 12345?”, the model calls the tool with order_id: "12345". Chatevo requests:
GET https://api.yourstore.com/orders/12345Multiple path params
Section titled “Multiple path params”https://api.example.com/hotels/{hotel_id}/rooms/{room_id}Define both hotel_id and room_id as path parameters. Order in the URL must match your API’s route design.
Path vs query
Section titled “Path vs query”| Use path when | Use query when |
|---|---|
| Identifying a specific resource | Filtering, search, pagination |
| RESTful resource IDs | Optional flags or date ranges |
See Query parameters.
Validation
Section titled “Validation”With strict params enabled, calls with missing or wrong-type path params are rejected before the HTTP request is sent.