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.

from roe import RoeClient

client = RoeClient()

result = client.agents.list(
    page=1,  # optional
    page_size=1,  # optional
)

`agents_create`

Create a new base agent.

from roe import RoeClient

client = RoeClient()

result = client.agents.create(
    name="name",  # required
    engine_class_id="engine_class_id",  # required
    input_definitions=[{"key": "text", "data_type": "text/plain"}],  # optional
    engine_config={"model": "gpt-5.5-2026-04-23"},  # optional
    version_name="version_name",  # optional
    description="description",  # optional
)

`agents_jobs_results_create`

Get results for multiple agent jobs

from roe import RoeClient

client = RoeClient()

result = client.agents.jobs.retrieve_result_many(
    job_ids=["job_id"],
)

`agents_jobs_statuses_create`

Get status for multiple agent jobs

from roe import RoeClient

client = RoeClient()

result = client.agents.jobs.retrieve_status_many(
    job_ids=["job_id"],
)

`agents_jobs_artifacts_result_retrieve`

Get tool result artifact (result only)

from roe import RoeClient

client = RoeClient()

result = client.agents.jobs.retrieve_artifact(
    job_id="job_id",  # required
    artifact_key="artifact_key",  # required
)

`agents_jobs_references_retrieve`

Serve a reference file associated with an agent job.

from roe import RoeClient

client = RoeClient()

content = client.agents.jobs.download_reference(
    job_id="job_id",
    resource_id="resource_id",
    as_attachment=False,
)

`agents_jobs_result_retrieve`

Get agent job result data.

from roe import RoeClient

client = RoeClient()

result = client.agents.jobs.retrieve_result(
    job_id="job_id",  # required
)

`agents_jobs_cancel_create`

Cancel an agent job

from roe import RoeClient

client = RoeClient()

result = client.agents.jobs.cancel(
    job_id="job_id",  # required
)

`agents_jobs_delete_data_create`

Delete agent job data

from roe import RoeClient

client = RoeClient()

result = client.agents.jobs.delete_data(
    job_id="job_id",  # required
)

`agents_jobs_webhook_resend_create`

Resend agent job webhook

from roe import RoeClient

client = RoeClient()

result = client.agents.jobs.resend_webhook(
    job_id="job_id",  # required
    webhook_id="webhook_id",  # optional
)

`agents_jobs_status_retrieve`

Get agent job status.

from roe import RoeClient

client = RoeClient()

result = client.agents.jobs.retrieve_status(
    job_id="job_id",  # required
)

`agents_run`

Run agent synchronously

from roe import RoeClient

client = RoeClient()

result = client.agents.run_sync(
    agent_id="agent_id",
    text="text",
    metadata={},
    skip_cache=False,  # optional: True bypasses the job-result cache
)

`agents_run_async_create`

Run agent asynchronously.

from roe import RoeClient

client = RoeClient()

job = client.agents.run(
    agent_id="agent_id",
    timeout_seconds=300,
    text="text",
    metadata={},
    skip_cache=False,  # optional: True bypasses the job-result cache
)

`agents_run_async_many`

Run agent asynchronously with multiple inputs

from roe import RoeClient

client = RoeClient()

batch = client.agents.run_many(
    agent_id="agent_id",
    batch_inputs=[{"text": "text"}],
    timeout_seconds=300,
    metadata={},
    skip_cache=False,  # optional: True bypasses the job-result cache
)

`agents_run_version`

Run agent version synchronously

from roe import RoeClient

client = RoeClient()

result = client.agents.run_version_sync(
    agent_id="agent_id",
    version_id="version_id",
    text="text",
    metadata={},
    skip_cache=False,  # optional: True bypasses the job-result cache
)

`agents_run_versions_async_create`

Run agent version asynchronously.

from roe import RoeClient

client = RoeClient()

job = client.agents.run_version(
    agent_id="agent_id",
    version_id="version_id",
    timeout_seconds=300,
    text="text",
    metadata={},
    skip_cache=False,  # optional: True bypasses the job-result cache
)

`agents_destroy`

Delete a base agent.

from roe import RoeClient

client = RoeClient()

result = client.agents.delete(
    agent_id="agent_id",  # required
)

`agents_retrieve`

Retrieve an agent.

from roe import RoeClient

client = RoeClient()

