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

# Batches

> Perform batch inference with OpenAI

Portkey exposes [OpenAI’s Batch API](https://platform.openai.com/docs/guides/batch) through one consistent endpoint, so you can run large, asynchronous evaluation jobs at 50 % lower cost.

Use batches when you need to run large jobs offline — e.g. nightly evals, A/B tests, or bulk embeddings.

## Create Batch Job

Upload your .jsonl file first — see [Files API](/integrations/llms/openai/files) for more details and then use the following code to create a batch job.

<CodeGroup>
  ```python Python theme={"system"}
  from portkey_ai import Portkey

  # Initialize the Portkey client
  portkey = Portkey(
      api_key="PORTKEY_API_KEY",  # Replace with your Portkey API key
      provider="@PROVIDER"   
  )

  start_batch_response = portkey.batches.create(
    input_file_id="file_id", # file id of the input file
    endpoint="/v1/chat/completions",
    completion_window="24h",
    metadata={} # metadata for the batch
  )

  print(start_batch_response)
  ```

  ```javascript Typescript theme={"system"}
  import { Portkey } from 'portkey-ai';

  // Initialize the Portkey client
  const portkey = new Portkey({
      apiKey: "PORTKEY_API_KEY",  // Replace with your Portkey API key
      provider:"@PROVIDER"   
  });

  const startBatch = async () => {
    const startBatchResponse = await portkey.batches.create({
      input_file_id: "file_id", // file id of the input file
      endpoint: "/v1/chat/completions",
      completion_window: "24h",
      metadata: {} // metadata for the batch
    });

    console.log(startBatchResponse);
  }

  await startBatch();

  ```

  ```bash curl theme={"system"}
  curl --location 'https://api.portkey.ai/v1/batches' \
  --header 'x-portkey-api-key: <portkey_api_key>' \
  --header 'x-portkey-provider: @provider' \
  --header 'Content-Type: application/json' \
  --data '{
      "input_file_id": "<file_id>",
      "endpoint": "/v1/chat/completions",
      "completion_window": "24h",
      "metadata": {}
  }'
  ```

  ```javascript OpenAI NodeJS theme={"system"}
  import OpenAI from 'openai'; // We're using the v4 SDK
  import { PORTKEY_GATEWAY_URL, createHeaders } from 'portkey-ai'

  const openai = new OpenAI({
    apiKey: 'OPENAI_API_KEY', // defaults to process.env["OPENAI_API_KEY"],
    baseURL: PORTKEY_GATEWAY_URL,
    defaultHeaders: createHeaders({
      provider: "openai",
      apiKey: "PORTKEY_API_KEY" // defaults to process.env["PORTKEY_API_KEY"]
    })
  });

  const startBatch = async () => {
    const startBatchResponse = await openai.batches.create({
      input_file_id: "file_id", // file id of the input file
      endpoint: "/v1/chat/completions",
      completion_window: "24h",
      metadata: {} // metadata for the batch
    });

    console.log(startBatchResponse);
  }

  await startBatch();
  ```

  ```python OpenAI Python theme={"system"}
  from openai import OpenAI
  from portkey_ai import PORTKEY_GATEWAY_URL, createHeaders

  openai = OpenAI(
      api_key='OPENAI_API_KEY',
      base_url=PORTKEY_GATEWAY_URL,
      default_headers=createHeaders(
          provider="openai",
          api_key="PORTKEY_API_KEY"
      )
  )

  start_batch_response = openai.batches.create(
    input_file_id="file_id", # file id of the input file
    endpoint="/v1/chat/completions",
    completion_window="24h",
    metadata={} # metadata for the batch
  )

  print(start_batch_response)
  ```
</CodeGroup>

## List Batch Jobs

<CodeGroup>
  ```python Python theme={"system"}
  from portkey_ai import Portkey

  # Initialize the Portkey client
  portkey = Portkey(
      api_key="PORTKEY_API_KEY",  # Replace with your Portkey API key
      provider="@PROVIDER"   
  )

  batches = portkey.batches.list()

  print(batches)
  ```

  ```javascript Typescript theme={"system"}
  import { Portkey } from 'portkey-ai';

  // Initialize the Portkey client
  const portkey = new Portkey({
      apiKey: "PORTKEY_API_KEY",  // Replace with your Portkey API key
      provider:"@PROVIDER"   
  });

  const listBatches = async () => {
    const batches = await portkey.batches.list();

    console.log(batches);
  }

  await listBatches();

  ```

  ```bash curl theme={"system"}
  curl --location 'https://api.portkey.ai/v1/batches' \
  --header 'x-portkey-api-key: <portkey_api_key>' \
  --header 'x-portkey-provider: @provider'
  ```

  ```javascript OpenAI NodeJS theme={"system"}
  import OpenAI from 'openai'; // We're using the v4 SDK
  import { PORTKEY_GATEWAY_URL, createHeaders } from 'portkey-ai'

  const openai = new OpenAI({
    apiKey: 'OPENAI_API_KEY', // defaults to process.env["OPENAI_API_KEY"],
    baseURL: PORTKEY_GATEWAY_URL,
    defaultHeaders: createHeaders({
      provider: "openai",
      apiKey: "PORTKEY_API_KEY" // defaults to process.env["PORTKEY_API_KEY"]
    })
  });

  const listBatches = async () => {
    const batches = await openai.batches.list();

    console.log(batches);
  }

  await listBatches();
  ```

  ```python OpenAI Python theme={"system"}
  from openai import OpenAI
  from portkey_ai import PORTKEY_GATEWAY_URL, createHeaders

  openai = OpenAI(
      api_key='OPENAI_API_KEY',
      base_url=PORTKEY_GATEWAY_URL,
      default_headers=createHeaders(
          provider="openai",
          api_key="PORTKEY_API_KEY"
      )
  )

  batches = openai.batches.list()

  print(batches)
  ```
</CodeGroup>

## Get Batch Job Details

<CodeGroup>
  ```python Python theme={"system"}
  from portkey_ai import Portkey


  # Initialize the Portkey client
  portkey = Portkey(
      api_key="PORTKEY_API_KEY",  # Replace with your Portkey API key
      provider="@PROVIDER"   
  )

  batch = portkey.batches.retrieve(batch_id="batch_id")

  print(batch)
  ```

  ```javascript Typescript theme={"system"}
  import { Portkey } from 'portkey-ai';

  // Initialize the Portkey client
  const portkey = new Portkey({
      apiKey: "PORTKEY_API_KEY",  // Replace with your Portkey API key
      provider:"@PROVIDER"   
  });

  const getBatch = async () => {
    const batch = await portkey.batches.retrieve(batch_id="batch_id");

    console.log(batch);
  }

  await getBatch();

  ```

  ```bash curl theme={"system"}
  curl --location 'https://api.portkey.ai/v1/batches/<batch_id>' \
  --header 'x-portkey-api-key: <portkey_api_key>' \
  --header 'x-portkey-provider: @provider'
  ```

  ```javascript OpenAI NodeJS theme={"system"}
  import OpenAI from 'openai'; // We're using the v4 SDK
  import { PORTKEY_GATEWAY_URL, createHeaders } from 'portkey-ai'

  const openai = new OpenAI({
    apiKey: 'OPENAI_API_KEY', // defaults to process.env["OPENAI_API_KEY"],
    baseURL: PORTKEY_GATEWAY_URL,
    defaultHeaders: createHeaders({
      provider: "openai",
      apiKey: "PORTKEY_API_KEY" // defaults to process.env["PORTKEY_API_KEY"]
    })
  });

  const getBatch = async () => {
    const batch = await openai.batches.retrieve(batch_id="batch_id");

    console.log(batch);
  }

  await getBatch();
  ```

  ```python OpenAI Python theme={"system"}
  from openai import OpenAI
  from portkey_ai import PORTKEY_GATEWAY_URL, createHeaders

  openai = OpenAI(
      api_key='OPENAI_API_KEY',
      base_url=PORTKEY_GATEWAY_URL,
      default_headers=createHeaders(
          provider="openai",
          api_key="PORTKEY_API_KEY"
      )
  )

  batch = openai.batches.retrieve(batch_id="batch_id")

  print(batch)
  ```
</CodeGroup>

The status of a given Batch object can be any of the following:

| Status               | Description                                                                    |
| -------------------- | ------------------------------------------------------------------------------ |
| validating           | the input file is being validated before the batch can begin                   |
| failed               | the input file has failed the validation process                               |
| file\_upload\_failed | the batch job failed to upload the file to the provider after validation       |
| batch\_start\_failed | the file upload succeeded but the batch job submission to the provider failed  |
| in\_progress         | the input file was successfully validated and the batch is currently being run |
| finalizing           | the batch has completed and the results are being prepared                     |
| completed            | the batch has been completed and the results are ready                         |
| expired              | the batch was not able to be completed within the 24-hour time window          |
| cancelling           | the batch is being cancelled (may take up to 10 minutes)                       |
| cancelled            | the batch was cancelled                                                        |

## Get Batch Output

<CodeGroup>
  ```bash curl theme={"system"}
  curl --location 'https://api.portkey.ai/v1/batches/<batch_id>/output' \
  --header 'x-portkey-api-key: <portkey_api_key>' \
  --header 'x-portkey-provider: @provider'
  ```
</CodeGroup>

## Cancel Batch Job

<CodeGroup>
  ```python Python theme={"system"}
  from portkey_ai import Portkey

  # Initialize the Portkey client
  portkey = Portkey(
      api_key="PORTKEY_API_KEY",  # Replace with your Portkey API key
      provider="@PROVIDER"   
  )

  cancel_batch_response = portkey.batches.cancel(batch_id="batch_id")

  print(cancel_batch_response)
  ```

  ```javascript Typescript theme={"system"}
  import { Portkey } from 'portkey-ai';

  // Initialize the Portkey client
  const portkey = new Portkey({
      apiKey: "PORTKEY_API_KEY",  // Replace with your Portkey API key
      provider:"@PROVIDER"   
  });

  const cancelBatch = async () => {
    const cancel_batch_response = await portkey.batches.cancel(batch_id="batch_id");

    console.log(cancel_batch_response);
  }

  await cancelBatch();

  ```

  ```bash curl theme={"system"}
  curl --request POST --location 'https://api.portkey.ai/v1/batches/<batch_id>/cancel' \
  --header 'x-portkey-api-key: <portkey_api_key>' \
  --header 'x-portkey-provider: @provider'
  ```

  ```javascript OpenAI NodeJS theme={"system"}
  import OpenAI from 'openai'; // We're using the v4 SDK
  import { PORTKEY_GATEWAY_URL, createHeaders } from 'portkey-ai'

  const openai = new OpenAI({
    apiKey: 'OPENAI_API_KEY', // defaults to process.env["OPENAI_API_KEY"],
    baseURL: PORTKEY_GATEWAY_URL,
    defaultHeaders: createHeaders({
      provider: "openai",
      apiKey: "PORTKEY_API_KEY" // defaults to process.env["PORTKEY_API_KEY"]
    })
  });

  const cancelBatch = async () => {
    const cancel_batch_response = await openai.batches.cancel(batch_id="batch_id");

    console.log(cancel_batch_response);
  }

  await cancelBatch();
  ```

  ```python OpenAI Python theme={"system"}
  from openai import OpenAI
  from portkey_ai import PORTKEY_GATEWAY_URL, createHeaders

  openai = OpenAI(
      api_key='OPENAI_API_KEY',
      base_url=PORTKEY_GATEWAY_URL,
      default_headers=createHeaders(
          provider="openai",
          api_key="PORTKEY_API_KEY"
      )
  )

  cancel_batch_response = openai.batches.cancel(batch_id="batch_id")

  print(cancel_batch_response)
  ```
</CodeGroup>