Platform API ClientClient group4 methodsExportMethods

Exports

Generate asynchronous export artifacts, track export processing state, and download completed files.

Export jobsArtifact metadataDownload endpoint

Exports

exports.create()

Curated exampleHTTP endpoint wrapperPOST /api/v1/exports

POST /api/v1/exports

Signature

create(input: CreateExportInput): Promise<CreateExportResponse>

Parameters

Name	Type	Flags
input	CreateExportInput	required

TypeScript SDKTypeScript

const requested = await client.exports.create({
  resource: "events",
  format: "json",
  filters: { runId: "run_checkout_001" },
});

const poll = await client.exports.get(requested.exportId);
if (poll.status === "completed") {
  const artifact = await client.exports.download(requested.exportId);
  console.log(artifact.fileName, artifact.mimeType);
}

Response

{
  "exportId": "exp_01JAZ3V26T8C5DHR4S1KVTQ4QG",
  "resource": "events",
  "format": "json",
  "status": "pending",
  "createdAt": "2026-02-11T21:12:08.000Z"
}

exports.list()

Generated exampleHTTP endpoint wrapperGET /api/v1/exports

GET /api/v1/exports

Signature

list(params?: ListExportsParams): Promise<ListExportsResponse>

Parameters

Name	Type	Flags
params	ListExportsParams	optional

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const params = {} as ListExportsParams;
// Fill the params payload fields before calling this method.

const response = await client.exports.list(params);
console.log(response);

Response

// Response type
Promise<ListExportsResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

exports.get()

Generated exampleHTTP endpoint wrapperGET /api/v1/exports/{exportId}

GET /api/v1/exports/{exportId}

Signature

get(exportId: string): Promise<ExportDetailRecord>

Parameters

Name	Type	Flags
exportId	string	required

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const exportId = "<exportId>";

const response = await client.exports.get(exportId);
console.log(response);

Response

// Response type
Promise<ExportDetailRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

exports.download()

Generated exampleHTTP endpoint wrapperGET /api/v1/exports/{exportId}/download

GET /api/v1/exports/{exportId}/download

Signature

download(exportId: string): Promise<DownloadExportResponse>

Parameters

Name	Type	Flags
exportId	string	required

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const exportId = "<exportId>";

const response = await client.exports.download(exportId);
console.log(response);

Response

// Response type
Promise<DownloadExportResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));