GOgojinko
Hotels

Cancel a hotel AI search task

Cancels a task that has not ended. A task that already ended answers 409 CONFLICT.

post/v1/hotel_ai_search/tasks/{task_id}:cancel

Request

  • Base URL
    https://api.gojinko.com
  • URL
    https://api.gojinko.com/v1/hotel_ai_search/tasks/{task_id}:cancel
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

task_idstring required
Example:atk_example

Response

The task, now canceled.

context_idstring nullable required

The conversation; send it with the next message to continue.

task_idstring required
status'working' | 'input_required' | 'completed' | 'failed' | 'canceled' required

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.

messagestring

The reply to show the traveller.

questionstring

What the reply asks for, when status is input_required.

criteriaobject

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.

notesobject[]

Assumptions and adjustments made while understanding the request.

has_moreboolean

More hotels are available; ask for more in the same conversation.

referenceboolean

The hotels are a 1-night reference search shown while the check-out date is asked.

superseded_bystring

The task that replaced this one, when status is canceled.

Changes

No recorded changes to this operation across all 1 revision of this API.