Examples - Roe Documentation

SDK operations

Copy-ready calls for each operation available through this SDK. Required and optional inputs are shown inline in the code.

Agents

`agents_list`

List agents or create a new agent.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.list(
  {
    page: 1, // optional
    pageSize: 1, // optional
  }
);

`agents_create`

Create a new base agent.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.create(
  {
    name: "name", // required
    engineClassId: "engineClassId", // required
    inputDefinitions: [{ key: "text", data_type: "text/plain" }], // optional
    engineConfig: { model: "gpt-4.1" }, // optional
    versionName: "versionName", // optional
    description: "description", // optional
  }
);

`agents_jobs_results_create`

Get results for multiple agent jobs

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.jobs.retrieveResultMany(["job_id"]);

`agents_jobs_statuses_create`

Get status for multiple agent jobs

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.jobs.retrieveStatusMany(["job_id"]);

`agents_jobs_references_retrieve`

Serve a reference file associated with an agent job.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const content = await client.agents.jobs.downloadReference(
  "job_id",
  "resource_id",
  false,
);

`agents_jobs_result_retrieve`

Get agent job result data.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.jobs.retrieveResult("jobId");

`agents_jobs_cancel_create`

Cancel an agent job

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.jobs.cancel("jobId");

`agents_jobs_delete_data_create`

Delete agent job data

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.jobs.deleteData("jobId");

`agents_jobs_status_retrieve`

Get agent job status.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.jobs.retrieveStatus("jobId");

`agents_run`

Run agent synchronously

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.runSync(
  "agent_id",
  { text: "text" },
  {},
);

`agents_run_async_create`

Run agent asynchronously.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const job = await client.agents.run({
  agentId: "agent_id",
  inputs: { text: "text" },
  timeoutSeconds: 300,
  metadata: {},
});

`agents_run_async_many`

Run agent asynchronously with multiple inputs

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const batch = await client.agents.runMany({
  agentId: "agent_id",
  batchInputs: [{ text: "text" }],
  timeoutSeconds: 300,
});

`agents_run_version`

Run agent version synchronously

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.runVersionSync(
  "agent_id",
  "version_id",
  { text: "text" },
  {},
);

`agents_run_versions_async_create`

Run agent version asynchronously.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const job = await client.agents.runVersion({
  agentId: "agent_id",
  versionId: "version_id",
  inputs: { text: "text" },
  timeoutSeconds: 300,
  metadata: {},
});

`agents_destroy`

Delete a base agent.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.delete("agentId");

`agents_retrieve`

Retrieve an agent.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.retrieve("agentId");

`agents_partial_update`

Partially update an agent.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.update(
  "agentId",
  {
    name: "name", // optional
    disableCache: true, // optional
    cacheFailedJobs: true, // optional
  }
);

`agents_update`

Update a base agent.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.replace(
  "agentId",
  {
    name: "name", // optional
    disableCache: true, // optional
    cacheFailedJobs: true, // optional
  }
);

`agents_duplicate_create`

Duplicate an agent.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.duplicate("agentId");

`agents_jobs_cancel_all_create`

Cancel all agent jobs

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.jobs.cancelAll("agentId");

`agents_versions_list`

List agent versions.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.versions.list("agentId");

`agents_versions_create`

Create a new agent version.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.versions.create(
  {
    agentId: "agentId", // required
    inputDefinitions: [{ key: "text", data_type: "text/plain" }], // optional
    engineConfig: { model: "gpt-4.1" }, // optional
    versionName: "versionName", // optional
    description: "description", // optional
  }
);

`agents_versions_current_retrieve`

Retrieve the current version of an agent.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.versions.retrieveCurrent("agentId");

`agents_versions_destroy`

Delete an agent version.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.versions.delete(
  "agentId",
  "versionId",
);

`agents_versions_retrieve`

Retrieve an agent version.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.versions.retrieve(
  "agentId",
  "versionId",
  true,
);

`agents_versions_partial_update`

Partially update an agent version.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.versions.update(
  "agentId",
  "versionId",
  {
    versionName: "versionName", // optional
    description: "description", // optional
  }
);

`agents_versions_update`

Update an agent version.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.agents.versions.replace(
  "agentId",
  "versionId",
  {
    versionName: "versionName", // optional
    description: "description", // optional
  }
);

Connections

`connections_list`

List/create connections.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.connections.list(
  {
    connectorType: "connectorType", // optional
    search: "search", // optional
    page: 1, // optional
    pageSize: 1, // optional
  }
);

`connections_create`

List/create connections.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.connections.create(
  {
    connectorType: "connectorType", // required
    name: "name", // required
    config: {}, // required
    description: "description", // optional
    authConfig: {}, // optional
  }
);

`connections_test_credentials_create`

Test credentials without storing them.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.connections.testCredentials(
  {
    connectorType: "connectorType", // required
    config: {}, // required
    authConfig: {}, // optional
  }
);

`connections_destroy`

Manage connection.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.connections.delete("connectionId");

`connections_retrieve`

Manage connection.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.connections.retrieve("connectionId");

`connections_partial_update`

Manage connection.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.connections.update(
  "connectionId",
  {
    name: "name", // optional
    description: "description", // optional
    config: {}, // optional
    authConfig: {}, // optional
  }
);

`connections_update`

Manage connection.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.connections.replace(
  "connectionId",
  {
    name: "name", // optional
    description: "description", // optional
    config: {}, // optional
    authConfig: {}, // optional
  }
);

`connections_test_create`

Test connection.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.connections.test("connectionId");

Connectors

`connectors_retrieve`

List all connector types.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.connectors.list();

`connectors_retrieve_by_type`

Get connector details.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.connectors.retrieve("connectorType");

Discovery

