Vehicles
Check fleet availability
Returns, for each vehicle (the whole fleet, or the ones selected by vehicleIds, tags, collectionId or search), whether it has commitments overlapping the queried window and which ones, typed.
vehicles:readvehicles:read- 120/min + 30/min availability
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Same response shape as staff availability. A requested identifier that does not exist comes back as a per-item error. Idempotent query (POST because of the structured body). Shares the availability quota of 30 req/min.
Arguments
Start of the window to check (ISO 8601 with offset).
End of the window to check (ISO 8601 with offset); must be later than startDate.
Only resources in this collection.
Limits: min length 1, max length 100
Free-text search on the name.
Limits: min length 1, max length 200
Restrict the answer to these vehicles (1-100). An identifier that does not exist comes back as a per-item error.
Limits: min 1 items, max 100 items, each min length 1, each max length 100
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
Sample prompts
Is a van free on 20 January from 8:00 to 18:00?
The same operation by REST
This tool runs POST /api/v1/vehicles/availability.
Related pages
Link to this section: Related pagesVehicles
Check fleet availability
Returns, for each vehicle (the whole fleet, or the ones selected by
vehicleIds,tags,collectionIdorsearch), whether it has commitments overlapping the queried window and which ones, typed.Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?