result = client.agents.retrieve(
    agent_id="agent_id",  # required
)

`agents_partial_update`

Partially update an agent.

from roe import RoeClient

client = RoeClient()

result = client.agents.update(
    agent_id="agent_id",  # required
    name="name",  # optional
    disable_cache=True,  # optional
    cache_failed_jobs=True,  # optional
)

`agents_update`

Update a base agent.

from roe import RoeClient

client = RoeClient()

result = client.agents.replace(
    agent_id="agent_id",  # required
    name="name",  # optional
    disable_cache=True,  # optional
    cache_failed_jobs=True,  # optional
)

`agents_duplicate_create`

Duplicate an agent.

from roe import RoeClient

client = RoeClient()

result = client.agents.duplicate(
    agent_id="agent_id",  # required
)

`agents_jobs_list`

List agent jobs or create a new agent job.

from roe import RoeClient

client = RoeClient()

result = client.agents.jobs.list(
    agent_id="agent_id",  # required
    page=1,  # optional
    page_size=1,  # optional
    status_code="status_code",  # optional
    version_name="version_name",  # optional
    metadata="metadata",  # optional
    created_from="created_from",  # optional
    created_to="created_to",  # optional
    search="search",  # optional
    ordering="ordering",  # optional
)

`agents_jobs_cancel_all_create`

Cancel all running agent jobs (:cancelAll)

from roe import RoeClient

client = RoeClient()

result = client.agents.jobs.cancel_all(
    agent_id="agent_id",  # required
)

`agents_versions_list`

List agent versions.

from roe import RoeClient

client = RoeClient()

result = client.agents.versions.list(
    agent_id="agent_id",  # required
)

`agents_versions_create`

Create a new agent version.

from roe import RoeClient

client = RoeClient()

result = client.agents.versions.create(
    agent_id="agent_id",  # required
    input_definitions=[{"key": "text", "data_type": "text/plain"}],  # optional
    engine_config={"model": "gpt-5.5-2026-04-23"},  # optional
    version_name="version_name",  # optional
    description="description",  # optional
)

`agents_versions_current_retrieve`

Retrieve the current version of an agent.

from roe import RoeClient

client = RoeClient()

result = client.agents.versions.retrieve_current(
    agent_id="agent_id",  # required
)

`agents_versions_destroy`

Delete an agent version.

from roe import RoeClient

client = RoeClient()

result = client.agents.versions.delete(
    agent_id="agent_id",  # required
    version_id="version_id",  # required
)

`agents_versions_retrieve`

Retrieve an agent version.

from roe import RoeClient

client = RoeClient()

result = client.agents.versions.retrieve(
    agent_id="agent_id",  # required
    version_id="version_id",  # required
    get_supports_eval=True,  # optional
)

`agents_versions_partial_update`

Partially update an agent version.

from roe import RoeClient

client = RoeClient()

result = client.agents.versions.update(
    agent_id="agent_id",  # required
    version_id="version_id",  # required
    version_name="version_name",  # optional
    description="description",  # optional
)

`agents_versions_update`

Update an agent version.

from roe import RoeClient

client = RoeClient()

result = client.agents.versions.replace(
    agent_id="agent_id",  # required
    version_id="version_id",  # required
    version_name="version_name",  # optional
    description="description",  # optional
)

Connections

`connections_list`

List/create connections.

from roe import RoeClient

client = RoeClient()

result = client.connections.list(
    connector_type="connector_type",  # optional
    search="search",  # optional
    page=1,  # optional
    page_size=1,  # optional
)

`connections_create`

List/create connections.

from roe import RoeClient

client = RoeClient()

result = client.connections.create(
    connector_type="connector_type",  # required
    name="name",  # required
    config={},  # required
    description="description",  # optional
    auth_config={},  # optional
    dynamic_inputs={},  # optional
)

`connections_test_credentials_create`

Test credentials without storing them.

from roe import RoeClient

client = RoeClient()

result = client.connections.test_credentials(
    connector_type="connector_type",  # required
    config={},  # required
    auth_config={},  # optional
    dynamic_inputs={},  # optional
)

`connections_destroy`

Manage connection.

from roe import RoeClient

client = RoeClient()

result = client.connections.delete(
    connection_id="connection_id",  # required
)

`connections_retrieve`

