> ## Documentation Index > Fetch the complete documentation index at: https://crevio.co/docs/llms.txt > Use this file to discover all available pages before exploring further. # Cancel a task run > Stop a run that is pending, running, or waiting for input, and cancel the image, audio and video generations it still has in flight (they are billed only when they finish). Stopping is asynchronous, like the agent runtime it asks: a run mid-step finishes that step first. The response is the run with `cancel_requested_at` set; it settles as `cancelled` moments later (poll GET /task_runs/{id}, or listen for `task_run.cancelled`). A run that was not mid-step is cancelled at once. Cancelled runs do not count as failures. Repeating the call returns the run unchanged. 409 `run_not_active` if the run has already settled. ## OpenAPI ````yaml /developer/api-reference/openapi.json post /task_runs/{id}/cancel openapi: 3.1.1 info: title: Crevio API V1 version: 1.0.0 description: > API for the Crevio creator platform — a multi-tenant SaaS for digital product sales. Uses snake_case keys following Stripe conventions. All resource IDs are string IDs (e.g., "prod_abc123"). Authentication is a bearer token: `Authorization: Bearer $CREVIO_API_KEY`. List endpoints are cursor-paginated with `limit` and `starting_after`. Writes accept an `Idempotency-Key` header and are safe to retry. Every response carries IETF RateLimit headers (`RateLimit`, `RateLimit-Policy`) so a client can self-throttle, and `Retry-After` on a 429. The quota is 600 requests per minute per credential. The API is versioned in the URL path (`/v1`). Nothing is removed without in-band warning: a deprecated operation is marked `"deprecated": true` here and serves `Deprecation` (RFC 9745), `Sunset` (RFC 8594) and `Link; rel="deprecation"` headers for at least six months before it stops answering. See https://crevio.co/docs/developer/guides/versioning. contact: email: support@crevio.co name: Crevio Support url: https://crevio.co/docs license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://crevio.co/legal/terms-of-service servers: - url: https://api.crevio.co/v1 description: Production security: - ApiKey: [] tags: - name: Account description: Current account information - name: Bots description: >- Named bot identities (persona, skills, toolsets) chats and tasks can run as - name: Analytics description: Account-wide business analytics - name: BlogCategories description: Blog post categories - name: BlogPosts description: Blog content management - name: Broadcasts description: One-to-many email sending - name: CheckoutLinks description: Shareable checkout links - name: CheckoutConfiguration description: Account-wide checkout settings - name: Checkouts description: Checkout session management - name: Customers description: Customer relationship management - name: Discounts description: Discount code management - name: Experiences description: Digital experiences (courses, communities, downloads) - name: Files description: File uploads and external media management - name: FormSubmissions description: Form submission management - name: FormationDocuments description: Documents generated for a formation - name: Formations description: Whitelabel business formation via doola Partner API - name: Forms description: Hosted forms that capture leads and submissions - name: Invoices description: Invoice creation, payment, and lifecycle management - name: LegalPages description: Terms, privacy and refund pages for the storefront - name: Me description: Current user profile - name: OrderItems description: Order line items - name: Orders description: Order history and details - name: PriceVariants description: Product pricing tiers - name: Products description: Digital product catalog - name: Refunds description: Refund management - name: Reviews description: Product reviews - name: Socials description: Social media management (accounts, posts, media). - name: Subscriptions description: Subscription lifecycle management (cancel, pause, resume) - name: Tags description: Customer tags - name: TaskRuns description: Individual execution records for AI tasks. - name: Tasks description: >- AI tasks — scheduled or event-triggered agentic work (cron, interval, once, immediate, event). - name: WebhookEndpoints description: Webhook endpoint management - name: WebhookEvents description: Webhook event delivery history - name: Leads description: Find, verify and enrich business leads (Hunter.io-backed). - name: Ads description: >- Paid advertising — campaigns, ad groups, ads, audiences, targeting, leads, conversions, and reports across Meta, Google, TikTok, LinkedIn, Pinterest, and X. - name: Domains description: Custom web domains for your sites. - name: Web description: >- Web search & scraping (search, read, map, crawl, extract, research), backed by Firecrawl. - name: Skills description: >- AI skills marketplace — search the catalog and install or uninstall skills for your account's agent. - name: Schedules description: Reusable availability schedules that back event types. - name: EventTypes x-displayName: Event Types description: Bookable services customers can schedule time on. - name: Bookings description: Reservations made against event types. - name: Connections description: Third-party app connections (connect, list, execute) - name: Approvals description: Human-in-the-loop approvals for gated actions - name: Logs description: Account activity log - name: Access description: Per-user access checks for gated resources - name: ApiKeys description: API key management - name: Audio description: AI audio generation - name: Calls description: Outbound phone calls placed by the account's agent - name: Chapters description: Course chapters - name: Deployments description: Site deployments and build logs - name: Email description: Inboxes, threads, messages, drafts and delivery events - name: Email Suppressions description: Addresses no send path will deliver to - name: EventSessions description: Scheduled sessions of an event experience - name: EventSources description: Third-party event sources that trigger tasks - name: Events description: Events an account can subscribe to - name: ForumPosts description: Posts inside a forum experience - name: Images description: AI image generation, editing and stock search - name: Jobs description: Long-running asynchronous jobs - name: Lessons description: Lessons inside a course chapter - name: LinkItems description: Links inside a link-in-bio experience - name: Phone Consents description: Recorded consent to place calls to a number - name: Phone Numbers description: Phone numbers provisioned for the account - name: Phone Suppressions description: Do-not-call entries - name: Sites description: AI-built sites — storefronts and web apps - name: Status description: API and account status - name: Topics description: Discussion topics inside a forum experience - name: Plans description: The plans Crevio sells, their credit tiers, prices and limits. - name: Usage description: Credit usage and transaction history - name: Users description: Users of the account - name: Video description: AI video generation - name: Secrets description: Account-level environment variables shared across the account's sites - name: Billing Portal description: Hosted billing pages for your customers - name: Data description: >- Included business data: search the tool catalog, then run a tool (website/SEO, people, companies, local businesses, social, e-commerce, finance, jobs, reviews, ads, real estate, news, apps, travel, weather, legal). externalDocs: description: Crevio developer documentation url: https://crevio.co/docs/developer paths: /task_runs/{id}/cancel: post: tags: - TaskRuns summary: Cancel a task run description: >- Stop a run that is pending, running, or waiting for input, and cancel the image, audio and video generations it still has in flight (they are billed only when they finish). Stopping is asynchronous, like the agent runtime it asks: a run mid-step finishes that step first. The response is the run with `cancel_requested_at` set; it settles as `cancelled` moments later (poll GET /task_runs/{id}, or listen for `task_run.cancelled`). A run that was not mid-step is cancelled at once. Cancelled runs do not count as failures. Repeating the call returns the run unchanged. 409 `run_not_active` if the run has already settled. operationId: cancelTaskRun parameters: - name: id in: path required: true description: Task run id (trun_...) schema: type: string - $ref: '#/components/parameters/IdempotencyKey' responses: '200': description: The cancelled run. content: application/json: schema: $ref: '#/components/schemas/AiTaskRun' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': description: Conflict — the run has already settled (`run_not_active`). content: application/json: schema: $ref: '#/components/schemas/Error' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' '502': $ref: '#/components/responses/BadGateway' security: - ApiKey: [] components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: >- Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error. schema: type: string maxLength: 255 example: 1f7a4c2e-3b19-4a6d-9f0c-2ac81b5d7e33 schemas: AiTaskRun: type: object properties: id: type: string object: type: string task_id: type: string task_name: type: string chat_id: type: - string - 'null' description: >- The run's own conversation (`aichat_...`): what it read, called and said. Read it with `search_chats`. cancel_requested_at: type: - string - 'null' description: >- When a stop was requested. The run stays `running` until it reaches its next step, then settles as `cancelled`. status: type: string enum: - pending - running - completed - failed - needs_input - timed_out - unknown - skipped - cancelled summary: type: - string - 'null' error_message: type: - string - 'null' test_run: type: boolean input_tokens: type: integer output_tokens: type: integer credits_consumed: type: integer tool_calls_count: type: integer duration_ms: type: - integer - 'null' started_at: type: - string - 'null' format: date-time completed_at: type: - string - 'null' format: date-time created_at: type: string format: date-time updated_at: type: string format: date-time skip_reason: type: - string - 'null' enum: - condition - no_paid_plan_or_credits - no_recent_activity - no_task_activity - no_personal_sources - wake_gate - wake_limit - rate_limited - misfire - task_busy - account_at_capacity - null skip_count: type: integer delivery_status: type: string enum: - delivered - not_delivered - not_requested - unknown completion: type: - string - 'null' description: >- How the agent closed a completed run: `verified` (it re-checked the result), `recorded` (it reported without re-checking), or `recovered` (it never reported; `summary` is its last message). Null unless an agent turn completed the run. enum: - verified - recorded - recovered - null trigger_source: type: string enum: - scheduled - event - manual trigger_event: type: - object - 'null' description: >- The event that started this run, `{type, data}`, exactly as the run received it; `data` matches the event's webhook payload. Null for a run no event started. POST /task_runs/{id}/replay runs the task again on it. replay_of: type: - string - 'null' description: >- The run (`trun_...`) whose event this run replays. Null unless started by POST /task_runs/{id}/replay. captured_deliveries: type: array pending_approval_ids: type: array required: - id - object - task_id - task_name - chat_id - cancel_requested_at - status - summary - error_message - test_run - input_tokens - output_tokens - credits_consumed - tool_calls_count - duration_ms - started_at - completed_at - created_at - updated_at - skip_reason - skip_count - delivery_status - completion - trigger_source - trigger_event - replay_of - captured_deliveries - pending_approval_ids Error: type: object properties: error: type: object properties: type: type: string enum: - api_error - invalid_request_error - validation_error code: type: string message: type: string param: type: string errors: type: object doc_url: type: string required: - type - message required: - error responses: BadRequest: description: Bad request content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: invalid_request_error code: bad_request message: The request was malformed or contained invalid parameters headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimitPolicy' Request-Id: $ref: '#/components/headers/RequestId' Deprecation: $ref: '#/components/headers/Deprecation' Sunset: $ref: '#/components/headers/Sunset' Link: $ref: '#/components/headers/DeprecationLink' Unauthorized: description: Authentication required content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: invalid_request_error code: authentication_required message: You did not provide an API key. headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimitPolicy' Request-Id: $ref: '#/components/headers/RequestId' Deprecation: $ref: '#/components/headers/Deprecation' Sunset: $ref: '#/components/headers/Sunset' Link: $ref: '#/components/headers/DeprecationLink' Forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: invalid_request_error code: forbidden message: You do not have permission to perform this action headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimitPolicy' Request-Id: $ref: '#/components/headers/RequestId' Deprecation: $ref: '#/components/headers/Deprecation' Sunset: $ref: '#/components/headers/Sunset' Link: $ref: '#/components/headers/DeprecationLink' NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: invalid_request_error code: resource_missing message: The requested resource was not found headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimitPolicy' Request-Id: $ref: '#/components/headers/RequestId' Deprecation: $ref: '#/components/headers/Deprecation' Sunset: $ref: '#/components/headers/Sunset' Link: $ref: '#/components/headers/DeprecationLink' TooManyRequests: description: >- Rate limit exceeded — 600 requests per minute per credential. Retry after the number of seconds in `Retry-After`. headers: Retry-After: $ref: '#/components/headers/RetryAfter' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimitPolicy' content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: invalid_request_error code: rate_limit_exceeded message: Too many requests. Please retry later. InternalServerError: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: api_error code: internal_error message: An unexpected error occurred headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimitPolicy' Request-Id: $ref: '#/components/headers/RequestId' Deprecation: $ref: '#/components/headers/Deprecation' Sunset: $ref: '#/components/headers/Sunset' Link: $ref: '#/components/headers/DeprecationLink' BadGateway: description: Upstream (provider) failure content: application/json: schema: $ref: '#/components/schemas/Error' headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimitPolicy' Request-Id: $ref: '#/components/headers/RequestId' Deprecation: $ref: '#/components/headers/Deprecation' Sunset: $ref: '#/components/headers/Sunset' Link: $ref: '#/components/headers/DeprecationLink' headers: RateLimit: description: >- Remaining quota for the current window, as an IETF structured field: `"default";r=;t=`. schema: type: string examples: - '"default";r=596;t=11' RateLimitPolicy: description: >- The quota this credential is subject to: `"default";q=;w=`. schema: type: string examples: - '"default";q=600;w=60' RequestId: description: Unique id for this request. Quote it when reporting a problem. schema: type: string examples: - 8fe045fe-cb8a-4407-a44d-5df60385e522 Deprecation: description: >- Present only on a deprecated operation. Structured-field date (RFC 9745) — `@` followed by the Unix timestamp at which the operation became deprecated. schema: type: string examples: - '@1775001600' Sunset: description: >- Present only on a deprecated operation. HTTP-date (RFC 8594) after which the operation stops responding. Always at least six months after `Deprecation`. schema: type: string examples: - Thu, 01 Oct 2026 00:00:00 GMT DeprecationLink: description: >- Present only on a deprecated operation. `; rel="deprecation"` pointing at the migration notes. schema: type: string examples: - >- ; rel="deprecation" RetryAfter: description: Seconds to wait before retrying. schema: type: integer examples: - 11 securitySchemes: ApiKey: type: apiKey in: header name: Authorization description: 'API key in the format: Bearer {api_token}' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.