Cancel Batch Job

client.Beta.Batch.Cancel(ctx, jobID, params) (*BetaBatchCancelResponse, error)

POST/api/v1/beta/batch-processing/{job_id}/cancel

Cancel a running batch processing job.

Stops processing and marks pending items as cancelled. Items currently being processed may still complete.

ParametersExpand Collapse

jobID string

params BetaBatchCancelParams

OrganizationID param.Field[string]optional

Query param

formatuuid

ProjectID param.Field[string]optional

Query param

formatuuid

Reason param.Field[string]optional

Body param: Optional reason for cancelling the job

TemporalNamespace param.Field[string]optional

Header param

ReturnsExpand Collapse

type BetaBatchCancelResponse struct{…}

Response after cancelling a batch job.

JobID string

ID of the cancelled job

Message string

Confirmation message

ProcessedItems int64

Number of items processed before cancellation

Status BetaBatchCancelResponseStatus

New status (should be 'cancelled')

One of the following:

const BetaBatchCancelResponseStatusPending BetaBatchCancelResponseStatus = "pending"

const BetaBatchCancelResponseStatusRunning BetaBatchCancelResponseStatus = "running"

const BetaBatchCancelResponseStatusDispatched BetaBatchCancelResponseStatus = "dispatched"

const BetaBatchCancelResponseStatusCompleted BetaBatchCancelResponseStatus = "completed"

const BetaBatchCancelResponseStatusFailed BetaBatchCancelResponseStatus = "failed"

const BetaBatchCancelResponseStatusCancelled BetaBatchCancelResponseStatus = "cancelled"

Cancel Batch Job

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/llamacloud-prod-go"
  "github.com/stainless-sdks/llamacloud-prod-go/option"
)

func main() {
  client := llamacloudprod.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Beta.Batch.Cancel(
    context.TODO(),
    "job_id",
    llamacloudprod.BetaBatchCancelParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.JobID)
}

{
  "job_id": "job_id",
  "message": "message",
  "processed_items": 0,
  "status": "pending"
}

Returns Examples

{
  "job_id": "job_id",
  "message": "message",
  "processed_items": 0,
  "status": "pending"
}