USusesynth
index

Cancel

post/api/v1/index/searches/{search_id}/cancel

Request

  • Base URL
    https://api.usesynth.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.usesynth.ai/api/v1/index/searches/{search_id}/cancel
  • Auth
    none declared

Path parameters

search_idstring uuid required

Response

Successful Response

search_idstring required
state'queued' | 'running' | 'completed' | 'failed' | 'cancelled' required
cancellation_requestedtrue

Changes

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