Skip to content
Sine Cloud
GatewayOpenAPI

Cancel a task

POST/api/gateway/v1/tasks/{id}/cancel

Reads and cancellation use the original frozen task identity, not current model configuration. The key must retain modelInvoke and permission for the original project and route. Task recovery remains available during financial recovery subject to current identity and product authorization. Unknown or expired tasks may have been submitted: inspect and reconcile the existing task before creating another invocation. HTTP disconnect does not cancel a task. Cancellation is a request, not a guarantee that provider work stops. Poll until a terminal outcome; cancelSupported indicates remote cancellation capability.

Organization API key authentication

Authorization: Bearer $SINECLOUD_API_KEY

Required scopes: modelInvoke

Parameters

id · path · Required
routeId · query · Optional
Optional original route assertion; mismatches return 404. Takes precedence over x-sine-route-id.
x-sine-route-id · header · Optional
Optional original route assertion when routeId is absent.
x-sine-project-id · header · Optional
Select an organization project. A project-restricted key defaults to its bound project and cannot select another project. The projectId query parameter takes precedence.
projectId · query · Optional
Optional project selection; takes precedence over x-sine-project-id and must respect the key restriction.

Request body

Optional

application/json

Responses

200
Task already completed, failed or cancelled, or cancellation completed immediately.
202
Cancellation requested; task remains nonterminal, including unknown or expired states.
400
Invalid request, project identifier, unsupported model parameters or operation configuration.
401
Missing, expired, revoked or invalid organization Bearer API key.
403
The key scope, project restriction, route policy, current membership or product entitlement denies access.
404
The project, route or authorized task was not found.
409
task_cancel_unsupported: remote cancellation is unavailable; task_submission_unknown: reconcile the original upstream binding before cancellation.
413
Cancellation JSON exceeds 256 KiB.
415
Use application/json when sending a cancellation body.
429
Rate or concurrency limit reached. Honor Retry-After when returned.
500
Sanitized Cloud or Gateway failure.
503
Gateway or durable task execution is unavailable. Restore the required service before continuing.

Loading API reference…

Gateway · Setup & authentication

Base URLhttps://sinecloud.dev/api/gateway/v1

Open Console · Create an API key · Browse all APIs

Download API index

Before your first request

Select your organization, prepare resources in Console, and issue an organization API key with the required product scopes. Current permissions, resource access, budget and available funds are checked on every call.

Choose an available route from the model catalog and use its ID as model. The catalog covers model discovery, chat completions, responses, messages, embeddings, images, audio, generation and durable task lifecycle. Use the appropriate native protocol and preserve JSON, streaming SSE, multipart and binary body formats. Review current model access, supported operations and billing in Console.

Grant modelRead to list routes and modelInvoke for inference and task operations. Project restrictions and route policies apply on every request. Managed routes require available funds and budget; own-key routes use the organization’s provider credentials. Keep original task IDs and inspect durable status before retrying uncertain execution.

Organization key authentication and base URL

The production API origin is https://sinecloud.dev; the documentation origin does not serve product requests. The path prefix is /api/gateway/v1. Use the complete path documented for the operation, replacing resource IDs, models and endpoint revisions with your actual selections.

Authorization: Bearer $SINECLOUD_API_KEY

Set SINECLOUD_API_KEY to your own environment variable value; never use platform service credentials. Each operation lists required scopes in x-sinecloud-scopes.

This reference is read-only. Run requests in Console or your own client. Browsing documentation never creates a key, starts execution or incurs an execution charge. Keep request IDs and execution receipts; a lost connection does not cancel work. Follow the operation’s recovery instructions before submitting again.

Sine CloudDocs
Console

Type to search…

↑↓ navigate↵ selectEsc Close