BEEP.rent MCP
An official MCP server for BEEP.rent, a Polish car rental marketplace. It allows AI agents to search for available cars, retrieve pricing and conditions, initiate checkout flows, and manage existing reservations. The server provides live data on availability and prices, facilitating the booking process while ensuring the user confirms the final transaction via code or payment on the BEEP.rent platform.
Endpoint and access
No sign-in to connect and list tools. Individual tools may still need a vendor account, credentials, or permissions; check the documented prerequisites.
MCP endpoint (Streamable HTTP)
https://mcp.beep.rent/mcpWhat you can do with it
- Search for available rental cars by location and dates
- Retrieve detailed offer prices and insurance conditions
- Initiate checkout and book a reservation
- Manage existing reservations including cancellation and extension
Source and maintenance
Vendor evidenceRegistry 1.0.0
Protocol and capabilities
- Server
- beep-rent 1.0.0
- MCP protocol
- 2025-06-18
- Tools
- 18 advertised
- Resources
- Not advertised
- Resource templates
- Not advertised
- Prompts
- Not advertised
Server-advertised capabilities
{
"tools": {
"listChanged": false
}
}Server-provided instructions
Untrusted server output shown for inspection. It is not Koskamo guidance and is excluded from knowledge search.
Tools
18 advertised
search_offers — Search rental offers
Advertised read-onlyOpen-world
Use when looking for available cars and full prices in Poland. Supply the whole trip when changing criteria; omitted options reset. Filters and sort are not remembered: repeat them on every page. Do not use for an existing reservation. Examples: {"pickup":{"query":"Kraków"},"pickup_at":"2026-12-01T10:00:00+01:00","return_at":"2026-12-08T10:00:00+01:00","sort":"price"}; {"search_id":"from_previous_result","offset":8,"sort":"price"}.
search_offers input schema
{
"type": "object",
"title": "SearchInput",
"properties": {
"sort": {
"enum": [
"instant",
"no_advance_payment",
"distance",
"price"
],
"type": "string",
"title": "Sort",
"default": "instant"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": 8,
"maximum": 20,
"minimum": 1
},
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"offset": {
"type": "integer",
"title": "Offset",
"default": 0,
"maximum": 10000,
"minimum": 0
},
"pickup": {
"anyOf": [
{
"type": "object",
"title": "LocationInput",
"properties": {
"lat": {
"anyOf": [
{
"type": "number",
"maximum": 90,
"minimum": -90
},
{
"type": "null"
}
],
"title": "Lat",
"default": null
},
"lng": {
"anyOf": [
{
"type": "number",
"maximum": 180,
"minimum": -180
},
{
"type": "null"
}
],
"title": "Lng",
"default": null
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 160,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Query",
"default": null,
"description": "A place name or address, e.g. Kraków or Warsaw Chopin Airport."
},
"city_id": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 1
},
{
"type": "null"
}
],
"title": "City Id",
"default": null,
"description": "A city_id returned by get_city_prices or a clarification; for a city name use query."
},
"place_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Place Id",
"default": null,
"description": "A place_id from earlier candidates."
},
"pickup_point_id": {
"anyOf": [
{
"type": "string",
"maxLength": 64,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Pickup Point Id",
"default": null,
"description": "An id from find_pickup_points."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null,
"description": "For a new trip supply pickup, pickup_at and return_at together. For paging supply search_id instead."
},
"filters": {
"type": "object",
"title": "Filters",
"properties": {
"is_suv": {
"type": "boolean",
"title": "Is Suv",
"default": false
},
"gearbox": {
"anyOf": [
{
"enum": [
"manual",
"automatic"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Gearbox",
"default": null
},
"segment": {
"type": "array",
"items": {
"type": "string"
},
"title": "Segment",
"maxItems": 30,
"description": "Exact BEEP segment codes, never a body style such as estate/kombi."
},
"is_estate": {
"type": "boolean",
"title": "Is Estate",
"default": false,
"description": "True for kombi, estate, station wagon, Wagon or SW. Independent of segment and vehicle size."
},
"is_premium": {
"type": "boolean",
"title": "Is Premium",
"default": false
},
"low_deposit": {
"type": "boolean",
"title": "Low Deposit",
"default": false
},
"vehicle_size": {
"type": "array",
"items": {
"enum": [
"small",
"medium",
"large",
"xlarge"
],
"type": "string"
},
"title": "Vehicle Size",
"maxItems": 4
},
"zero_deposit": {
"type": "boolean",
"title": "Zero Deposit",
"default": false
},
"no_credit_card": {
"type": "boolean",
"title": "No Credit Card",
"default": false
},
"pay_at_pickup_only": {
"type": "boolean",
"title": "Pay At Pickup Only",
"default": false
}
},
"description": "A JSON object of filters. Omit it or use {} for no filters; never use [].",
"additionalProperties": false
},
"options": {
"type": "object",
"title": "Options",
"properties": {
"extras": {
"type": "array",
"items": {
"type": "string"
},
"title": "Extras",
"maxItems": 30
},
"cleaning": {
"type": "boolean",
"title": "Cleaning",
"default": false
},
"child_seats": {
"type": "array",
"items": {
"type": "object",
"title": "ChildSeat",
"required": [
"weight_kg"
],
"properties": {
"quantity": {
"type": "integer",
"title": "Quantity",
"default": 1,
"maximum": 3,
"minimum": 1
},
"weight_kg": {
"type": "integer",
"title": "Weight Kg",
"maximum": 36,
"minimum": 1
}
},
"additionalProperties": false
},
"title": "Child Seats",
"maxItems": 3
},
"coupon_code": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Coupon Code",
"default": null
},
"fuel_prepaid": {
"type": "boolean",
"title": "Fuel Prepaid",
"default": false
},
"zero_deposit": {
"type": "boolean",
"title": "Zero Deposit",
"default": false
},
"damage_waiver": {
"type": "boolean",
"title": "Damage Waiver",
"default": false
},
"foreign_countries": {
"type": "array",
"items": {
"type": "string"
},
"title": "Foreign Countries",
"maxItems": 10,
"description": "ISO 3166-1 alpha-2 country codes, e.g. DE for Germany or CZ for Czechia."
},
"additional_drivers": {
"type": "integer",
"title": "Additional Drivers",
"default": 0,
"maximum": 3,
"minimum": 0
},
"pickup_service_address": {
"anyOf": [
{
"type": "string",
"maxLength": 160,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Pickup Service Address",
"default": null,
"description": "A street address in Poland, e.g. Woronicza 17, Warszawa."
},
"return_service_address": {
"anyOf": [
{
"type": "string",
"maxLength": 160,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Return Service Address",
"default": null,
"description": "A street address in Poland, e.g. Woronicza 17, Warszawa."
},
"pickup_service_place_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Pickup Service Place Id",
"default": null,
"description": "A place_id from earlier candidates."
},
"return_service_place_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Return Service Place Id",
"default": null,
"description": "A place_id from earlier candidates."
}
},
"description": "A JSON object of rental options. Omit it or use {} for defaults; never use [].",
"additionalProperties": false
},
"card_type": {
"enum": [
"credit",
"debit",
"none"
],
"type": "string",
"title": "Card Type",
"default": "credit"
},
"pickup_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup At",
"default": null
},
"return_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return At",
"default": null
},
"search_id": {
"anyOf": [
{
"type": "string",
"maxLength": 64,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Search Id",
"default": null
},
"driver_age": {
"type": "integer",
"title": "Driver Age",
"default": 31,
"maximum": 99,
"minimum": 18
},
"response_format": {
"enum": [
"concise",
"detailed"
],
"type": "string",
"title": "Response Format",
"default": "concise"
},
"return_location": {
"anyOf": [
{
"type": "object",
"title": "LocationInput",
"properties": {
"lat": {
"anyOf": [
{
"type": "number",
"maximum": 90,
"minimum": -90
},
{
"type": "null"
}
],
"title": "Lat",
"default": null
},
"lng": {
"anyOf": [
{
"type": "number",
"maximum": 180,
"minimum": -180
},
{
"type": "null"
}
],
"title": "Lng",
"default": null
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 160,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Query",
"default": null,
"description": "A place name or address, e.g. Kraków or Warsaw Chopin Airport."
},
"city_id": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 1
},
{
"type": "null"
}
],
"title": "City Id",
"default": null,
"description": "A city_id returned by get_city_prices or a clarification; for a city name use query."
},
"place_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Place Id",
"default": null,
"description": "A place_id from earlier candidates."
},
"pickup_point_id": {
"anyOf": [
{
"type": "string",
"maxLength": 64,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Pickup Point Id",
"default": null,
"description": "An id from find_pickup_points."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
},
"license_tenure_months": {
"type": "integer",
"title": "License Tenure Months",
"default": 60,
"maximum": 1200,
"minimum": 0
}
},
"additionalProperties": false
}search_offers output schema
{
"type": "object",
"title": "ToolResult",
"properties": {
"meta": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Meta",
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"default": null
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Field",
"default": null
},
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"offer": {
"anyOf": [
{
"type": "object",
"title": "OfferCard",
"required": [
"offer_ref",
"price"
],
"properties": {
"price": {
"type": "object",
"title": "OfferPrice",
"required": [
"includes_selected_options"
],
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_now": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"per_day": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"includes_selected_options": {
"type": "boolean",
"title": "Includes Selected Options"
}
}
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"default": null
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"offer_ref": {
"type": "string",
"title": "Offer Ref"
}
},
"additionalProperties": true
},
{
"type": "null"
}
],
"default": null
},
"driver": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Driver",
"default": null
},
"facets": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Facets",
"default": null
},
"offers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "OfferCard",
"required": [
"offer_ref",
"price"
],
"properties": {
"price": {
"type": "object",
"title": "OfferPrice",
"required": [
"includes_selected_options"
],
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_now": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"per_day": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"includes_selected_options": {
"type": "boolean",
"title": "Includes Selected Options"
}
}
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"default": null
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"offer_ref": {
"type": "string",
"title": "Offer Ref"
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Offers",
"default": null
},
"pickup": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Pickup",
"default": null
},
"points": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Points",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"city_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City Id",
"default": null
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"default": null
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"search_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search Id",
"default": null
},
"candidates": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Candidates",
"default": null
},
"categories": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Categories",
"default": null
},
"conditions": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Conditions",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"pagination": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Pagination",
"default": null
},
"valid_until": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Valid Until",
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"return_location": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Return Location",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
}
},
"description": "Common optional workflow fields; each handler has its own input schema."
}search_offers annotations
{
"title": "Search rental offers",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}get_offer — Read an offer and its conditions
Advertised read-only
Use after search_offers to read current pricing, deposit, extras and rental policies. Supplied options are applied on top of the search selections; omitted options keep the search values. Options from earlier get_offer calls are not remembered: resend every option you changed. detail "full" adds every photo; "policies" keeps the policies in a concise response. Do not use to book or confirm a reservation. Example: {"search_id":"from_search","offer_ref":"from_offer"}.
get_offer input schema
{
"type": "object",
"title": "OfferInput",
"required": [
"search_id",
"offer_ref"
],
"properties": {
"detail": {
"enum": [
"summary",
"policies",
"full"
],
"type": "string",
"title": "Detail",
"default": "summary"
},
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"options": {
"anyOf": [
{
"type": "object",
"title": "OfferOptions",
"properties": {
"extras": {
"type": "array",
"items": {
"type": "string"
},
"title": "Extras",
"maxItems": 30
},
"cleaning": {
"type": "boolean",
"title": "Cleaning",
"default": false
},
"card_type": {
"anyOf": [
{
"enum": [
"credit",
"debit"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Card Type",
"default": null
},
"driver_age": {
"anyOf": [
{
"type": "integer",
"maximum": 99,
"minimum": 18
},
{
"type": "null"
}
],
"title": "Driver Age",
"default": null
},
"child_seats": {
"type": "array",
"items": {
"type": "object",
"title": "ChildSeat",
"required": [
"weight_kg"
],
"properties": {
"quantity": {
"type": "integer",
"title": "Quantity",
"default": 1,
"maximum": 3,
"minimum": 1
},
"weight_kg": {
"type": "integer",
"title": "Weight Kg",
"maximum": 36,
"minimum": 1
}
},
"additionalProperties": false
},
"title": "Child Seats",
"maxItems": 3
},
"coupon_code": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Coupon Code",
"default": null
},
"fuel_prepaid": {
"type": "boolean",
"title": "Fuel Prepaid",
"default": false
},
"zero_deposit": {
"type": "boolean",
"title": "Zero Deposit",
"default": false
},
"damage_waiver": {
"type": "boolean",
"title": "Damage Waiver",
"default": false
},
"foreign_countries": {
"type": "array",
"items": {
"type": "string"
},
"title": "Foreign Countries",
"maxItems": 10,
"description": "ISO 3166-1 alpha-2 country codes, e.g. DE for Germany or CZ for Czechia."
},
"additional_drivers": {
"type": "integer",
"title": "Additional Drivers",
"default": 0,
"maximum": 3,
"minimum": 0
},
"license_tenure_months": {
"anyOf": [
{
"type": "integer",
"maximum": 1200,
"minimum": 0
},
{
"type": "null"
}
],
"title": "License Tenure Months",
"default": null
},
"pickup_service_address": {
"anyOf": [
{
"type": "string",
"maxLength": 160,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Pickup Service Address",
"default": null,
"description": "A street address in Poland, e.g. Woronicza 17, Warszawa."
},
"return_service_address": {
"anyOf": [
{
"type": "string",
"maxLength": 160,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Return Service Address",
"default": null,
"description": "A street address in Poland, e.g. Woronicza 17, Warszawa."
},
"pickup_service_location": {
"anyOf": [
{
"type": "object",
"title": "ServiceLocation",
"required": [
"latitude",
"longitude",
"address"
],
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City",
"default": null
},
"address": {
"type": "string",
"title": "Address",
"maxLength": 500,
"minLength": 1
},
"latitude": {
"type": "number",
"title": "Latitude",
"maximum": 90,
"minimum": -90
},
"place_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Place Id",
"default": null
},
"longitude": {
"type": "number",
"title": "Longitude",
"maximum": 180,
"minimum": -180
},
"address_precise": {
"type": "boolean",
"title": "Address Precise",
"default": false
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
},
"pickup_service_place_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Pickup Service Place Id",
"default": null,
"description": "A place_id from earlier candidates."
},
"return_service_location": {
"anyOf": [
{
"type": "object",
"title": "ServiceLocation",
"required": [
"latitude",
"longitude",
"address"
],
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City",
"default": null
},
"address": {
"type": "string",
"title": "Address",
"maxLength": 500,
"minLength": 1
},
"latitude": {
"type": "number",
"title": "Latitude",
"maximum": 90,
"minimum": -90
},
"place_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Place Id",
"default": null
},
"longitude": {
"type": "number",
"title": "Longitude",
"maximum": 180,
"minimum": -180
},
"address_precise": {
"type": "boolean",
"title": "Address Precise",
"default": false
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
},
"return_service_place_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Return Service Place Id",
"default": null,
"description": "A place_id from earlier candidates."
},
"pickup_service_requested": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pickup Service Requested",
"default": null
},
"return_service_requested": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Return Service Requested",
"default": null
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
},
"offer_ref": {
"type": "string",
"title": "Offer Ref",
"maxLength": 128,
"minLength": 1
},
"search_id": {
"type": "string",
"title": "Search Id",
"maxLength": 64,
"minLength": 1
},
"response_format": {
"enum": [
"concise",
"detailed"
],
"type": "string",
"title": "Response Format",
"default": "detailed"
}
},
"additionalProperties": false
}get_offer output schema
{
"type": "object",
"title": "ToolResult",
"properties": {
"meta": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Meta",
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"default": null
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Field",
"default": null
},
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"offer": {
"anyOf": [
{
"type": "object",
"title": "OfferCard",
"required": [
"offer_ref",
"price"
],
"properties": {
"price": {
"type": "object",
"title": "OfferPrice",
"required": [
"includes_selected_options"
],
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_now": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"per_day": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"includes_selected_options": {
"type": "boolean",
"title": "Includes Selected Options"
}
}
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"default": null
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"offer_ref": {
"type": "string",
"title": "Offer Ref"
}
},
"additionalProperties": true
},
{
"type": "null"
}
],
"default": null
},
"driver": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Driver",
"default": null
},
"facets": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Facets",
"default": null
},
"offers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "OfferCard",
"required": [
"offer_ref",
"price"
],
"properties": {
"price": {
"type": "object",
"title": "OfferPrice",
"required": [
"includes_selected_options"
],
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_now": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"per_day": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"includes_selected_options": {
"type": "boolean",
"title": "Includes Selected Options"
}
}
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"default": null
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"offer_ref": {
"type": "string",
"title": "Offer Ref"
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Offers",
"default": null
},
"pickup": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Pickup",
"default": null
},
"points": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Points",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"city_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City Id",
"default": null
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"default": null
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"search_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search Id",
"default": null
},
"candidates": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Candidates",
"default": null
},
"categories": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Categories",
"default": null
},
"conditions": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Conditions",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"pagination": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Pagination",
"default": null
},
"valid_until": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Valid Until",
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"return_location": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Return Location",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
}
},
"description": "Common optional workflow fields; each handler has its own input schema."
}get_offer annotations
{
"title": "Read an offer and its conditions",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}get_city_prices — Read indicative city prices
Advertised read-only
Use for cached price examples before travel dates are chosen. These are dated examples, not live availability. Do not use for a binding quote. Examples: {"city":"Kraków"}; {"city":"wroclaw-krzyki","market":"en-pl"}.
get_city_prices input schema
{
"type": "object",
"title": "CityInput",
"required": [
"city"
],
"properties": {
"city": {
"type": "string",
"title": "City",
"maxLength": 160,
"minLength": 1
},
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
}
},
"additionalProperties": false
}get_city_prices output schema
{
"type": "object",
"title": "ToolResult",
"properties": {
"meta": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Meta",
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"default": null
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Field",
"default": null
},
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"offer": {
"anyOf": [
{
"type": "object",
"title": "OfferCard",
"required": [
"offer_ref",
"price"
],
"properties": {
"price": {
"type": "object",
"title": "OfferPrice",
"required": [
"includes_selected_options"
],
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_now": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"per_day": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"includes_selected_options": {
"type": "boolean",
"title": "Includes Selected Options"
}
}
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"default": null
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"offer_ref": {
"type": "string",
"title": "Offer Ref"
}
},
"additionalProperties": true
},
{
"type": "null"
}
],
"default": null
},
"driver": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Driver",
"default": null
},
"facets": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Facets",
"default": null
},
"offers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "OfferCard",
"required": [
"offer_ref",
"price"
],
"properties": {
"price": {
"type": "object",
"title": "OfferPrice",
"required": [
"includes_selected_options"
],
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_now": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"per_day": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"includes_selected_options": {
"type": "boolean",
"title": "Includes Selected Options"
}
}
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"default": null
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"offer_ref": {
"type": "string",
"title": "Offer Ref"
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Offers",
"default": null
},
"pickup": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Pickup",
"default": null
},
"points": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Points",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"city_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City Id",
"default": null
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"default": null
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"search_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search Id",
"default": null
},
"candidates": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Candidates",
"default": null
},
"categories": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Categories",
"default": null
},
"conditions": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Conditions",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"pagination": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Pagination",
"default": null
},
"valid_until": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Valid Until",
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"return_location": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Return Location",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
}
},
"description": "Common optional workflow fields; each handler has its own input schema."
}get_city_prices annotations
{
"title": "Read indicative city prices",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}find_pickup_points — Find nearby pickup points
Advertised read-only
Use to find physical pickup desks near a city or location. Reads the shared public snapshot. Do not treat a pickup point as a guarantee of car availability. Examples: {"city":"krakow","radius_m":10000}; {"near":{"lat":50.06,"lng":19.94},"limit":5}.
find_pickup_points input schema
{
"type": "object",
"title": "PickupPointsInput",
"properties": {
"city": {
"anyOf": [
{
"type": "string",
"maxLength": 160,
"minLength": 1
},
{
"type": "null"
}
],
"title": "City",
"default": null,
"description": "A city name. Required when near is omitted; do not supply both."
},
"near": {
"anyOf": [
{
"type": "object",
"title": "LocationInput",
"properties": {
"lat": {
"anyOf": [
{
"type": "number",
"maximum": 90,
"minimum": -90
},
{
"type": "null"
}
],
"title": "Lat",
"default": null
},
"lng": {
"anyOf": [
{
"type": "number",
"maximum": 180,
"minimum": -180
},
{
"type": "null"
}
],
"title": "Lng",
"default": null
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 160,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Query",
"default": null,
"description": "A place name or address, e.g. Kraków or Warsaw Chopin Airport."
},
"city_id": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 1
},
{
"type": "null"
}
],
"title": "City Id",
"default": null,
"description": "A city_id returned by get_city_prices or a clarification; for a city name use query."
},
"place_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Place Id",
"default": null,
"description": "A place_id from earlier candidates."
},
"pickup_point_id": {
"anyOf": [
{
"type": "string",
"maxLength": 64,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Pickup Point Id",
"default": null,
"description": "An id from find_pickup_points."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null,
"description": "Supply exactly one of near or city."
},
"limit": {
"type": "integer",
"title": "Limit",
"default": 10,
"maximum": 20,
"minimum": 1
},
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"radius_m": {
"type": "integer",
"title": "Radius M",
"default": 30000,
"maximum": 100000,
"minimum": 1
}
},
"additionalProperties": false
}find_pickup_points output schema
{
"type": "object",
"title": "ToolResult",
"properties": {
"meta": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Meta",
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"default": null
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Field",
"default": null
},
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"offer": {
"anyOf": [
{
"type": "object",
"title": "OfferCard",
"required": [
"offer_ref",
"price"
],
"properties": {
"price": {
"type": "object",
"title": "OfferPrice",
"required": [
"includes_selected_options"
],
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_now": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"per_day": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"includes_selected_options": {
"type": "boolean",
"title": "Includes Selected Options"
}
}
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"default": null
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"offer_ref": {
"type": "string",
"title": "Offer Ref"
}
},
"additionalProperties": true
},
{
"type": "null"
}
],
"default": null
},
"driver": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Driver",
"default": null
},
"facets": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Facets",
"default": null
},
"offers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "OfferCard",
"required": [
"offer_ref",
"price"
],
"properties": {
"price": {
"type": "object",
"title": "OfferPrice",
"required": [
"includes_selected_options"
],
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_now": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"per_day": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"includes_selected_options": {
"type": "boolean",
"title": "Includes Selected Options"
}
}
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"default": null
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"offer_ref": {
"type": "string",
"title": "Offer Ref"
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Offers",
"default": null
},
"pickup": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Pickup",
"default": null
},
"points": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Points",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"city_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City Id",
"default": null
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"default": null
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"search_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search Id",
"default": null
},
"candidates": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Candidates",
"default": null
},
"categories": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Categories",
"default": null
},
"conditions": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Conditions",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"pagination": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Pagination",
"default": null
},
"valid_until": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Valid Until",
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"return_location": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Return Location",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
}
},
"description": "Common optional workflow fields; each handler has its own input schema."
}find_pickup_points annotations
{
"title": "Find nearby pickup points",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}resolve_booking_link — Open a beep.rent offer link
Advertised read-only
Use when the user pastes a beep.rent link to one offer (from an e-mail, a campaign or a short beep.rent/r/ link). Returns search_id and offer_ref for get_offer, priced with the options the link advertised. Example: {"url": "https://beep.rent/pl-pl/wynajem-samochodu/?offer_car=...&pickup_parking=...&pickup_at=..."}.
resolve_booking_link input schema
{
"type": "object",
"title": "BookingLinkInput",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url",
"maxLength": 2048,
"minLength": 10,
"description": "The beep.rent link to one offer exactly as the user received it."
}
},
"additionalProperties": false
}resolve_booking_link output schema
{
"type": "object",
"title": "BookingLinkResult",
"properties": {
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"driver": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Driver",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"car_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Car Title",
"default": null
},
"offer_ref": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Offer Ref",
"default": null
},
"search_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search Id",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"search_state": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Search State",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
}
}
}resolve_booking_link annotations
{
"title": "Open a beep.rent offer link",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}create_checkout — Prepare a checkout
Use after get_offer when the user chose an offer: freezes the final price, deposit, options and policies and returns checkout_id and a beep.rent link (continue_url) where the user can finish. Resend every option you applied in get_offer. Does not book anything. Show the user the price, the deposit and the cancellation policy before calling this tool. Example: {"search_id":"from_search","offer_ref":"from_offer","options":{"damage_waiver":true}}.
create_checkout input schema
{
"type": "object",
"title": "CheckoutInput",
"required": [
"search_id",
"offer_ref"
],
"properties": {
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"options": {
"anyOf": [
{
"type": "object",
"title": "OfferOptions",
"properties": {
"extras": {
"type": "array",
"items": {
"type": "string"
},
"title": "Extras",
"maxItems": 30
},
"cleaning": {
"type": "boolean",
"title": "Cleaning",
"default": false
},
"card_type": {
"anyOf": [
{
"enum": [
"credit",
"debit"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Card Type",
"default": null
},
"driver_age": {
"anyOf": [
{
"type": "integer",
"maximum": 99,
"minimum": 18
},
{
"type": "null"
}
],
"title": "Driver Age",
"default": null
},
"child_seats": {
"type": "array",
"items": {
"type": "object",
"title": "ChildSeat",
"required": [
"weight_kg"
],
"properties": {
"quantity": {
"type": "integer",
"title": "Quantity",
"default": 1,
"maximum": 3,
"minimum": 1
},
"weight_kg": {
"type": "integer",
"title": "Weight Kg",
"maximum": 36,
"minimum": 1
}
},
"additionalProperties": false
},
"title": "Child Seats",
"maxItems": 3
},
"coupon_code": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Coupon Code",
"default": null
},
"fuel_prepaid": {
"type": "boolean",
"title": "Fuel Prepaid",
"default": false
},
"zero_deposit": {
"type": "boolean",
"title": "Zero Deposit",
"default": false
},
"damage_waiver": {
"type": "boolean",
"title": "Damage Waiver",
"default": false
},
"foreign_countries": {
"type": "array",
"items": {
"type": "string"
},
"title": "Foreign Countries",
"maxItems": 10,
"description": "ISO 3166-1 alpha-2 country codes, e.g. DE for Germany or CZ for Czechia."
},
"additional_drivers": {
"type": "integer",
"title": "Additional Drivers",
"default": 0,
"maximum": 3,
"minimum": 0
},
"license_tenure_months": {
"anyOf": [
{
"type": "integer",
"maximum": 1200,
"minimum": 0
},
{
"type": "null"
}
],
"title": "License Tenure Months",
"default": null
},
"pickup_service_address": {
"anyOf": [
{
"type": "string",
"maxLength": 160,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Pickup Service Address",
"default": null,
"description": "A street address in Poland, e.g. Woronicza 17, Warszawa."
},
"return_service_address": {
"anyOf": [
{
"type": "string",
"maxLength": 160,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Return Service Address",
"default": null,
"description": "A street address in Poland, e.g. Woronicza 17, Warszawa."
},
"pickup_service_location": {
"anyOf": [
{
"type": "object",
"title": "ServiceLocation",
"required": [
"latitude",
"longitude",
"address"
],
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City",
"default": null
},
"address": {
"type": "string",
"title": "Address",
"maxLength": 500,
"minLength": 1
},
"latitude": {
"type": "number",
"title": "Latitude",
"maximum": 90,
"minimum": -90
},
"place_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Place Id",
"default": null
},
"longitude": {
"type": "number",
"title": "Longitude",
"maximum": 180,
"minimum": -180
},
"address_precise": {
"type": "boolean",
"title": "Address Precise",
"default": false
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
},
"pickup_service_place_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Pickup Service Place Id",
"default": null,
"description": "A place_id from earlier candidates."
},
"return_service_location": {
"anyOf": [
{
"type": "object",
"title": "ServiceLocation",
"required": [
"latitude",
"longitude",
"address"
],
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City",
"default": null
},
"address": {
"type": "string",
"title": "Address",
"maxLength": 500,
"minLength": 1
},
"latitude": {
"type": "number",
"title": "Latitude",
"maximum": 90,
"minimum": -90
},
"place_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Place Id",
"default": null
},
"longitude": {
"type": "number",
"title": "Longitude",
"maximum": 180,
"minimum": -180
},
"address_precise": {
"type": "boolean",
"title": "Address Precise",
"default": false
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
},
"return_service_place_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Return Service Place Id",
"default": null,
"description": "A place_id from earlier candidates."
},
"pickup_service_requested": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pickup Service Requested",
"default": null
},
"return_service_requested": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Return Service Requested",
"default": null
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
},
"offer_ref": {
"type": "string",
"title": "Offer Ref",
"maxLength": 128,
"minLength": 1
},
"search_id": {
"type": "string",
"title": "Search Id",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
}create_checkout output schema
{
"type": "object",
"title": "CheckoutResult",
"properties": {
"trip": {
"anyOf": [
{
"type": "object",
"title": "Trip",
"properties": {
"timezone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Timezone",
"default": null
},
"pickup_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup At",
"default": null
},
"return_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return At",
"default": null
},
"pickup_location_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup Location Label",
"default": null
},
"return_location_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return Location Label",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Field",
"default": null
},
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"offer": {
"anyOf": [
{
"type": "object",
"title": "OfferCard",
"required": [
"offer_ref",
"price"
],
"properties": {
"price": {
"type": "object",
"title": "OfferPrice",
"required": [
"includes_selected_options"
],
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_now": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"per_day": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"includes_selected_options": {
"type": "boolean",
"title": "Includes Selected Options"
}
}
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"default": null
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"offer_ref": {
"type": "string",
"title": "Offer Ref"
}
},
"additionalProperties": true
},
{
"type": "null"
}
],
"default": null
},
"driver": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Driver",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"deposit": {
"anyOf": [
{
"type": "object",
"title": "Deposit",
"properties": {
"amount": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"own_share": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"card_requirement": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Card Requirement",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"payment": {
"anyOf": [
{
"type": "object",
"title": "PaymentTerms",
"properties": {
"confirmation_method": {
"anyOf": [
{
"enum": [
"code",
"payment"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Confirmation Method",
"default": null
},
"advance_payment_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Advance Payment Type",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"pricing": {
"anyOf": [
{
"type": "object",
"title": "Pricing",
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_now": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"line_items": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "LineItem",
"properties": {
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code",
"default": null
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Group",
"default": null
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Label",
"default": null
},
"amount": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
{
"type": "null"
}
],
"title": "Line Items",
"default": null
},
"rental_days": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rental Days",
"default": null
},
"rounded_down": {
"anyOf": [
{
"type": "object",
"title": "RoundedDown",
"required": [
"amount",
"note"
],
"properties": {
"note": {
"type": "string",
"title": "Note"
},
"amount": {
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"candidates": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Candidates",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"checkout_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Checkout Id",
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
},
"selected_options": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Selected Options",
"default": null
},
"consents_required": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Consent",
"required": [
"code",
"label"
],
"properties": {
"code": {
"enum": [
"terms",
"rental_terms",
"marketing"
],
"type": "string",
"title": "Code"
},
"label": {
"type": "string",
"title": "Label"
},
"required": {
"type": "boolean",
"title": "Required",
"default": true
},
"documents": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "ConsentDocument",
"required": [
"label"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"label": {
"type": "string",
"title": "Label"
}
}
}
},
{
"type": "null"
}
],
"title": "Documents",
"default": null
}
}
}
},
{
"type": "null"
}
],
"title": "Consents Required",
"default": null
},
"partner_confirmation": {
"anyOf": [
{
"type": "object",
"title": "PartnerConfirmation",
"properties": {
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type",
"default": null
},
"window_hours": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Window Hours",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"optional_customer_fields": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Optional Customer Fields",
"default": null
},
"required_customer_fields": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Required Customer Fields",
"default": null
}
}
}create_checkout annotations
{
"title": "Prepare a checkout",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}create_reservation — Book the reservation
Advertised destructiveOpen-world
Use only after the user explicitly asked to book and, asked in one question of its own, accepted the terms and the privacy policy and answered about marketing messages (a yes to the booking is not a yes to the terms): creates the reservation from checkout_id with the driver's details. The booking is not confirmed until the user enters the code sent to them (confirm_reservation_code) or pays on beep.rent. Calling again with the same checkout returns the same reservation. Show the user the price, the deposit and the cancellation policy before calling this tool. Example: {"checkout_id":"from_checkout","customer":{"first_name":"Anna","last_name":"Nowak","email":"anna@example.com","phone":"+48500600700"},"consents":{"terms":true,"rental_terms":true,"marketing":false}}.
create_reservation input schema
{
"type": "object",
"title": "ReservationInput",
"required": [
"checkout_id",
"customer",
"consents"
],
"properties": {
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"comment": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
],
"title": "Comment",
"default": null
},
"invoice": {
"anyOf": [
{
"type": "object",
"title": "Invoice",
"required": [
"buyer_name",
"buyer_tax_id",
"buyer_street",
"buyer_city",
"buyer_zip_code"
],
"properties": {
"buyer_city": {
"type": "string",
"title": "Buyer City",
"maxLength": 64,
"minLength": 1
},
"buyer_name": {
"type": "string",
"title": "Buyer Name",
"maxLength": 128,
"minLength": 1
},
"buyer_street": {
"type": "string",
"title": "Buyer Street",
"maxLength": 128,
"minLength": 1
},
"buyer_tax_id": {
"type": "string",
"title": "Buyer Tax Id",
"maxLength": 16,
"minLength": 10,
"description": "Polish NIP of the buyer."
},
"buyer_zip_code": {
"type": "string",
"title": "Buyer Zip Code",
"pattern": "^\\d{2}-\\d{3}$"
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
},
"consents": {
"type": "object",
"title": "Consents",
"required": [
"terms",
"rental_terms",
"marketing"
],
"properties": {
"terms": {
"type": "boolean",
"title": "Terms",
"description": "The user accepted the BEEP.rent terms of service and privacy policy."
},
"marketing": {
"type": "boolean",
"title": "Marketing",
"description": "True only after an explicit yes to marketing messages (promotions and discount codes)."
},
"rental_terms": {
"type": "boolean",
"title": "Rental Terms",
"description": "The user accepted the rental company's general terms of rental."
}
},
"additionalProperties": false
},
"customer": {
"type": "object",
"title": "Customer",
"required": [
"first_name",
"last_name",
"email",
"phone"
],
"properties": {
"email": {
"type": "string",
"title": "Email",
"maxLength": 254,
"minLength": 3
},
"phone": {
"type": "string",
"title": "Phone",
"maxLength": 20,
"minLength": 7,
"description": "E.164 with the country code, for example +48500600700."
},
"last_name": {
"type": "string",
"title": "Last Name",
"maxLength": 64,
"minLength": 1
},
"first_name": {
"type": "string",
"title": "First Name",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"checkout_id": {
"type": "string",
"title": "Checkout Id",
"maxLength": 64,
"minLength": 1
},
"accept_changes": {
"type": "boolean",
"title": "Accept Changes",
"default": false,
"description": "Set only after the user accepted the changed terms returned with status requires_review."
}
},
"additionalProperties": false
}create_reservation output schema
{
"type": "object",
"title": "ReservationResult",
"properties": {
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"changes": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "ChangedTerm",
"required": [
"term"
],
"properties": {
"term": {
"type": "string",
"title": "Term"
},
"after": {
"title": "After",
"default": null
},
"before": {
"title": "Before",
"default": null
}
},
"description": "``requires_review``: one term the user sees, at the checkout (before) and now (after)."
}
},
{
"type": "null"
}
],
"title": "Changes",
"default": null
},
"deposit": {
"anyOf": [
{
"type": "object",
"title": "Deposit",
"properties": {
"amount": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"own_share": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"card_requirement": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Card Requirement",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"payment": {
"anyOf": [
{
"type": "object",
"title": "PaymentState",
"properties": {
"paid": {
"type": "boolean",
"title": "Paid",
"default": false
},
"required": {
"type": "boolean",
"title": "Required",
"default": false
},
"amount_due": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"payment_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment Url",
"default": null
},
"amount_due_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"pricing": {
"anyOf": [
{
"type": "object",
"title": "Pricing",
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_now": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"line_items": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "LineItem",
"properties": {
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code",
"default": null
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Group",
"default": null
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Label",
"default": null
},
"amount": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
{
"type": "null"
}
],
"title": "Line Items",
"default": null
},
"rental_days": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rental Days",
"default": null
},
"rounded_down": {
"anyOf": [
{
"type": "object",
"title": "RoundedDown",
"required": [
"amount",
"note"
],
"properties": {
"note": {
"type": "string",
"title": "Note"
},
"amount": {
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
}
}
},
{
"type": "null"
}
],
"default": null
},
"pay_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"replayed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Replayed",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"reservation": {
"anyOf": [
{
"type": "object",
"title": "ReservationSummary",
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"car_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Car Title",
"default": null
},
"pickup_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup At",
"default": null
},
"return_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return At",
"default": null
},
"pickup_location_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup Location Label",
"default": null
},
"return_location_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return Location Label",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"capabilities": {
"anyOf": [
{
"type": "object",
"title": "Capabilities",
"properties": {
"can_cancel": {
"type": "boolean",
"title": "Can Cancel",
"default": false
},
"can_extend": {
"type": "boolean",
"title": "Can Extend",
"default": false
},
"not_extendable_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Not Extendable Reason",
"default": null
},
"not_cancellable_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Not Cancellable Reason",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"confirmation": {
"anyOf": [
{
"type": "object",
"title": "Confirmation",
"properties": {
"method": {
"anyOf": [
{
"enum": [
"code",
"payment"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Method",
"default": null
},
"channel": {
"anyOf": [
{
"enum": [
"sms",
"email"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Channel",
"default": null
},
"payment_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment Url",
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"code_expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code Expires At",
"default": null
},
"destination_masked": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Destination Masked",
"default": null
},
"resend_available_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Resend Available At",
"default": null
},
"cancelled_if_unconfirmed_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cancelled If Unconfirmed At",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"status_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status Token",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
},
"partner_decision": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Partner Decision",
"default": null
},
"reservation_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reservation Number",
"default": null
},
"partner_confirmation": {
"anyOf": [
{
"type": "object",
"title": "PartnerConfirmation",
"properties": {
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type",
"default": null
},
"window_hours": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Window Hours",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}create_reservation annotations
{
"title": "Book the reservation",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}request_confirmation_code — Send the confirmation code again
Open-world
Use when the user did not receive the 6-digit code for a new reservation or it expired. Sends a new code to the contact given at booking; do not call it unprompted. Example: {"reservation_number":"AB12CD34","status_token":"from_reservation"}.
request_confirmation_code input schema
{
"type": "object",
"title": "ReservationTokenInput",
"required": [
"reservation_number",
"status_token"
],
"properties": {
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"status_token": {
"type": "string",
"title": "Status Token",
"maxLength": 512,
"minLength": 16
},
"reservation_number": {
"type": "string",
"title": "Reservation Number",
"pattern": "^\\s*[A-Za-z0-9]+\\s*$",
"maxLength": 16,
"minLength": 1
}
},
"additionalProperties": false
}request_confirmation_code output schema
{
"type": "object",
"title": "ReservationStatusResult",
"properties": {
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"payment": {
"anyOf": [
{
"type": "object",
"title": "PaymentState",
"properties": {
"paid": {
"type": "boolean",
"title": "Paid",
"default": false
},
"required": {
"type": "boolean",
"title": "Required",
"default": false
},
"amount_due": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"payment_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment Url",
"default": null
},
"amount_due_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"reservation": {
"anyOf": [
{
"type": "object",
"title": "ReservationSummary",
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"car_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Car Title",
"default": null
},
"pickup_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup At",
"default": null
},
"return_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return At",
"default": null
},
"pickup_location_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup Location Label",
"default": null
},
"return_location_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return Location Label",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"capabilities": {
"anyOf": [
{
"type": "object",
"title": "Capabilities",
"properties": {
"can_cancel": {
"type": "boolean",
"title": "Can Cancel",
"default": false
},
"can_extend": {
"type": "boolean",
"title": "Can Extend",
"default": false
},
"not_extendable_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Not Extendable Reason",
"default": null
},
"not_cancellable_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Not Cancellable Reason",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"confirmation": {
"anyOf": [
{
"type": "object",
"title": "Confirmation",
"properties": {
"method": {
"anyOf": [
{
"enum": [
"code",
"payment"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Method",
"default": null
},
"channel": {
"anyOf": [
{
"enum": [
"sms",
"email"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Channel",
"default": null
},
"payment_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment Url",
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"code_expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code Expires At",
"default": null
},
"destination_masked": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Destination Masked",
"default": null
},
"resend_available_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Resend Available At",
"default": null
},
"cancelled_if_unconfirmed_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cancelled If Unconfirmed At",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"has_recovery": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Has Recovery",
"default": null
},
"recovery_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Recovery Url",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
},
"partner_decision": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Partner Decision",
"default": null
},
"reservation_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reservation Number",
"default": null
},
"partner_confirmation": {
"anyOf": [
{
"type": "object",
"title": "PartnerConfirmation",
"properties": {
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type",
"default": null
},
"window_hours": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Window Hours",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}request_confirmation_code annotations
{
"title": "Send the confirmation code again",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}confirm_reservation_code — Confirm a reservation with the user's code
Open-world
Use when the user gives you the 6-digit code they received for a new reservation. Never guess or invent a code. Returns the reservation status: the rental company may still have to accept it. Example: {"reservation_number":"AB12CD34","status_token":"from_reservation","code":"123456"}.
confirm_reservation_code input schema
{
"type": "object",
"title": "ConfirmCodeInput",
"required": [
"reservation_number",
"status_token",
"code"
],
"properties": {
"code": {
"type": "string",
"title": "Code",
"pattern": "^\\d{6}$",
"description": "The 6-digit code the user received."
},
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"status_token": {
"type": "string",
"title": "Status Token",
"maxLength": 512,
"minLength": 16
},
"reservation_number": {
"type": "string",
"title": "Reservation Number",
"pattern": "^\\s*[A-Za-z0-9]+\\s*$",
"maxLength": 16,
"minLength": 1
}
},
"additionalProperties": false
}confirm_reservation_code output schema
{
"type": "object",
"title": "ReservationStatusResult",
"properties": {
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"payment": {
"anyOf": [
{
"type": "object",
"title": "PaymentState",
"properties": {
"paid": {
"type": "boolean",
"title": "Paid",
"default": false
},
"required": {
"type": "boolean",
"title": "Required",
"default": false
},
"amount_due": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"payment_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment Url",
"default": null
},
"amount_due_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"reservation": {
"anyOf": [
{
"type": "object",
"title": "ReservationSummary",
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"car_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Car Title",
"default": null
},
"pickup_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup At",
"default": null
},
"return_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return At",
"default": null
},
"pickup_location_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup Location Label",
"default": null
},
"return_location_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return Location Label",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"capabilities": {
"anyOf": [
{
"type": "object",
"title": "Capabilities",
"properties": {
"can_cancel": {
"type": "boolean",
"title": "Can Cancel",
"default": false
},
"can_extend": {
"type": "boolean",
"title": "Can Extend",
"default": false
},
"not_extendable_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Not Extendable Reason",
"default": null
},
"not_cancellable_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Not Cancellable Reason",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"confirmation": {
"anyOf": [
{
"type": "object",
"title": "Confirmation",
"properties": {
"method": {
"anyOf": [
{
"enum": [
"code",
"payment"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Method",
"default": null
},
"channel": {
"anyOf": [
{
"enum": [
"sms",
"email"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Channel",
"default": null
},
"payment_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment Url",
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"code_expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code Expires At",
"default": null
},
"destination_masked": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Destination Masked",
"default": null
},
"resend_available_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Resend Available At",
"default": null
},
"cancelled_if_unconfirmed_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cancelled If Unconfirmed At",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"has_recovery": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Has Recovery",
"default": null
},
"recovery_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Recovery Url",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
},
"partner_decision": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Partner Decision",
"default": null
},
"reservation_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reservation Number",
"default": null
},
"partner_confirmation": {
"anyOf": [
{
"type": "object",
"title": "PartnerConfirmation",
"properties": {
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type",
"default": null
},
"window_hours": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Window Hours",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}confirm_reservation_code annotations
{
"title": "Confirm a reservation with the user's code",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}get_reservation_status — Read a reservation's status
Advertised read-only
Use to check whether a reservation is confirmed, awaits the user's code or payment, or awaits the rental company. Identify it with status_token from create_reservation, with the e-mail used for booking, with the management_id of the user's e-mail, or by its number alone when the user's BEEP.rent account is connected. Never say a reservation is confirmed unless this returns status confirmed. Examples: {"reservation_number":"AB12CD34","status_token":"from_reservation"}; {"reservation_number":"AB12CD34","email":"anna@example.com"}.
get_reservation_status input schema
{
"type": "object",
"title": "StatusInput",
"required": [
"reservation_number"
],
"properties": {
"email": {
"anyOf": [
{
"type": "string",
"maxLength": 254,
"minLength": 3
},
{
"type": "null"
}
],
"title": "Email",
"default": null
},
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"status_token": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 16
},
{
"type": "null"
}
],
"title": "Status Token",
"default": null
},
"management_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 16
},
{
"type": "null"
}
],
"title": "Management Id",
"default": null,
"description": "From verify_reservation_management for the user's e-mail."
},
"reservation_number": {
"type": "string",
"title": "Reservation Number",
"pattern": "^\\s*[A-Za-z0-9]+\\s*$",
"maxLength": 16,
"minLength": 1
}
},
"additionalProperties": false
}get_reservation_status output schema
{
"type": "object",
"title": "ReservationStatusResult",
"properties": {
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"payment": {
"anyOf": [
{
"type": "object",
"title": "PaymentState",
"properties": {
"paid": {
"type": "boolean",
"title": "Paid",
"default": false
},
"required": {
"type": "boolean",
"title": "Required",
"default": false
},
"amount_due": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"payment_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment Url",
"default": null
},
"amount_due_at_pickup": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"reservation": {
"anyOf": [
{
"type": "object",
"title": "ReservationSummary",
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"car_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Car Title",
"default": null
},
"pickup_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup At",
"default": null
},
"return_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return At",
"default": null
},
"pickup_location_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup Location Label",
"default": null
},
"return_location_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return Location Label",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"capabilities": {
"anyOf": [
{
"type": "object",
"title": "Capabilities",
"properties": {
"can_cancel": {
"type": "boolean",
"title": "Can Cancel",
"default": false
},
"can_extend": {
"type": "boolean",
"title": "Can Extend",
"default": false
},
"not_extendable_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Not Extendable Reason",
"default": null
},
"not_cancellable_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Not Cancellable Reason",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"confirmation": {
"anyOf": [
{
"type": "object",
"title": "Confirmation",
"properties": {
"method": {
"anyOf": [
{
"enum": [
"code",
"payment"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Method",
"default": null
},
"channel": {
"anyOf": [
{
"enum": [
"sms",
"email"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Channel",
"default": null
},
"payment_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment Url",
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"code_expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code Expires At",
"default": null
},
"destination_masked": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Destination Masked",
"default": null
},
"resend_available_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Resend Available At",
"default": null
},
"cancelled_if_unconfirmed_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cancelled If Unconfirmed At",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"has_recovery": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Has Recovery",
"default": null
},
"recovery_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Recovery Url",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
},
"partner_decision": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Partner Decision",
"default": null
},
"reservation_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reservation Number",
"default": null
},
"partner_confirmation": {
"anyOf": [
{
"type": "object",
"title": "PartnerConfirmation",
"properties": {
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type",
"default": null
},
"window_hours": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Window Hours",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}get_reservation_status annotations
{
"title": "Read a reservation's status",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}list_my_reservations — List my reservations
Advertised read-only
Use when the user asks about their own BEEP.rent bookings. Lists the reservations of the e-mail the user verified with start_reservation_management (pass its management_id) or of the BEEP.rent account they connected: upcoming ones with the next pickup first, or with include_past the last 365 days, newest first. Each has its number, status, dates, pickup place, car and total. Example: {"management_id": "from_verify", "limit": 5}.
list_my_reservations input schema
{
"type": "object",
"title": "MyReservationsInput",
"properties": {
"limit": {
"type": "integer",
"title": "Limit",
"default": 10,
"maximum": 20,
"minimum": 1,
"description": "How many reservations to return."
},
"offset": {
"type": "integer",
"title": "Offset",
"default": 0,
"maximum": 1000,
"minimum": 0
},
"include_past": {
"type": "boolean",
"title": "Include Past",
"default": false,
"description": "Also list rentals that ended or were cancelled in the last 365 days."
},
"management_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 16
},
{
"type": "null"
}
],
"title": "Management Id",
"default": null,
"description": "From verify_reservation_management for the user's e-mail."
}
},
"additionalProperties": false
}list_my_reservations output schema
{
"type": "object",
"title": "ReservationListResult",
"properties": {
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"pagination": {
"anyOf": [
{
"type": "object",
"title": "ListPage",
"required": [
"offset",
"limit",
"has_more"
],
"properties": {
"limit": {
"type": "integer",
"title": "Limit"
},
"offset": {
"type": "integer",
"title": "Offset"
},
"has_more": {
"type": "boolean",
"title": "Has More"
}
}
},
{
"type": "null"
}
],
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"reservations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "ReservationListItem",
"required": [
"reservation_number",
"status"
],
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"status": {
"type": "string",
"title": "Status"
},
"car_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Car Title",
"default": null
},
"pickup_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup At",
"default": null
},
"return_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return At",
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"reservation_number": {
"type": "string",
"title": "Reservation Number"
},
"pickup_location_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup Location Label",
"default": null
}
}
}
},
{
"type": "null"
}
],
"title": "Reservations",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
}
}
}list_my_reservations annotations
{
"title": "List my reservations",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}start_reservation_management — Start managing reservations
Open-world
Use when the user wants to see, cancel or extend their reservations: e-mails a 6-digit code to the booking's e-mail address and returns management_id. With the reservation number the code unlocks that reservation; without it, every reservation of that e-mail. Examples: {"reservation_number":"AB12CD34","email":"anna@example.com"}; {"email":"anna@example.com"}.
start_reservation_management input schema
{
"type": "object",
"title": "ManagementStartInput",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"title": "Email",
"maxLength": 254,
"minLength": 3
},
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"reservation_number": {
"anyOf": [
{
"type": "string",
"pattern": "^\\s*[A-Za-z0-9]+\\s*$",
"maxLength": 16,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Reservation Number",
"default": null
}
},
"additionalProperties": false
}start_reservation_management output schema
{
"type": "object",
"title": "ManagementStartResult",
"properties": {
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"management_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Management Id",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
},
"code_expires_in_minutes": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Code Expires In Minutes",
"default": null
}
}
}start_reservation_management annotations
{
"title": "Start managing reservations",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}verify_reservation_management — Verify the management code
Use with the 6-digit code from the management e-mail: unlocks the reservation's summary and its cancellation and extension options or, for a code sent for an e-mail alone, that e-mail's reservations, for this conversation (2 hours). Go on with the management_id it returns. Never guess a code. Example: {"management_id":"from_start","code":"123456"}.
verify_reservation_management input schema
{
"type": "object",
"title": "ManagementVerifyInput",
"required": [
"management_id",
"code"
],
"properties": {
"code": {
"type": "string",
"title": "Code",
"pattern": "^\\d{6}$",
"description": "The 6-digit code the user received."
},
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"management_id": {
"type": "string",
"title": "Management Id",
"maxLength": 512,
"minLength": 16
}
},
"additionalProperties": false
}verify_reservation_management output schema
{
"type": "object",
"title": "ManagementSummaryResult",
"properties": {
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"reservation": {
"anyOf": [
{
"type": "object",
"title": "ManagedReservation",
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"default": null
},
"car_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Car Title",
"default": null
},
"pickup_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup At",
"default": null
},
"return_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return At",
"default": null
},
"reservation_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reservation Number",
"default": null
},
"pickup_location_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup Location Label",
"default": null
},
"return_location_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return Location Label",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"capabilities": {
"anyOf": [
{
"type": "object",
"title": "Capabilities",
"properties": {
"can_cancel": {
"type": "boolean",
"title": "Can Cancel",
"default": false
},
"can_extend": {
"type": "boolean",
"title": "Can Extend",
"default": false
},
"not_extendable_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Not Extendable Reason",
"default": null
},
"not_cancellable_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Not Cancellable Reason",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"reservations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "ReservationListItem",
"required": [
"reservation_number",
"status"
],
"properties": {
"total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"status": {
"type": "string",
"title": "Status"
},
"car_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Car Title",
"default": null
},
"pickup_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup At",
"default": null
},
"return_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Return At",
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"reservation_number": {
"type": "string",
"title": "Reservation Number"
},
"pickup_location_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pickup Location Label",
"default": null
}
}
}
},
{
"type": "null"
}
],
"title": "Reservations",
"default": null
},
"management_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Management Id",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
}
}
}verify_reservation_management annotations
{
"title": "Verify the management code",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}cancel_reservation — Cancel a reservation
Advertised destructiveOpen-world
Use when the user asks to cancel: after verify_reservation_management, with its management_id (and the reservation_number when the code was sent for the user's e-mail), or with the reservation_number when the user's BEEP.rent account is connected. First call without confirm: it returns the refund and a confirmation_token and cancels nothing. Show the refund, get the user's explicit yes, then call again with confirm=true and that token. Cancellation is irreversible. Example: {"management_id":"from_verify","confirm":true,"confirmation_token":"from_preview"}.
cancel_reservation input schema
{
"type": "object",
"title": "CancelInput",
"properties": {
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"confirm": {
"type": "boolean",
"title": "Confirm",
"default": false,
"description": "false previews; true executes the previewed operation."
},
"management_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 16
},
{
"type": "null"
}
],
"title": "Management Id",
"default": null,
"description": "From verify_reservation_management."
},
"confirmation_token": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 16
},
{
"type": "null"
}
],
"title": "Confirmation Token",
"default": null
},
"reservation_number": {
"anyOf": [
{
"type": "string",
"pattern": "^\\s*[A-Za-z0-9]+\\s*$",
"maxLength": 16,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Reservation Number",
"default": null,
"description": "The number of one of the user's own reservations."
}
},
"additionalProperties": false
}cancel_reservation output schema
{
"type": "object",
"title": "CancelResult",
"properties": {
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"default": null
},
"refund": {
"anyOf": [
{
"type": "object",
"title": "Refund",
"required": [
"policy"
],
"properties": {
"rule": {
"type": "string",
"title": "Rule",
"default": ""
},
"amount": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"policy": {
"enum": [
"full",
"none"
],
"type": "string",
"title": "Policy"
}
}
},
{
"type": "null"
}
],
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"replayed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Replayed",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"consequences": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Consequences",
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
},
"confirmation_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Confirmation Token",
"default": null
},
"reservation_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reservation Number",
"default": null
}
}
}cancel_reservation annotations
{
"title": "Cancel a reservation",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}quote_extension — Price a longer rental
Advertised read-onlyOpen-world
Use when the user wants to return the car later, after verify_reservation_management, with its management_id (and the reservation_number when the code was sent for the user's e-mail), or with the reservation_number when the user's BEEP.rent account is connected: prices the extra days. Only a rental in progress can be extended. Changes nothing. Example: {"management_id":"from_verify","new_return_at":"2026-12-10T10:00:00+01:00"}.
quote_extension input schema
{
"type": "object",
"title": "ExtensionQuoteInput",
"required": [
"new_return_at"
],
"properties": {
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"management_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 16
},
{
"type": "null"
}
],
"title": "Management Id",
"default": null,
"description": "From verify_reservation_management."
},
"new_return_at": {
"type": "string",
"title": "New Return At"
},
"reservation_number": {
"anyOf": [
{
"type": "string",
"pattern": "^\\s*[A-Za-z0-9]+\\s*$",
"maxLength": 16,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Reservation Number",
"default": null,
"description": "The number of one of the user's own reservations."
}
},
"additionalProperties": false
}quote_extension output schema
{
"type": "object",
"title": "ExtensionQuoteResult",
"properties": {
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"quote": {
"anyOf": [
{
"type": "object",
"title": "ExtensionQuote",
"properties": {
"daily_rate": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"extra_days": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Extra Days",
"default": null
},
"new_return_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "New Return At",
"default": null
},
"estimated_total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"current_return_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Current Return At",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"decision": {
"anyOf": [
{
"enum": [
"partner_reply_by_email",
"partner_contacts_user"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Decision",
"default": null
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"extendable": {
"type": "boolean",
"title": "Extendable",
"default": false
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
},
"reservation_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reservation Number",
"default": null
}
}
}quote_extension annotations
{
"title": "Price a longer rental",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}request_extension — Request a rental extension
Advertised destructiveOpen-world
Use after quote_extension when the user asked to extend. First call without confirm previews the request and returns confirmation_token; after the user's explicit yes call again with confirm=true, the token and the same new_return_at. The rental company decides; decision says how the user hears back. Example: {"management_id":"from_verify","new_return_at":"2026-12-10T10:00:00+01:00","confirm":true,"confirmation_token":"from_preview"}.
request_extension input schema
{
"type": "object",
"title": "ExtensionRequestInput",
"required": [
"new_return_at"
],
"properties": {
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"confirm": {
"type": "boolean",
"title": "Confirm",
"default": false,
"description": "false previews; true executes the previewed operation."
},
"management_id": {
"anyOf": [
{
"type": "string",
"maxLength": 512,
"minLength": 16
},
{
"type": "null"
}
],
"title": "Management Id",
"default": null,
"description": "From verify_reservation_management."
},
"new_return_at": {
"type": "string",
"title": "New Return At"
},
"confirmation_token": {
"anyOf": [
{
"type": "string",
"maxLength": 128,
"minLength": 16
},
{
"type": "null"
}
],
"title": "Confirmation Token",
"default": null
},
"reservation_number": {
"anyOf": [
{
"type": "string",
"pattern": "^\\s*[A-Za-z0-9]+\\s*$",
"maxLength": 16,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Reservation Number",
"default": null,
"description": "The number of one of the user's own reservations."
}
},
"additionalProperties": false
}request_extension output schema
{
"type": "object",
"title": "ExtensionRequestResult",
"properties": {
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"quote": {
"anyOf": [
{
"type": "object",
"title": "ExtensionQuote",
"properties": {
"daily_rate": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"extra_days": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Extra Days",
"default": null
},
"new_return_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "New Return At",
"default": null
},
"estimated_total": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"current_return_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Current Return At",
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"decision": {
"anyOf": [
{
"enum": [
"partner_reply_by_email",
"partner_contacts_user"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Decision",
"default": null
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"replayed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Replayed",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"extendable": {
"type": "boolean",
"title": "Extendable",
"default": false
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"request_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Request Id",
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
},
"confirmation_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Confirmation Token",
"default": null
},
"reservation_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reservation Number",
"default": null
}
}
}request_extension annotations
{
"title": "Request a rental extension",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}search_long_term_offers — Search long-term rental offers
Advertised read-only
Use for a car rented for months or years (1 month renewed monthly to 3 years): monthly prices in PLN per mileage package, excluding VAT for businesses or including VAT for private customers, with the inquiry link of each package. Not for trips with dates: use search_offers. Filters take facets values; facets list them. Examples: {"rent_length":"year2","customer_type":"individual"}; {"brand":"Audi","monthly_cost_max":5000}.
search_long_term_offers input schema
{
"type": "object",
"title": "LongTermSearchInput",
"properties": {
"body": {
"anyOf": [
{
"type": "string",
"maxLength": 64,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Body",
"default": null,
"description": "A value or label from facets.body."
},
"fuel": {
"anyOf": [
{
"type": "string",
"maxLength": 64,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Fuel",
"default": null,
"description": "A value or label from facets.fuel."
},
"brand": {
"anyOf": [
{
"type": "string",
"maxLength": 64,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Brand",
"default": null,
"description": "A brand from facets.brand, e.g. Audi."
},
"limit": {
"type": "integer",
"title": "Limit",
"default": 9,
"maximum": 36,
"minimum": 1
},
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"offset": {
"type": "integer",
"title": "Offset",
"default": 0,
"maximum": 10000,
"minimum": 0
},
"ordering": {
"anyOf": [
{
"enum": [
"price",
"-price",
"production_year",
"-production_year"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Ordering",
"default": null
},
"rent_length": {
"enum": [
"flex",
"month3",
"month6",
"year1",
"year2",
"year3"
],
"type": "string",
"title": "Rent Length",
"default": "year1",
"description": "flex = 1 month, renewed monthly; month3, month6; year1, year2, year3."
},
"transmission": {
"anyOf": [
{
"enum": [
"MANUAL",
"AUTOMATIC"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Transmission",
"default": null
},
"customer_type": {
"enum": [
"business",
"individual"
],
"type": "string",
"title": "Customer Type",
"default": "business",
"description": "business: prices excluding VAT; individual: including VAT."
},
"monthly_cost_max": {
"anyOf": [
{
"type": "integer",
"maximum": 10000000,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Monthly Cost Max",
"default": null,
"description": "PLN per month, in the customer_type's unit (gross for individual)."
},
"monthly_cost_min": {
"anyOf": [
{
"type": "integer",
"maximum": 10000000,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Monthly Cost Min",
"default": null,
"description": "PLN per month, in the customer_type's unit (gross for individual)."
},
"production_year_max": {
"anyOf": [
{
"type": "integer",
"maximum": 2100,
"minimum": 1900
},
{
"type": "null"
}
],
"title": "Production Year Max",
"default": null
},
"production_year_min": {
"anyOf": [
{
"type": "integer",
"maximum": 2100,
"minimum": 1900
},
{
"type": "null"
}
],
"title": "Production Year Min",
"default": null
}
},
"additionalProperties": false
}search_long_term_offers output schema
{
"type": "object",
"title": "LongTermOffersResult",
"properties": {
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"facets": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Facets",
"default": null
},
"offers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "LongTermOffer",
"required": [
"car_id",
"model",
"individual_pricing",
"inquiry_url"
],
"properties": {
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body",
"default": null
},
"fuel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fuel",
"default": null
},
"brand": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Brand",
"default": null
},
"model": {
"type": "string",
"title": "Model"
},
"car_id": {
"type": "string",
"title": "Car Id"
},
"packages": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "LongTermPackage",
"required": [
"mileage_limit",
"mileage_period",
"monthly_price",
"inquiry_url"
],
"properties": {
"inquiry_url": {
"type": "string",
"title": "Inquiry Url"
},
"mileage_limit": {
"type": "integer",
"title": "Mileage Limit"
},
"monthly_price": {
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
"mileage_period": {
"type": "string",
"title": "Mileage Period"
}
}
}
},
{
"type": "null"
}
],
"title": "Packages",
"default": null
},
"image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image Url",
"default": null
},
"body_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body Label",
"default": null
},
"fuel_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fuel Label",
"default": null
},
"inquiry_url": {
"type": "string",
"title": "Inquiry Url"
},
"transmission": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Transmission",
"default": null
},
"production_year": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Production Year",
"default": null
},
"individual_pricing": {
"type": "boolean",
"title": "Individual Pricing"
},
"transmission_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Transmission Label",
"default": null
}
}
}
},
{
"type": "null"
}
],
"title": "Offers",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"page_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Page Url",
"default": null
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"pagination": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Pagination",
"default": null
},
"price_basis": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Price Basis",
"default": null
},
"rent_length": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Rent Length",
"default": null
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"customer_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Type",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
}
}
}search_long_term_offers annotations
{
"title": "Search long-term rental offers",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}request_long_term_offer — Ask about a long-term offer
Open-world
Use when the person wants one long-term package. By default returns use_web_form and continue_url without customer or consents: give the person the form and do not collect contact details. If direct inquiries are enabled, ask for privacy policy and marketing consent before submitting contact details. The office then contacts the person; this is not a booking. Example: {"car_id":"<car_id>","rent_length":"year1","mileage_limit":36000,"customer_type":"business","customer":{"first_name":"Anna","last_name":"Nowak","email":"anna@example.com","phone":"+48500600700"},"consents":{"privacy_policy":true,"marketing":false}}.
request_long_term_offer input schema
{
"type": "object",
"title": "LongTermInquiryInput",
"required": [
"car_id",
"rent_length"
],
"properties": {
"car_id": {
"type": "string",
"title": "Car Id",
"description": "An offer's car_id from search_long_term_offers."
},
"market": {
"anyOf": [
{
"enum": [
"pl-pl",
"en-pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Market",
"default": null
},
"consents": {
"anyOf": [
{
"type": "object",
"title": "LongTermConsents",
"required": [
"privacy_policy",
"marketing"
],
"properties": {
"marketing": {
"type": "boolean",
"title": "Marketing",
"description": "True only after an explicit yes to marketing messages."
},
"privacy_policy": {
"type": "boolean",
"title": "Privacy Policy",
"description": "The person accepted BEEP.rent's privacy policy (links: privacy_policy)."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null,
"description": "Required only for direct submission after asking the person."
},
"customer": {
"anyOf": [
{
"type": "object",
"title": "LongTermCustomer",
"required": [
"first_name",
"last_name",
"email",
"phone"
],
"properties": {
"email": {
"type": "string",
"title": "Email",
"maxLength": 254,
"minLength": 3
},
"phone": {
"type": "string",
"title": "Phone",
"maxLength": 20,
"minLength": 7,
"description": "E.164 with the country code, for example +48500600700."
},
"last_name": {
"type": "string",
"title": "Last Name",
"maxLength": 150,
"minLength": 1
},
"first_name": {
"type": "string",
"title": "First Name",
"maxLength": 150,
"minLength": 1
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null,
"description": "Required only for direct submission, never for a web handoff."
},
"rent_length": {
"enum": [
"flex",
"month3",
"month6",
"year1",
"year2",
"year3"
],
"type": "string",
"title": "Rent Length"
},
"customer_type": {
"enum": [
"business",
"individual"
],
"type": "string",
"title": "Customer Type",
"default": "business"
},
"mileage_limit": {
"anyOf": [
{
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Mileage Limit",
"default": null,
"description": "A package's mileage_limit from the offer; null when it is individually priced."
}
},
"additionalProperties": false
}request_long_term_offer output schema
{
"type": "object",
"title": "LongTermInquiryResult",
"properties": {
"links": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Link",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"type": {
"enum": [
"terms_of_service",
"privacy_policy",
"agent_channel_privacy",
"rental_terms",
"faq",
"support",
"handoff"
],
"type": "string",
"title": "Type"
}
}
}
},
{
"type": "null"
}
],
"title": "Links",
"default": null
},
"status": {
"type": "string",
"title": "Status",
"default": "ok"
},
"inquiry": {
"anyOf": [
{
"type": "object",
"title": "LongTermInquirySummary",
"required": [
"car_id",
"model",
"rent_length",
"customer_type",
"individual_pricing"
],
"properties": {
"model": {
"type": "string",
"title": "Model"
},
"car_id": {
"type": "string",
"title": "Car Id"
},
"price_basis": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Price Basis",
"default": null
},
"rent_length": {
"type": "string",
"title": "Rent Length"
},
"customer_type": {
"type": "string",
"title": "Customer Type"
},
"mileage_limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Mileage Limit",
"default": null
},
"monthly_price": {
"anyOf": [
{
"type": "object",
"title": "Money",
"required": [
"amount_grosz",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"currency": {
"enum": [
"PLN"
],
"type": "string",
"title": "Currency",
"default": "PLN"
},
"amount_grosz": {
"type": "integer",
"title": "Amount Grosz"
}
}
},
{
"type": "null"
}
],
"default": null
},
"individual_pricing": {
"type": "boolean",
"title": "Individual Pricing"
}
}
},
{
"type": "null"
}
],
"default": null
},
"messages": {
"type": "array",
"items": {
"type": "object",
"title": "Message",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"default": null
},
"text": {
"type": "string",
"title": "Text"
},
"severity": {
"enum": [
"info",
"warning",
"error"
],
"type": "string",
"title": "Severity",
"default": "info"
}
}
},
"title": "Messages"
},
"policies": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "Policy",
"required": [
"type"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null
},
"type": {
"type": "string",
"title": "Type"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": null
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Policies",
"default": null
},
"replayed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Replayed",
"default": null
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At",
"default": null
},
"next_steps": {
"type": "array",
"items": {
"type": "string"
},
"title": "Next Steps"
},
"continue_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Continue Url",
"default": null
},
"content_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Language",
"default": null
}
}
}request_long_term_offer annotations
{
"title": "Ask about a long-term offer",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}Prompts
Not advertised
Resources
Not advertised
30-day availability
Aggregated from read-only remote checks; this is not a tool-execution or security guarantee.
- Successful checks
- 1 of 1 (100%)
- Average latency
- 1322 ms
- 95th percentile latency
- 1322 ms
Maintenance history
Public check and source-refresh events. Editorial and ownership records remain private.
- · probe · passed · 1322 ms · metadata changed · 18 tool(s)
Connect from your client
Each snippet registers the same endpoint; pick the client you use.
Claude Code
Claude Code configuration
claude mcp add --transport http beep-rent-mcp https://mcp.beep.rent/mcpCodex
Codex configuration
codex mcp add beep-rent-mcp --url https://mcp.beep.rent/mcpCursor
Cursor configuration
{
"mcpServers": {
"beep-rent-mcp": {
"url": "https://mcp.beep.rent/mcp"
}
}
}Cline
Cline configuration
{
"mcpServers": {
"beep-rent-mcp": {
"type": "streamableHttp",
"url": "https://mcp.beep.rent/mcp",
"disabled": false
}
}
}VS Code
VS Code configuration
{
"servers": {
"beep-rent-mcp": {
"type": "http",
"url": "https://mcp.beep.rent/mcp"
}
}
}Gemini CLI
Gemini CLI configuration
gemini mcp add --transport http beep-rent-mcp https://mcp.beep.rent/mcpClaude Desktop
Claude Desktop configuration
{
"mcpServers": {
"beep-rent-mcp": {
"url": "https://mcp.beep.rent/mcp"
}
}
}Windsurf
Windsurf configuration
{
"mcpServers": {
"beep-rent-mcp": {
"serverUrl": "https://mcp.beep.rent/mcp"
}
}
}Let your agent find its tools
Find servers like BEEP.rent MCP from your agent. Add Koskamo once to search the index for endpoints, access requirements, and client setup. Public discovery needs no key.
Other commerce servers
Do you run BEEP.rent MCP?
Prove ownership with a DNS record, a well-known file, or your Official MCP Registry entry, and your edits publish immediately. Proofs are re-checked weekly; admins can still hide or remove a listing.