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()

Knowledge Base

`knowledge_base_list`

List all KBs for the org, or start a new draft.

from roe import RoeClient

client = RoeClient()

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

`knowledge_base_create`

List all KBs for the org, or start a new draft.

from roe import RoeClient

client = RoeClient()

result = client.knowledge_base.create(
    company="company",
    brief="brief",
)

`knowledge_base_catalog_retrieve`

Names-only typology+tactic catalog.

from roe import RoeClient

client = RoeClient()

result = client.knowledge_base.catalog()

`knowledge_base_import_lens_create`

Import a finalized Atlas lens into roe-main by its atlas_lens_id.

from roe import RoeClient

client = RoeClient()

result = client.knowledge_base.import_lens("atlas_lens_id")

`knowledge_base_lens_retrieve`

Fetch a lens directly from Atlas by its atlas_lens_id and return the names-only projection.

from roe import RoeClient

client = RoeClient()

result = client.knowledge_base.lens_by_atlas_id("atlas_lens_id")

`knowledge_base_destroy`

Get or delete a single KB.

from roe import RoeClient

client = RoeClient()

client.knowledge_base.delete("knowledge_base_id")

`knowledge_base_retrieve`

Get or delete a single KB.

from roe import RoeClient

client = RoeClient()

result = client.knowledge_base.retrieve("knowledge_base_id")

`knowledge_base_draft_retrieve`

Poll the atlas draft.

from roe import RoeClient

client = RoeClient()

result = client.knowledge_base.poll_draft("knowledge_base_id")

`knowledge_base_finalize_create`

Commit the agreed selection into a lens and mark the KB active.

from roe import RoeClient

client = RoeClient()

result = client.knowledge_base.finalize("knowledge_base_id")

`knowledge_base_regenerate_create`

Kick off another async generation round with feedback.

from roe import RoeClient

client = RoeClient()

result = client.knowledge_base.regenerate("knowledge_base_id")

`knowledge_base_resolve_create`

Approve or decline a pending regeneration proposal.

from roe import RoeClient

client = RoeClient()

result = client.knowledge_base.resolve("knowledge_base_id")

`knowledge_base_selection_partial_update`

Persist hand-edits to the working selection (typology + tactic opt-in/out).

from roe import RoeClient

client = RoeClient()

result = client.knowledge_base.patch_selection(
    "knowledge_base_id",
    refs=[],
)

`knowledge_base_sync_create`

Standalone best-effort lens sync (display mode).

from roe import RoeClient

client = RoeClient()

result = client.knowledge_base.sync("knowledge_base_id")

`knowledge_base_unlink_destroy`

Unlink a knowledge base: remove the local KnowledgeBase row only, leaving the Atlas lens (and any in-progress draft) untouched.

from roe import RoeClient

client = RoeClient()

client.knowledge_base.unlink("knowledge_base_id")

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",
)

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()

​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

​Knowledge Base

​knowledge_base_list

​knowledge_base_create

​knowledge_base_catalog_retrieve

​knowledge_base_import_lens_create

​knowledge_base_lens_retrieve

​knowledge_base_destroy

​knowledge_base_retrieve

​knowledge_base_draft_retrieve

​knowledge_base_finalize_create

​knowledge_base_regenerate_create

​knowledge_base_resolve_create

​knowledge_base_selection_partial_update

​knowledge_base_sync_create

​knowledge_base_unlink_destroy

​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

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`

Knowledge Base

`knowledge_base_list`

`knowledge_base_create`

`knowledge_base_catalog_retrieve`

`knowledge_base_import_lens_create`

`knowledge_base_lens_retrieve`

`knowledge_base_destroy`

`knowledge_base_retrieve`

`knowledge_base_draft_retrieve`

`knowledge_base_finalize_create`

`knowledge_base_regenerate_create`

`knowledge_base_resolve_create`

`knowledge_base_selection_partial_update`

`knowledge_base_sync_create`

`knowledge_base_unlink_destroy`

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`