BatchSessions - Anchor Browser Docs

listBatchSessions

GET /v1/batch-sessions — List Batch Sessions

import { client, BatchSessions } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await BatchSessions.listBatchSessions();
console.log(result);

createBatchSession

POST /v1/batch-sessions — Create Batch Sessions

import { client, BatchSessions } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await BatchSessions.createBatchSession({
  body: {
    count: 1
  }
});
console.log(result);

getBatchSession

GET /v1/batch-sessions/{batch_id} — Get Batch Session Status

import { client, BatchSessions } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await BatchSessions.getBatchSession({
  path: {
    batch_id: 'your-batch-id'
  }
});
console.log(result);

updateBatchSession

PATCH /v1/batch-sessions/{batch_id} — Update Batch Session

import { client, BatchSessions } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await BatchSessions.updateBatchSession({
  path: {
    batch_id: 'your-batch-id'
  },
  body: {
    status: 'cancelled'
  }
});
console.log(result);

deleteBatchSession

DELETE /v1/batch-sessions/{batch_id} — Delete Batch Sessions

import { client, BatchSessions } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await BatchSessions.deleteBatchSession({
  path: {
    batch_id: 'your-batch-id'
  }
});
console.log(result);

retryBatchSession

POST /v1/batch-sessions/{batch_id}/retry — Retry Failed Batch Sessions

import { client, BatchSessions } from 'anchorbrowser';

// ANCHORBROWSER_API_KEY is read from the environment by default;
// set it explicitly like this:
client.setConfig({ auth: () => 'your-api-key' });

const result = await BatchSessions.retryBatchSession({
  path: {
    batch_id: 'your-batch-id'
  },
  body: {}
});
console.log(result);

​listBatchSessions

​createBatchSession

​getBatchSession

​updateBatchSession

​deleteBatchSession

​retryBatchSession