Manage connection.

from roe import RoeClient

client = RoeClient()

result = client.connections.retrieve(
    connection_id="connection_id",  # required
)

`connections_partial_update`

Manage connection.

from roe import RoeClient

client = RoeClient()

result = client.connections.update(
    connection_id="connection_id",  # required
    name="name",  # optional
    description="description",  # optional
    config={},  # optional
    auth_config={},  # optional
    dynamic_inputs={},  # optional
)

`connections_update`

Manage connection.

from roe import RoeClient

client = RoeClient()

result = client.connections.replace(
    connection_id="connection_id",  # required
    name="name",  # optional
    description="description",  # optional
    config={},  # optional
    auth_config={},  # optional
    dynamic_inputs={},  # optional
)

`connections_test_create`

Test connection.

from roe import RoeClient

client = RoeClient()

result = client.connections.test(
    connection_id="connection_id",  # required
)

Connectors

`connectors_retrieve`

List all connector types.

from roe import RoeClient

client = RoeClient()

result = client.connectors.list()

`connectors_retrieve_by_type`

Get connector details.

from roe import RoeClient

client = RoeClient()

result = client.connectors.retrieve(
    connector_type="connector_type",  # required
)

Discovery

`discovery_supported_models_list`

List supported model IDs

from roe import RoeClient

client = RoeClient()

result = client.discovery.list_supported_models(
    capability="capability",  # optional
)

`discovery_agent_engine_types_list`

List supported agent engine types

from roe import RoeClient

client = RoeClient()

result = client.discovery.list_agent_engine_types()

Policies

`policies_list`

List all policies and create a new policy.

from roe import RoeClient

client = RoeClient()

result = client.policies.list(
    page=1,  # optional
    page_size=1,  # optional
)

`policies_create`

List all policies and create a new policy.

from roe import RoeClient

client = RoeClient()

result = client.policies.create(
    name="name",  # required
    content={},  # required
    description="description",  # optional
    version_name="version_name",  # optional
)

`policies_destroy`

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

from roe import RoeClient

client = RoeClient()

result = client.policies.delete(
    policy_id="policy_id",  # required
)

`policies_retrieve`

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

from roe import RoeClient

client = RoeClient()

result = client.policies.retrieve(
    policy_id="policy_id",  # required
)

`policies_partial_update`

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

from roe import RoeClient

client = RoeClient()

result = client.policies.update(
    policy_id="policy_id",  # required
    name="name",  # optional
    description="description",  # optional
)

`policies_update`

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

from roe import RoeClient

client = RoeClient()

result = client.policies.replace(
    policy_id="policy_id",  # required
    name="name",  # required
    description="description",  # optional
)

`policies_versions_list`

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

from roe import RoeClient

client = RoeClient()

result = client.policies.versions.list(
    policy_id="policy_id",
    page=1,
    page_size=10,
)

`policies_versions_create`

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

from roe import RoeClient

client = RoeClient()

result = client.policies.versions.create(
    policy_id="policy_id",
    content={},
    version_name="version_name",
    base_version_id="base_version_id",
)

`policies_versions_retrieve`

Get a specific policy version by policy_id and version_id.

from roe import RoeClient

client = RoeClient()

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

Skill Sets

`skill_sets_list`

List the org’s skill sets and create a new one.

from roe import RoeClient

client = RoeClient()

result = client.skill_sets.list(
    ordering="ordering",  # optional
    page=1,  # optional
    page_size=1,  # optional
    search="search",  # optional
)

`skill_sets_create`

List the org’s skill sets and create a new one.

from roe import RoeClient

client = RoeClient()

result = client.skill_sets.create(
    name="name",  # required
    description="description",  # optional
)

`skill_sets_retrieve`

Retrieve, update, or delete a single skill set.

from roe import RoeClient

client = RoeClient()

result = client.skill_sets.retrieve(
    id="id",  # required
)

`skill_sets_partial_update`

Retrieve, update, or delete a single skill set.

from roe import RoeClient

client = RoeClient()

result = client.skill_sets.update(
    id="id",  # required
    name="name",  # optional
    description="description",  # optional
)

`skill_sets_destroy`

Retrieve, update, or delete a single skill set.

from roe import RoeClient

client = RoeClient()

result = client.skill_sets.delete(
    id="id",  # required
)

