Cancel a hotel AI search task
curl --request POST \
--url https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"context_id": "ctx_example",
"task_id": "atk_example",
"status": "working",
"message": "Found 37 hotels in Paris for Oct 24–25 (1 night, 2 adults, 1 room).",
"question": "dates",
"criteria": {},
"notes": [
{}
],
"hotels": [
{
"hotel_id": "lp1d2c3",
"hotel_ref": "h1:lp1d2c3",
"name": "Hôtel Le Marais",
"address": "12 Rue de Rivoli",
"city": "Paris",
"country": "fr",
"star_rating": 4,
"category": "4 KEYS",
"lodging_type": "Aparthotel",
"rating": 8.6,
"review_count": 1243,
"main_photo": "https://images.example.com/hotels/main.jpg",
"thumbnail": "https://images.example.com/hotels/thumb.jpg",
"latitude": 48.8566,
"longitude": 2.3522,
"distance_km": 1,
"recommendation_score": 0.5,
"rooms": [
{
"room_id": "rm_1",
"room_name": "Superior Double",
"description": "<string>",
"requested_occupancy": 2,
"room_capacity": 2,
"max_occupancy": 2,
"images": [
"<string>"
],
"amenities": [
"<string>"
],
"beds": [
{
"bed_type": "<string>",
"count": 2
}
],
"rates": [
{
"offer_id": "htl_2d67a7441c60e5de",
"board_type": "RO",
"board_name": "Room Only",
"total_amount": 1818.4,
"total_amount_display": "EUR 606.13",
"currency": "EUR",
"total_amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"is_refundable": false,
"free_cancellation_until": "2026-08-18T10:00:00+02:00",
"cancellation_schedule": [
{
"cancel_time": "2026-08-18T10:00:00+02:00",
"amount": 606.13,
"currency": "EUR",
"type": "amount",
"display": "EUR 606.13",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"percent": 50,
"nights": 1
}
],
"taxes_breakdown": [
{
"amount": 164.49,
"currency": "EUR",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"description": "19, VAT National taxes on accommodation",
"included": true,
"display": "EUR 164.49"
}
],
"payment_types": [
"pay_now"
],
"promotions": [
{
"code": "<string>",
"name": "<string>",
"remark": "<string>"
}
],
"booking_scope": "room_bundle",
"num_rooms": 2,
"rooms": [
{
"occupancy_number": 1,
"occupancy": {
"adults": 2,
"children_ages": [
8
]
},
"room_id": "<string>",
"mapped_room_id": 123,
"room_name": "Superior Double",
"rate_id": "<string>",
"board_type": "BB",
"board_name": "Breakfast Included",
"max_occupancy": 123,
"taxes_and_fees": [
{
"amount": 164.49,
"currency": "EUR",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"description": "19, VAT National taxes on accommodation",
"included": true,
"display": "EUR 164.49"
}
],
"policies": [
{
"type": "<string>",
"description": "<string>",
"fee_amount": 123,
"fee_currency": "<string>",
"fee_amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
}
}
],
"is_refundable": true,
"cancellation_policy": [
{
"cancel_time": "2026-08-18T10:00:00+02:00",
"amount": 606.13,
"currency": "EUR",
"type": "amount",
"display": "EUR 606.13",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"percent": 50,
"nights": 1
}
],
"free_cancellation_until": "<string>",
"payment_types": [
"pay_now"
],
"remarks": "<string>"
}
]
}
]
}
],
"offers": [
{
"offer_id": "htl_2d67a7441c60e5de",
"total_amount": 1818.4,
"currency": "EUR",
"is_refundable": true,
"taxes_breakdown": [
{
"amount": 164.49,
"currency": "EUR",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"description": "19, VAT National taxes on accommodation",
"included": true,
"display": "EUR 164.49"
}
],
"trip_item_token": "htl_2d67a7441c60e5de",
"room_rates": [
{
"room_id": "<string>",
"occupancy_number": 2,
"occupancy": {
"adults": 2,
"children_ages": [
8
]
},
"taxes_and_fees": [
{
"amount": 164.49,
"currency": "EUR",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"description": "19, VAT National taxes on accommodation",
"included": true,
"display": "EUR 164.49"
}
],
"is_refundable": true,
"room_name": "<string>",
"board_type": "<string>",
"board_name": "<string>",
"max_occupancy": 123,
"policies": [
{
"type": "<string>",
"description": "<string>",
"fee_amount": 123,
"fee_currency": "<string>",
"fee_amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
}
}
],
"cancellation_policy": [
{
"cancel_time": "2026-08-18T10:00:00+02:00",
"amount": 606.13,
"currency": "EUR",
"type": "amount",
"display": "EUR 606.13",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"percent": 50,
"nights": 1
}
],
"free_cancellation_until": "<string>",
"payment_types": [
"pay_now"
],
"remarks": "<string>"
}
],
"board_type": "RO",
"board_name": "Room Only",
"total_amount_display": "EUR 606.13",
"total_amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"free_cancellation_until": "2026-08-18T10:00:00+02:00",
"cancellation_schedule": [
{
"cancel_time": "2026-08-18T10:00:00+02:00",
"amount": 606.13,
"currency": "EUR",
"type": "amount",
"display": "EUR 606.13",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"percent": 50,
"nights": 1
}
],
"payment_types": [
"pay_now"
],
"promotions": [
{
"name": "<string>",
"remark": "<string>"
}
]
}
],
"match_score": 87
}
],
"has_more": true,
"reference": true,
"error": {
"code": "<string>",
"message": "<string>"
},
"superseded_by": "<string>",
"charge": {
"turn": 1,
"llm_usd": 0.0165,
"api_usd": 0.0645,
"total_usd": 0.081,
"currency": "USD"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "X-End-User-Id must be an opaque, tenant-scoped id; ids with a reserved prefix, such as user_ or org_, are not allowed."
}
}{
"error": {
"code": "AUTH_REQUIRED",
"message": "Invalid or expired API key.",
"doc_url": "https://docs.gojinko.com/authentication/api-keys"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "This API key is not granted the \"search_live\" scope required by this endpoint"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "CONFLICT",
"message": "The operation conflicts with the current state of the resource.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "A required field is missing or invalid.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests. Retry after the Retry-After delay.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "UPSTREAM_REJECTED",
"message": "The request was declined for this offer. Try another offer.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "The service is temporarily unavailable. Retry after the Retry-After delay.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "UPSTREAM_TIMEOUT",
"message": "The request timed out before a result was available. Retry the request.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}Hotel search
hotel-ai-search-cancel
Cancel a hotel AI search task
POST
/
v1
/
hotel_ai_search
/
tasks
/
{task_id}
:cancel
Cancel a hotel AI search task
curl --request POST \
--url https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"context_id": "ctx_example",
"task_id": "atk_example",
"status": "working",
"message": "Found 37 hotels in Paris for Oct 24–25 (1 night, 2 adults, 1 room).",
"question": "dates",
"criteria": {},
"notes": [
{}
],
"hotels": [
{
"hotel_id": "lp1d2c3",
"hotel_ref": "h1:lp1d2c3",
"name": "Hôtel Le Marais",
"address": "12 Rue de Rivoli",
"city": "Paris",
"country": "fr",
"star_rating": 4,
"category": "4 KEYS",
"lodging_type": "Aparthotel",
"rating": 8.6,
"review_count": 1243,
"main_photo": "https://images.example.com/hotels/main.jpg",
"thumbnail": "https://images.example.com/hotels/thumb.jpg",
"latitude": 48.8566,
"longitude": 2.3522,
"distance_km": 1,
"recommendation_score": 0.5,
"rooms": [
{
"room_id": "rm_1",
"room_name": "Superior Double",
"description": "<string>",
"requested_occupancy": 2,
"room_capacity": 2,
"max_occupancy": 2,
"images": [
"<string>"
],
"amenities": [
"<string>"
],
"beds": [
{
"bed_type": "<string>",
"count": 2
}
],
"rates": [
{
"offer_id": "htl_2d67a7441c60e5de",
"board_type": "RO",
"board_name": "Room Only",
"total_amount": 1818.4,
"total_amount_display": "EUR 606.13",
"currency": "EUR",
"total_amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"is_refundable": false,
"free_cancellation_until": "2026-08-18T10:00:00+02:00",
"cancellation_schedule": [
{
"cancel_time": "2026-08-18T10:00:00+02:00",
"amount": 606.13,
"currency": "EUR",
"type": "amount",
"display": "EUR 606.13",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"percent": 50,
"nights": 1
}
],
"taxes_breakdown": [
{
"amount": 164.49,
"currency": "EUR",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"description": "19, VAT National taxes on accommodation",
"included": true,
"display": "EUR 164.49"
}
],
"payment_types": [
"pay_now"
],
"promotions": [
{
"code": "<string>",
"name": "<string>",
"remark": "<string>"
}
],
"booking_scope": "room_bundle",
"num_rooms": 2,
"rooms": [
{
"occupancy_number": 1,
"occupancy": {
"adults": 2,
"children_ages": [
8
]
},
"room_id": "<string>",
"mapped_room_id": 123,
"room_name": "Superior Double",
"rate_id": "<string>",
"board_type": "BB",
"board_name": "Breakfast Included",
"max_occupancy": 123,
"taxes_and_fees": [
{
"amount": 164.49,
"currency": "EUR",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"description": "19, VAT National taxes on accommodation",
"included": true,
"display": "EUR 164.49"
}
],
"policies": [
{
"type": "<string>",
"description": "<string>",
"fee_amount": 123,
"fee_currency": "<string>",
"fee_amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
}
}
],
"is_refundable": true,
"cancellation_policy": [
{
"cancel_time": "2026-08-18T10:00:00+02:00",
"amount": 606.13,
"currency": "EUR",
"type": "amount",
"display": "EUR 606.13",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"percent": 50,
"nights": 1
}
],
"free_cancellation_until": "<string>",
"payment_types": [
"pay_now"
],
"remarks": "<string>"
}
]
}
]
}
],
"offers": [
{
"offer_id": "htl_2d67a7441c60e5de",
"total_amount": 1818.4,
"currency": "EUR",
"is_refundable": true,
"taxes_breakdown": [
{
"amount": 164.49,
"currency": "EUR",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"description": "19, VAT National taxes on accommodation",
"included": true,
"display": "EUR 164.49"
}
],
"trip_item_token": "htl_2d67a7441c60e5de",
"room_rates": [
{
"room_id": "<string>",
"occupancy_number": 2,
"occupancy": {
"adults": 2,
"children_ages": [
8
]
},
"taxes_and_fees": [
{
"amount": 164.49,
"currency": "EUR",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"description": "19, VAT National taxes on accommodation",
"included": true,
"display": "EUR 164.49"
}
],
"is_refundable": true,
"room_name": "<string>",
"board_type": "<string>",
"board_name": "<string>",
"max_occupancy": 123,
"policies": [
{
"type": "<string>",
"description": "<string>",
"fee_amount": 123,
"fee_currency": "<string>",
"fee_amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
}
}
],
"cancellation_policy": [
{
"cancel_time": "2026-08-18T10:00:00+02:00",
"amount": 606.13,
"currency": "EUR",
"type": "amount",
"display": "EUR 606.13",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"percent": 50,
"nights": 1
}
],
"free_cancellation_until": "<string>",
"payment_types": [
"pay_now"
],
"remarks": "<string>"
}
],
"board_type": "RO",
"board_name": "Room Only",
"total_amount_display": "EUR 606.13",
"total_amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"free_cancellation_until": "2026-08-18T10:00:00+02:00",
"cancellation_schedule": [
{
"cancel_time": "2026-08-18T10:00:00+02:00",
"amount": 606.13,
"currency": "EUR",
"type": "amount",
"display": "EUR 606.13",
"amount_money": {
"value": 41250,
"currency": "USD",
"decimal_places": 2,
"display": "USD 412.50"
},
"percent": 50,
"nights": 1
}
],
"payment_types": [
"pay_now"
],
"promotions": [
{
"name": "<string>",
"remark": "<string>"
}
]
}
],
"match_score": 87
}
],
"has_more": true,
"reference": true,
"error": {
"code": "<string>",
"message": "<string>"
},
"superseded_by": "<string>",
"charge": {
"turn": 1,
"llm_usd": 0.0165,
"api_usd": 0.0645,
"total_usd": 0.081,
"currency": "USD"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "X-End-User-Id must be an opaque, tenant-scoped id; ids with a reserved prefix, such as user_ or org_, are not allowed."
}
}{
"error": {
"code": "AUTH_REQUIRED",
"message": "Invalid or expired API key.",
"doc_url": "https://docs.gojinko.com/authentication/api-keys"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "This API key is not granted the \"search_live\" scope required by this endpoint"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "CONFLICT",
"message": "The operation conflicts with the current state of the resource.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "A required field is missing or invalid.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests. Retry after the Retry-After delay.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "UPSTREAM_REJECTED",
"message": "The request was declined for this offer. Try another offer.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "The service is temporarily unavailable. Retry after the Retry-After delay.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "UPSTREAM_TIMEOUT",
"message": "The request timed out before a result was available. Retry the request.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}Cancels a task that has not ended. A task that already ended answers
409 CONFLICT.
A new message in the conversation already replaces a search that is still running. See Waiting for results.
Authorizations
ApiKeyAuthBearerAuth
Path Parameters
Required string length:
1 - 100Example:
"atk_example"
Response
The task, now canceled.
The conversation; send it with the next message to continue.
Example:
"ctx_example"
Example:
"atk_example"
working: the search is still running, read the task again. input_required: the message asks a question; answer it in the same conversation. completed: the hotels are in the answer. failed: see error. canceled: a later message or a cancel replaced it.
Available options:
working, input_required, completed, failed, canceled The reply to show the traveller.
Example:
"Found 37 hotels in Paris for Oct 24–25 (1 night, 2 adults, 1 room)."
What the reply asks for, when status is input_required.
Example:
"dates"
The search the request was understood as, in the hotel_search request fields, plus board_types and refundable_only for the rate filters applied to the results.
Show child attributes
Show child attributes
Assumptions and adjustments made while understanding the request.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
More hotels are available; ask for more in the same conversation.
The hotels are a 1-night reference search shown while the check-out date is asked.
Why the task failed, when status is failed.
Show child attributes
Show child attributes
The task that replaced this one, when status is canceled.
What a turn was charged to the organization's balance, once the turn has ended (completed, input_required, failed or canceled); every amount is 0 when the turn cost nothing. Absent while the task is working. Carried on JSON answers only: an event stream does not carry it, so read it with GET /v1/hotel_ai_search/tasks/{task_id}.
Show child attributes
Show child attributes