`discovery_supported_models_list`

List supported model IDs

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.discovery.listSupportedModels("capability");

`discovery_agent_engine_types_list`

List supported agent engine types

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.discovery.listAgentEngineTypes();

Policies

`policies_list`

List all policies and create a new policy.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.policies.list(
  {
    page: 1, // optional
    pageSize: 1, // optional
  }
);

`policies_create`

List all policies and create a new policy.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.policies.create(
  {
    name: "name", // required
    content: {}, // required
    description: "description", // optional
    versionName: "versionName", // optional
  }
);

`policies_destroy`

Retrieve, update, or delete a single policy by ID.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.policies.delete("policyId");

`policies_retrieve`

Retrieve, update, or delete a single policy by ID.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.policies.retrieve("policyId");

`policies_partial_update`

Retrieve, update, or delete a single policy by ID.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.policies.update(
  "policyId",
  {
    name: "name", // optional
    description: "description", // optional
  }
);

`policies_update`

Retrieve, update, or delete a single policy by ID.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.policies.replace(
  "policyId",
  {
    name: "name", // required
    description: "description", // optional
  }
);

`policies_versions_list`

Create a new policy version or list all versions of a specific policy.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.policies.versions.list("policy_id");

`policies_versions_create`

Create a new policy version or list all versions of a specific policy.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.policies.versions.create({
  policyId: "policy_id",
  content: {},
  versionName: "version_name",
  baseVersionId: "base_version_id",
});

`policies_versions_retrieve`

Get a specific policy version by policy_id and version_id.

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.policies.versions.retrieve(
  "policy_id",
  "version_id",
);

Tables

`tables_list`

List Roe tables

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.tables.list();

`tables_query_create`

Run a read-only Roe table query

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.tables.query(
  {
    sql: "sql", // required
    limit: 1, // optional
  }
);

`tables_query_result_retrieve`

Get a Roe table query result

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.tables.queryResult("tableQueryId");

`tables_destroy`

Delete a Roe table

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.tables.delete("tableName");

`tables_describe_retrieve`

Describe a Roe table

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.tables.describe("tableName");

`tables_preview_retrieve`

Preview a Roe table

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.tables.preview(
  "tableName",
  {
    limit: 1, // optional
  }
);

`upload_table`

Upload a CSV as a Roe table

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.tables.upload(
  {
    tableName: "table_name",
    file: "file.csv",
    withHeaders: true,
  }
);

Users

`users_current_user_retrieve`

Get the current user

import { RoeClient } from "roe-typescript";

const client = new RoeClient();

const result = await client.users.me();

​SDK operations

​Agents

​agents_list

​agents_create

​agents_jobs_results_create

​agents_jobs_statuses_create

​agents_jobs_references_retrieve

​agents_jobs_result_retrieve

​agents_jobs_cancel_create

​agents_jobs_delete_data_create

​agents_jobs_status_retrieve

​agents_run

​agents_run_async_create

​agents_run_async_many

​agents_run_version

​agents_run_versions_async_create

​agents_destroy

​agents_retrieve

​agents_partial_update

​agents_update

​agents_duplicate_create

​agents_jobs_cancel_all_create

​agents_versions_list

​agents_versions_create

​agents_versions_current_retrieve

​agents_versions_destroy

​agents_versions_retrieve

​agents_versions_partial_update

​agents_versions_update

​Connections

​connections_list

​connections_create

​connections_test_credentials_create

​connections_destroy

​connections_retrieve

​connections_partial_update

​connections_update

​connections_test_create

​Connectors

​connectors_retrieve

​connectors_retrieve_by_type

​Discovery

​discovery_supported_models_list

​discovery_agent_engine_types_list

​Policies

​policies_list

​policies_create

​policies_destroy

​policies_retrieve

​policies_partial_update

​policies_update

​policies_versions_list

​policies_versions_create

​policies_versions_retrieve

​Tables

​tables_list

​tables_query_create

​tables_query_result_retrieve

​tables_destroy

​tables_describe_retrieve

​tables_preview_retrieve

​upload_table

​Users

​users_current_user_retrieve

SDK operations

Agents

`agents_list`

`agents_create`

`agents_jobs_results_create`

`agents_jobs_statuses_create`

`agents_jobs_references_retrieve`

`agents_jobs_result_retrieve`

`agents_jobs_cancel_create`

`agents_jobs_delete_data_create`

`agents_jobs_status_retrieve`

`agents_run`

`agents_run_async_create`

`agents_run_async_many`

`agents_run_version`

`agents_run_versions_async_create`

`agents_destroy`

`agents_retrieve`

`agents_partial_update`

`agents_update`

`agents_duplicate_create`

`agents_jobs_cancel_all_create`

`agents_versions_list`

`agents_versions_create`

`agents_versions_current_retrieve`

`agents_versions_destroy`

`agents_versions_retrieve`

`agents_versions_partial_update`

`agents_versions_update`

Connections

`connections_list`

`connections_create`

`connections_test_credentials_create`

`connections_destroy`

`connections_retrieve`

`connections_partial_update`

`connections_update`

`connections_test_create`

Connectors

`connectors_retrieve`

`connectors_retrieve_by_type`

Discovery

`discovery_supported_models_list`

`discovery_agent_engine_types_list`

Policies

`policies_list`

`policies_create`

`policies_destroy`

`policies_retrieve`

`policies_partial_update`

`policies_update`

`policies_versions_list`

`policies_versions_create`

`policies_versions_retrieve`

Tables

`tables_list`

`tables_query_create`

`tables_query_result_retrieve`

`tables_destroy`

`tables_describe_retrieve`

`tables_preview_retrieve`

`upload_table`

Users

`users_current_user_retrieve`