Research

Cancel an in-flight research run

Requests cancellation of an in-flight run and returns its new status (cancelled). Credits already settled for provider actions are not refunded; reserved credits are released. A run that has already finished (completed, failed or cancelled) cannot be cancelled and answers 409. Rate limit: 30 requests per minute, 1000 per day.

Errors:

  • 404 RESEARCH_RUN_NOT_FOUND — No research run with that id belongs to the token owner.
  • 409 RUN_ALREADY_TERMINAL — The run has already finished (completed, failed or cancelled) and cannot be cancelled.
  • 422 VALIDATION_FAILED — runId is not a 24-character hex id.
  • 429 RATE_LIMITED — Per-user quota for this endpoint family exceeded (30 per minute, 1000 per day); retry after the Retry-After / RateLimit-Reset seconds.

Requires one of the following token scopes: research.

post/business/research/runs/{runId}/cancel

Request

  • Base URL: https://api.tryfuse.ai/api/v1
  • URL: https://api.tryfuse.ai/api/v1/business/research/runs/{runId}/cancel
  • Auth: HTTP basic

Path parameters

runIdstring required

The research run id (24-character hex), as returned in run.runId by POST /business/research/runs.

Response

Success

Changes

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