> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eachlabs.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel Model Prediction

> Cancel a running prediction by ID. Cancellation is best-effort for upstream providers;
not every provider can interrupt work that is already running. When provider
cancellation is supported and succeeds, the Eachlabs execution record is updated
to `cancelled`; otherwise the original prediction may still complete or fail.




## OpenAPI

````yaml /openapi_specs/models.json post /v1/prediction/{id}/cancel
openapi: 3.0.3
info:
  title: each::labs Official API v1
  description: >
    Official each::labs API V1.

    This API provides access to our comprehensive AI model catalog and other
    resources.


    ## Public contract notes


    - Public API routes handled by request logging include `X-Request-Id` for
      support and log correlation. Clients may send `X-Request-Id`; otherwise
      api-service generates one. Root, health, and metrics endpoints are excluded.
    - REST error bodies keep the backward-compatible JSON shape used by existing
      clients. Most errors include at least `error`; some shared error paths also
      include `status` and `details`. Use the HTTP status code as the primary
      programmatic signal unless an endpoint documents a richer envelope.
    - Rate-limit and retry headers are endpoint-dependent. If a response
    includes
      `Retry-After`, honor it before retrying; otherwise use bounded exponential
      backoff for retryable 429/5xx responses.
    - api-service exposes single workflow trigger through
      `/v1/workflows/trigger/{workflowID}/{versionID}`. Bulk workflow trigger is
      not routed through api-service; use the workflows-engine public API directly
      where bulk trigger is required.
  version: 1.0.0
  contact:
    name: API Support
    email: support@eachlabs.ai
  x-logo:
    url: ./logo-white.svg
    altText: each::labs
servers:
  - url: https://api.eachlabs.ai
    description: Production server
security: []
tags:
  - name: AI Models
    description: Endpoints for listing and retrieving AI models and other resources.
  - name: AI Models Prediction
    description: Endpoints for managing model predictions
  - name: Uploads
    description: Endpoints for uploading files that can be used as model inputs.
  - name: Executions
    description: Endpoints for listing execution history.
  - name: Workflows
    description: Endpoints for triggering workflow executions through api-service.
  - name: OpenAI Compatibility
    description: OpenAI-compatible endpoints for LLM Router requests.
  - name: Webhooks
    description: >
      Endpoints for retrieving webhook information and delivery history.


      **Note:** Currently, webhooks are only supported for Workflows V2. We are
      actively expanding webhook support to other services and will update this
      documentation as new integrations become available.
paths:
  /v1/prediction/{id}/cancel:
    post:
      tags:
        - AI Models Prediction
      summary: Cancel Model Prediction
      description: >
        Cancel a running prediction by ID. Cancellation is best-effort for
        upstream providers;

        not every provider can interrupt work that is already running. When
        provider

        cancellation is supported and succeeds, the Eachlabs execution record is
        updated

        to `cancelled`; otherwise the original prediction may still complete or
        fail.
      operationId: cancelPrediction
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Prediction ID
          example: abc123-def456-ghi789
      responses:
        '200':
          description: Prediction cancellation accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPredictionResponse'
              example:
                status: cancelled
                message: Prediction canceled successfully
                predictionID: abc123-def456-ghi789
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    CancelPredictionResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - cancelled
          description: Cancellation status returned when the cancellation request succeeds
          example: cancelled
        message:
          type: string
          description: Human-readable cancellation message
          example: Prediction canceled successfully
        predictionID:
          type: string
          description: Unique prediction identifier
          example: abc123-def456-ghi789
    Error:
      type: object
      description: >
        Backward-compatible REST error body. Endpoint-specific handlers may
        return only

        `error`; shared error paths may also include `status` and `details`.
      properties:
        status:
          type: integer
          description: HTTP status code, when returned by the shared error handler.
          example: 400
        error:
          type: string
          description: Safe user-facing error message.
          example: error message
        details:
          nullable: true
          description: Optional validation or request details for client errors.
      required:
        - error
  responses:
    Unauthorized:
      description: Authentication required or invalid credentials
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid or missing API key
    NotFound:
      description: Resource not found
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: 'Failed to fetch model: model not found'
    InternalServerError:
      description: Internal server error
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: 'Failed to fetch models: internal error'
  headers:
    RequestId:
      description: >-
        Request correlation ID. Echoes the incoming `X-Request-Id` header or a
        generated ID.
      schema:
        type: string
      example: 123e4567-e89b-12d3-a456-426614174000
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication

````