Platform API ClientClient group4 methodsGraphsMethods

Graphs

Access causal graph snapshots, commit immutable root hashes, and pull lineage views with optional node scoping.

Graph retrievalCommit root hashLineage traversal

Graphs

graphs.list()

Generated exampleHTTP endpoint wrapperGET /api/v1/graphs

GET /api/v1/graphs

Signature

list(params?: GraphListParams): Promise<GraphListResponse>

Parameters

Name	Type	Flags
params	GraphListParams	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 GraphListParams;
// Fill the params payload fields before calling this method.

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

Response

// Response type
Promise<GraphListResponse>

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

graphs.get()

Generated exampleHTTP endpoint wrapperGET /api/v1/graphs/{runId}

GET /api/v1/graphs/{runId}

Signature

get(runId: string): Promise<CausalGraphResponse>

Parameters

Name	Type	Flags
runId	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 runId = "<runId>";

const response = await client.graphs.get(runId);
console.log(response);

Response

// Response type
Promise<CausalGraphResponse>

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

graphs.commit()

Generated exampleHTTP endpoint wrapperPOST /api/v1/graphs/{runId}/commit

POST /api/v1/graphs/{runId}/commit

Signature

commit(runId: string): Promise<GraphCommitResponse>

Parameters

Name	Type	Flags
runId	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 runId = "<runId>";

const response = await client.graphs.commit(runId);
console.log(response);

Response

// Response type
Promise<GraphCommitResponse>

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

graphs.lineage()

Generated exampleHTTP endpoint wrapperGET /api/v1/graphs/{runId}/lineage

GET /api/v1/graphs/{runId}/lineage

Signature

lineage(runId: string, nodeId?: string): Promise<GraphLineageResponse>

Parameters

Name	Type	Flags
runId	string	required
nodeId	string	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 runId = "<runId>";
const nodeId = "<nodeId>";

const response = await client.graphs.lineage(runId, nodeId);
console.log(response);

Response

// Response type
Promise<GraphLineageResponse>

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