feat(api): Add batches.cancel API

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 45
+configured_endpoints: 46
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai%2Ftogetherai-1afddc630f2b0684aad99bda9d83dc91ee6648a2b5cd7eac5d42fdc9ff46bbfc.yml
 openapi_spec_hash: a4cab3a8559f632b66ea7aabd40cd8aa
-config_hash: 5e9563faf41fd9a91bea97783683bdb2
+config_hash: eb8d7493024f64839cec7401a9451c78

api.md

@@ -253,12 +253,14 @@ Types:
 - <code><a href="./src/resources/batches.ts">BatchCreateResponse</a></code>
 - <code><a href="./src/resources/batches.ts">BatchRetrieveResponse</a></code>
 - <code><a href="./src/resources/batches.ts">BatchListResponse</a></code>
+- <code><a href="./src/resources/batches.ts">BatchCancelResponse</a></code>
 
 Methods:
 
 - <code title="post /batches">client.batches.<a href="./src/resources/batches.ts">create</a>({ ...params }) -> BatchCreateResponse</code>
 - <code title="get /batches/{id}">client.batches.<a href="./src/resources/batches.ts">retrieve</a>(id) -> BatchRetrieveResponse</code>
 - <code title="get /batches">client.batches.<a href="./src/resources/batches.ts">list</a>() -> BatchListResponse</code>
+- <code title="post /batches/{id}/cancel">client.batches.<a href="./src/resources/batches.ts">cancel</a>(id) -> BatchCancelResponse</code>
 
 # Evals
 

src/client.ts

@@ -19,6 +19,7 @@ import * as TopLevelAPI from './resources/top-level';
 import { RerankParams, RerankResponse } from './resources/top-level';
 import { APIPromise } from './core/api-promise';
 import {
+  BatchCancelResponse,
   BatchCreateParams,
   BatchCreateResponse,
   BatchListResponse,
@@ -987,6 +988,7 @@ export declare namespace Together {
     type BatchCreateResponse as BatchCreateResponse,
     type BatchRetrieveResponse as BatchRetrieveResponse,
     type BatchListResponse as BatchListResponse,
+    type BatchCancelResponse as BatchCancelResponse,
     type BatchCreateParams as BatchCreateParams,
   };
 

src/resources/batches.ts

@@ -46,6 +46,20 @@ export class Batches extends APIResource {
   list(options?: RequestOptions): APIPromise<BatchListResponse> {
     return this._client.get('/batches', options);
   }
+
+  /**
+   * Cancel a batch job by ID
+   *
+   * @example
+   * ```ts
+   * const response = await client.batches.cancel(
+   *   'batch_job_abc123def456',
+   * );
+   * ```
+   */
+  cancel(id: string, options?: RequestOptions): APIPromise<BatchCancelResponse> {
+    return this._client.post(path`/batches/${id}/cancel`, options);
+  }
 }
 
 export interface BatchCreateResponse {
@@ -186,6 +200,48 @@ export namespace BatchListResponse {
   }
 }
 
+export interface BatchCancelResponse {
+  id?: string;
+
+  completed_at?: string;
+
+  created_at?: string;
+
+  endpoint?: string;
+
+  error?: string;
+
+  error_file_id?: string;
+
+  /**
+   * Size of input file in bytes
+   */
+  file_size_bytes?: number;
+
+  input_file_id?: string;
+
+  job_deadline?: string;
+
+  /**
+   * Model used for processing requests
+   */
+  model_id?: string;
+
+  output_file_id?: string;
+
+  /**
+   * Completion progress (0.0 to 100)
+   */
+  progress?: number;
+
+  /**
+   * Current status of the batch job
+   */
+  status?: 'VALIDATING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'EXPIRED' | 'CANCELLED';
+
+  user_id?: string;
+}
+
 export interface BatchCreateParams {
   /**
    * The endpoint to use for batch processing
@@ -218,6 +274,7 @@ export declare namespace Batches {
     type BatchCreateResponse as BatchCreateResponse,
     type BatchRetrieveResponse as BatchRetrieveResponse,
     type BatchListResponse as BatchListResponse,
+    type BatchCancelResponse as BatchCancelResponse,
     type BatchCreateParams as BatchCreateParams,
   };
 }

src/resources/index.ts

@@ -13,6 +13,7 @@ export {
   type BatchCreateResponse,
   type BatchRetrieveResponse,
   type BatchListResponse,
+  type BatchCancelResponse,
   type BatchCreateParams,
 } from './batches';
 export { Chat } from './chat/chat';

tests/api-resources/batches.test.ts

@@ -53,4 +53,15 @@ describe('resource batches', () => {
     expect(dataAndResponse.data).toBe(response);
     expect(dataAndResponse.response).toBe(rawResponse);
   });
+
+  test('cancel', async () => {
+    const responsePromise = client.batches.cancel('batch_job_abc123def456');
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
 });