`skill_sets_versions_list`

List a skill set’s versions, or create a new version.

from roe import RoeClient

client = RoeClient()

result = client.skill_sets.list_versions(
    skill_set_id="skill_set_id",  # required
    page=1,  # optional
    page_size=1,  # optional
)

`skill_sets_versions_create`

List a skill set’s versions, or create a new version.

from roe import RoeClient

client = RoeClient()

result = client.skill_sets.create_version(
    skill_set_id="skill_set_id",  # required
    files=[{"relative_path": "SKILL.md", "content": "# Skill"}],  # required
    version_name="version_name",  # optional
    base_version_id="base_version_id",  # optional
    summary="summary",  # optional
    file_changes=[{"path": "SKILL.md", "status": "edited", "note": "Updated labels"}],  # optional
)

`skill_sets_versions_retrieve`

Retrieve a version by its id, or by a set id (-> that set’s current version).

from roe import RoeClient

client = RoeClient()

result = client.skill_sets.retrieve_version(
    id="id",  # required
)

`skill_sets_set_current_version`

Point a skill set at a specific version (set-current / rollback).

from roe import RoeClient

client = RoeClient()

result = client.skill_sets.set_current_version(
    skill_set_id="skill_set_id",  # required
    version_id="version_id",  # required
)

`skill_sets_generate_version`

Author the next version of a skill set with an agent.

from roe import RoeClient

client = RoeClient()

result = client.skill_sets.generate_version(
    skill_set_id="skill_set_id",  # required
    use_case="use_case",  # required
    base_version_id="base_version_id",  # optional
    auto_commit=True,  # optional
    table_names=["value"],  # optional
    attachments=["value"],  # optional
    policy_id="policy_id",  # optional
    policy_version_id="policy_version_id",  # optional
)

`skill_sets_generation_retrieve`

Returns the last generation and its status, or generation: null when no run exists.

from roe import RoeClient

client = RoeClient()

result = client.skill_sets.get_generation(
    skill_set_id="skill_set_id",  # required
)

`skill_sets_generation_cancel`

Stop tracking a generation, cancelling it if it is still running

from roe import RoeClient

client = RoeClient()

result = client.skill_sets.cancel_generation(
    skill_set_id="skill_set_id",  # required
    run_id="run_id",  # required
)

Tables

`tables_list`

List Roe tables

from roe import RoeClient

client = RoeClient()

result = client.tables.list()

`tables_query_create`

Run a read-only Roe table query

from roe import RoeClient

client = RoeClient()

result = client.tables.query(
    sql="sql",  # required
    limit=1,  # optional
)

`tables_query_result_retrieve`

Get a Roe table query result

from roe import RoeClient

client = RoeClient()

result = client.tables.query_result(
    table_query_id="table_query_id",  # required
)

`tables_destroy`

Delete a Roe table

from roe import RoeClient

client = RoeClient()

result = client.tables.delete(
    table_name="table_name",  # required
)

`tables_describe_retrieve`

Describe a Roe table

from roe import RoeClient

client = RoeClient()

result = client.tables.describe(
    table_name="table_name",  # required
)

`tables_preview_retrieve`

Preview a Roe table

from roe import RoeClient

client = RoeClient()

result = client.tables.preview(
    table_name="table_name",  # required
    limit=1,  # optional
)

`upload_table`

Upload a CSV as a Roe table

from roe import RoeClient

client = RoeClient()

result = client.tables.upload(
    table_name="table_name",
    file="file.csv",
    with_headers=True,
)

Users

`users_current_user_retrieve`

Get the current user

from roe import RoeClient

client = RoeClient()

result = client.users.me()

Workflows

`workflows_list`

List workflows

from roe import RoeClient

client = RoeClient()

result = client.workflows.list(
    page=1,  # optional
    page_size=1,  # optional
    search="search",  # optional
)

`workflows_create`

Create a workflow

from roe import RoeClient

client = RoeClient()

result = client.workflows.create(
    name="name",  # required
    definition={"inputs": [{"key": "customer_id"}], "steps": [{"kind": "agent", "id": "check_risk", "base_agent_id": "agent_id", "agent_version_id": "version_id", "input_mapping": {"customer": "{initial.customer_id}"}}], "result": "check_risk"},  # required
    version_name="version_name",  # optional
    description="description",  # optional
)

