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

Python SDKpython

requested = platform.exports.create({
    "resource": "events",
    "format": "json",
    "filters": {"runId": "run_checkout_001"},
})

poll = platform.exports.get(requested["exportId"])
if poll["status"] == "completed":
    artifact = platform.exports.download(requested["exportId"])
    print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

params = {}  # ListExportsParams

response = platform.exports.list(params)
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

exportId = "<exportId>"

response = platform.exports.get(exportId)
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

exportId = "<exportId>"

response = platform.exports.download(exportId)
print(response)

Response

// Response type
Promise<DownloadExportResponse>

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