Platform API ClientClient group10 methodsReplayMethods

Replay

Start replay jobs, compare baseline and candidate runs, and manage reusable replay snapshot templates.

Async replay jobsTemplate lifecycleReplay comparisons

Replay

replay.start()

Curated exampleHTTP endpoint wrapperPOST /api/v1/replay

POST /api/v1/replay

Signature

start(request: ReplayRequest): Promise<AsyncJobResponse>

Parameters

Name	Type	Flags
request	ReplayRequest	required

Python SDKpython

replay_job = platform.replay.start({
    "runId": "run_checkout_001",
    "replaySnapshot": {
        "policyHash": "cb2f28...",
        "modelRoute": "gpt-4o",
        "toolRegistryHash": "9b1ec8...",
        "configStateHash": "60d89f...",
    },
})

status = platform.jobs.get(replay_job["jobId"])
print(status["status"])

Response

{
  "jobId": "job_01JAZ3TFG3M8G8PWH8DYP4T7G8"
}

replay.startCausalGraph()

Generated exampleHTTP endpoint wrapperPOST /api/v1/replay/causal-graph

POST /api/v1/replay/causal-graph

Signature

startCausalGraph(request: CausalGraphReplayRequest): Promise<AsyncJobResponse>

Parameters

Name	Type	Flags
request	CausalGraphReplayRequest	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"],
})

request = {}  # CausalGraphReplayRequest

response = platform.replay.startCausalGraph(request)
print(response)

Response

// Response type
Promise<AsyncJobResponse>

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

replay.get()

Generated exampleHTTP endpoint wrapperGET /api/v1/replay/{replayId}

GET /api/v1/replay/{replayId}

Signature

get(replayId: string): Promise<ReplayResultResponse>

Parameters

Name	Type	Flags
replayId	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"],
})

replayId = "<replayId>"

response = platform.replay.get(replayId)
print(response)

Response

// Response type
Promise<ReplayResultResponse>

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

replay.list()

Generated exampleHTTP endpoint wrapperGET /api/v1/replay

GET /api/v1/replay

Signature

list(params?: ReplayListParams): Promise<ReplayListResponse>

Parameters

Name	Type	Flags
params	ReplayListParams	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 = {}  # ReplayListParams

response = platform.replay.list(params)
print(response)

Response

// Response type
Promise<ReplayListResponse>

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

replay.createTemplate()

Generated exampleHTTP endpoint wrapperPOST /api/v1/replay/templates

POST /api/v1/replay/templates

Signature

createTemplate(input: ReplayTemplateInput): Promise<ReplayTemplate>

Parameters

Name	Type	Flags
input	ReplayTemplateInput	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"],
})

input = {}  # ReplayTemplateInput

response = platform.replay.createTemplate(input)
print(response)

Response

// Response type
Promise<ReplayTemplate>

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

replay.listTemplates()

Generated exampleHTTP endpoint wrapperGET /api/v1/replay/templates

GET /api/v1/replay/templates

Signature

listTemplates(params?: {
    runId?: string;
    cursor?: string;
    limit?: number;
  }): Promise<ReplayTemplateListResponse>

Parameters

Name	Type	Flags
params	{ runId?: string; cursor?: string; limit?: number; }	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 = {}  # {
    runId?: string;
    cursor?: string;
    limit?: number;
  }

response = platform.replay.listTemplates(params)
print(response)

Response

// Response type
Promise<ReplayTemplateListResponse>

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

replay.getTemplate()

Generated exampleHTTP endpoint wrapperGET /api/v1/replay/templates/{templateId}

GET /api/v1/replay/templates/{templateId}

Signature

getTemplate(templateId: string): Promise<ReplayTemplate>

Parameters

Name	Type	Flags
templateId	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"],
})

templateId = "<templateId>"

response = platform.replay.getTemplate(templateId)
print(response)

Response

// Response type
Promise<ReplayTemplate>

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

replay.updateTemplate()

Generated exampleHTTP endpoint wrapperPUT /api/v1/replay/templates/{templateId}

PUT /api/v1/replay/templates/{templateId}

Signature

updateTemplate(templateId: string, input: Partial<ReplayTemplateInput> & {
    runId?: string | null;
  }): Promise<ReplayTemplate>

Parameters

Name	Type	Flags
templateId	string	required
input	Partial<ReplayTemplateInput> & { runId?: string \| null; }	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"],
})

templateId = "<templateId>"
input = {}  # Partial<ReplayTemplateInput> & {
    runId?: string | null;
  }

response = platform.replay.updateTemplate(templateId, input)
print(response)

Response

// Response type
Promise<ReplayTemplate>

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

replay.deleteTemplate()

Generated exampleHTTP endpoint wrapperDELETE /api/v1/replay/templates/{templateId}

DELETE /api/v1/replay/templates/{templateId}

Signature

deleteTemplate(templateId: string): Promise<{ deleted: boolean }>

Parameters

Name	Type	Flags
templateId	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"],
})

templateId = "<templateId>"

response = platform.replay.deleteTemplate(templateId)
print(response)

Response

// Response type
Promise<{ deleted: boolean }>

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

replay.compare()

Generated exampleHTTP endpoint wrapperPOST /api/v1/replay/compare

POST /api/v1/replay/compare

Signature

compare(input: ReplayCompareInput): Promise<ReplayCompareResponse>

Parameters

Name	Type	Flags
input	ReplayCompareInput	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"],
})

input = {}  # ReplayCompareInput

response = platform.replay.compare(input)
print(response)

Response

// Response type
Promise<ReplayCompareResponse>

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