`workflows_retrieve`

Get a workflow

from roe import RoeClient

client = RoeClient()

result = client.workflows.retrieve(
    workflow_id="workflow_id",  # required
)

`workflows_partial_update`

Rename a workflow

from roe import RoeClient

client = RoeClient()

result = client.workflows.update(
    workflow_id="workflow_id",  # required
    name="name",  # required
)

`workflows_destroy`

Delete a workflow

from roe import RoeClient

client = RoeClient()

result = client.workflows.delete(
    workflow_id="workflow_id",  # required
)

`workflows_versions_list`

List workflow versions

from roe import RoeClient

client = RoeClient()

result = client.workflows.list_versions(
    workflow_id="workflow_id",  # required
    page=1,  # optional
    page_size=1,  # optional
)

`workflows_versions_create`

Save a workflow version

from roe import RoeClient

client = RoeClient()

result = client.workflows.create_version(
    workflow_id="workflow_id",  # required
    definition={"inputs": [{"key": "customer_id"}], "steps": [{"kind": "agent", "id": "check_risk", "base_agent_id": "agent_id", "agent_version_id": "version_id", "input_mapping": {"customer": "{initial.customer_id}"}}], "result": "check_risk"},  # required
    version_name="version_name",  # optional
    description="description",  # optional
)

`workflows_versions_retrieve`

Get a workflow version

from roe import RoeClient

client = RoeClient()

result = client.workflows.retrieve_version(
    workflow_id="workflow_id",  # required
    version_id="version_id",  # required
)

`workflows_versions_set_current_create`

Set the current workflow version

from roe import RoeClient

client = RoeClient()

result = client.workflows.set_current_version(
    workflow_id="workflow_id",  # required
    version_id="version_id",  # required
)

`workflows_runs_list`

List workflow runs

from roe import RoeClient

client = RoeClient()

result = client.workflows.list_runs(
    workflow_id="workflow_id",  # required
    page=1,  # optional
    page_size=1,  # optional
    limit=1,  # optional
)

`workflows_runs_create`

Run a workflow

from roe import RoeClient

client = RoeClient()

result = client.workflows.run(
    workflow_id="workflow_id",  # required
    inputs={"customer_id": "c_1"},  # optional
    version_id="version_id",  # optional
    metadata={},  # optional
    wait=True,  # optional
)

`workflows_runs_batch_create`

Run a workflow in batch

from roe import RoeClient

client = RoeClient()

result = client.workflows.run_batch(
    workflow_id="workflow_id",  # required
    inputs=[{"customer_id": "c_1"}],  # required
    version_id="version_id",  # optional
)

`workflows_runs_retrieve`

Get a workflow run

from roe import RoeClient

client = RoeClient()

result = client.workflows.retrieve_run(
    run_id="run_id",  # required
)

​SDK operations

​Agents

​agents_list

​agents_create

​agents_jobs_results_create

​agents_jobs_statuses_create

​agents_jobs_artifacts_result_retrieve

​agents_jobs_references_retrieve

​agents_jobs_result_retrieve

​agents_jobs_cancel_create

​agents_jobs_delete_data_create

​agents_jobs_webhook_resend_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_list

​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

​Skill Sets

​skill_sets_list

​skill_sets_create

​skill_sets_retrieve

​skill_sets_partial_update

​skill_sets_destroy

​skill_sets_versions_list

​skill_sets_versions_create

​skill_sets_versions_retrieve

​skill_sets_set_current_version

​skill_sets_generate_version

​skill_sets_generation_retrieve

​skill_sets_generation_cancel

​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_artifacts_result_retrieve`

`agents_jobs_references_retrieve`

`agents_jobs_result_retrieve`

`agents_jobs_cancel_create`

`agents_jobs_delete_data_create`

`agents_jobs_webhook_resend_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_list`

`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`

Skill Sets

`skill_sets_list`

`skill_sets_create`

`skill_sets_retrieve`

`skill_sets_partial_update`

`skill_sets_destroy`

`skill_sets_versions_list`

`skill_sets_versions_create`

`skill_sets_versions_retrieve`

`skill_sets_set_current_version`

`skill_sets_generate_version`

`skill_sets_generation_retrieve`

`skill_sets_generation_cancel`

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`