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.

result, err := client.Agents.List(
    1,
    1,
)
if err != nil {
    log.Fatal(err)
}

`agents_create`

Create a new base agent.

result, err := client.Agents.Create(
    "name",
    "engineClassID",
    []map[string]any{{"key": "text", "data_type": "text/plain"}},
    map[string]any{"model": "gpt-5.5-2026-04-23"},
    "versionName",
    "description",
)
if err != nil {
    log.Fatal(err)
}

`agents_jobs_results_create`

Get results for multiple agent jobs

result, err := client.Agents.Jobs.RetrieveResultMany([]string{"job_id"})
if err != nil {
    log.Fatal(err)
}

`agents_jobs_statuses_create`

Get status for multiple agent jobs

result, err := client.Agents.Jobs.RetrieveStatusMany([]string{"job_id"})
if err != nil {
    log.Fatal(err)
}

`agents_jobs_artifacts_result_retrieve`

Get tool result artifact (result only)

result, err := client.Agents.Jobs.RetrieveArtifact(
    "jobID",
    "artifactKey",
)
if err != nil {
    log.Fatal(err)
}

`agents_jobs_references_retrieve`

Serve a reference file associated with an agent job.

content, err := client.Agents.Jobs.DownloadReference(
    "job_id",
    "resource_id",
    false,
)
if err != nil {
    log.Fatal(err)
}

`agents_jobs_result_retrieve`

Get agent job result data.

result, err := client.Agents.Jobs.RetrieveResult(
    "jobID",
)
if err != nil {
    log.Fatal(err)
}

`agents_jobs_cancel_create`

Cancel an agent job

err := client.Agents.Jobs.Cancel(
    "jobID",
)
if err != nil {
    log.Fatal(err)
}

`agents_jobs_delete_data_create`

Delete agent job data

result, err := client.Agents.Jobs.DeleteData(
    "jobID",
)
if err != nil {
    log.Fatal(err)
}

`agents_jobs_status_retrieve`

Get agent job status.

result, err := client.Agents.Jobs.RetrieveStatus(
    "jobID",
)
if err != nil {
    log.Fatal(err)
}

`agents_run`

Run agent synchronously

result, err := client.Agents.RunSync(
    "agent_id",
    map[string]any{"text": "text"},
    map[string]any{},
)
if err != nil {
    log.Fatal(err)
}

`agents_run_async_create`

Run agent asynchronously.

job, err := client.Agents.Run(
    "agent_id",
    300,
    map[string]any{"text": "text"},
    map[string]any{},
)
if err != nil {
    log.Fatal(err)
}

`agents_run_async_many`

Run agent asynchronously with multiple inputs

batch, err := client.Agents.RunMany(
    "agent_id",
    []map[string]any{{"text": "text"}},
    300,
    map[string]any{},
)
if err != nil {
    log.Fatal(err)
}

`agents_run_version`

Run agent version synchronously

result, err := client.Agents.RunVersionSync(
    "agent_id",
    "version_id",
    map[string]any{"text": "text"},
    map[string]any{},
)
if err != nil {
    log.Fatal(err)
}

`agents_run_versions_async_create`

Run agent version asynchronously.

job, err := client.Agents.RunVersion(
    "agent_id",
    "version_id",
    300,
    map[string]any{"text": "text"},
    map[string]any{},
)
if err != nil {
    log.Fatal(err)
}

`agents_destroy`

Delete a base agent.

err := client.Agents.Delete(
    "agentID",
)
if err != nil {
    log.Fatal(err)
}

`agents_retrieve`

Retrieve an agent.

result, err := client.Agents.Retrieve(
    "agentID",
)
if err != nil {
    log.Fatal(err)
}

`agents_partial_update`

Partially update an agent.

result, err := client.Agents.Update(
    "agentID",
    "name",
    &[]bool{true}[0],
    &[]bool{true}[0],
)
if err != nil {
    log.Fatal(err)
}

`agents_update`

Update a base agent.

result, err := client.Agents.Replace(
    "agentID",
    "name",
    &[]bool{true}[0],
    &[]bool{true}[0],
)
if err != nil {
    log.Fatal(err)
}

`agents_duplicate_create`

Duplicate an agent.

result, err := client.Agents.Duplicate("agent_id")
if err != nil {
    log.Fatal(err)
}

`agents_jobs_list`

List agent jobs or create a new agent job.

result, err := client.Agents.Jobs.ListJobs(
    "agentID",
    1,
    1,
    "statusCode",
    "versionName",
    "metadata",
    "createdFrom",
    "createdTo",
    "search",
    "ordering",
)
if err != nil {
    log.Fatal(err)
}

`agents_jobs_cancel_all_create`

Cancel all running agent jobs (:cancelAll)

err := client.Agents.Jobs.CancelAll(
    "agentID",
)
if err != nil {
    log.Fatal(err)
}

`agents_versions_list`

List agent versions.

params := &roe.ListVersionsParams{Page: 1, PageSize: 10}

result, err := client.Agents.Versions.ListPaginated(
    "agent_id",
    params,
)
if err != nil {
    log.Fatal(err)
}

`agents_versions_create`

Create a new agent version.

result, err := client.Agents.Versions.Create(
    "agentID",
    []map[string]any{{"key": "text", "data_type": "text/plain"}},
    map[string]any{"model": "gpt-5.5-2026-04-23"},
    "versionName",
    "description",
)
if err != nil {
    log.Fatal(err)
}

`agents_versions_current_retrieve`

Retrieve the current version of an agent.

getSupportsEval := true

result, err := client.Agents.Versions.RetrieveCurrentWithEval(
    "agent_id",
    &getSupportsEval,
)
if err != nil {
    log.Fatal(err)
}

`agents_versions_destroy`

Delete an agent version.

err := client.Agents.Versions.Delete(
    "agentID",
    "versionID",
)
if err != nil {
    log.Fatal(err)
}

`agents_versions_retrieve`

Retrieve an agent version.

result, err := client.Agents.Versions.Retrieve(
    "agentID",
    "versionID",
    &[]bool{true}[0],
)
if err != nil {
    log.Fatal(err)
}

`agents_versions_partial_update`

Partially update an agent version.

err := client.Agents.Versions.Update(
    "agentID",
    "versionID",
    "versionName",
    "description",
)
if err != nil {
    log.Fatal(err)
}

`agents_versions_update`

Update an agent version.

err := client.Agents.Versions.Replace(
    "agentID",
    "versionID",
    "versionName",
    "description",
)
if err != nil {
    log.Fatal(err)
}

Connections

`connections_list`

List/create connections.

result, err := client.Connections.List(
    "connectorType",
    "search",
    1,
    1,
)
if err != nil {
    log.Fatal(err)
}

`connections_create`

List/create connections.

result, err := client.Connections.Create(
    "connectorType",
    "name",
    map[string]any{},
    "description",
    map[string]any{},
)
if err != nil {
    log.Fatal(err)
}

`connections_test_credentials_create`

Test credentials without storing them.

result, err := client.Connections.TestCredentials(
    "connectorType",
    map[string]any{},
    map[string]any{},
)
if err != nil {
    log.Fatal(err)
}

`connections_destroy`

Manage connection.

err := client.Connections.Delete(
    "connectionID",
)
if err != nil {
    log.Fatal(err)
}

`connections_retrieve`

Manage connection.

result, err := client.Connections.Retrieve(
    "connectionID",
)
if err != nil {
    log.Fatal(err)
}

`connections_partial_update`

Manage connection.

result, err := client.Connections.Update(
    "connectionID",
    "name",
    "description",
    map[string]any{},
    map[string]any{},
)
if err != nil {
    log.Fatal(err)
}

`connections_update`

Manage connection.

result, err := client.Connections.Replace(
    "connectionID",
    "name",
    "description",
    map[string]any{},
    map[string]any{},
)
if err != nil {
    log.Fatal(err)
}

`connections_test_create`

Test connection.

result, err := client.Connections.Test(
    "connectionID",
)
if err != nil {
    log.Fatal(err)
}

Connectors

`connectors_retrieve`

List all connector types.

result, err := client.Connectors.List(
)
if err != nil {
    log.Fatal(err)
}

`connectors_retrieve_by_type`

Get connector details.

result, err := client.Connectors.Retrieve(
    "connectorType",
)
if err != nil {
    log.Fatal(err)
}

Discovery

`discovery_supported_models_list`

List supported model IDs

result, err := client.Discovery.ListSupportedModels(
    "capability",
)
if err != nil {
    log.Fatal(err)
}

`discovery_agent_engine_types_list`

List supported agent engine types

result, err := client.Discovery.ListAgentEngineTypes(
)
if err != nil {
    log.Fatal(err)
}

Knowledge Base

`knowledge_base_list`

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

result, err := client.KnowledgeBase.List(1, 10)
if err != nil {
    log.Fatal(err)
}

`knowledge_base_create`

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

result, err := client.KnowledgeBase.Create(
    "company",
    "brief",
    "", // name (optional)
    "", // product name (optional)
    "", // website URL (optional)
)
if err != nil {
    log.Fatal(err)
}

`knowledge_base_catalog_retrieve`

Names-only typology+tactic catalog.

result, err := client.KnowledgeBase.Catalog()
if err != nil {
    log.Fatal(err)
}

`knowledge_base_import_lens_create`

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

result, err := client.KnowledgeBase.ImportLens("atlas_lens_id")
if err != nil {
    log.Fatal(err)
}

`knowledge_base_lens_retrieve`

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

result, err := client.KnowledgeBase.LensByAtlasId("atlas_lens_id")
if err != nil {
    log.Fatal(err)
}

`knowledge_base_destroy`

Get or delete a single KB.

err := client.KnowledgeBase.Delete("knowledge_base_id")
if err != nil {
    log.Fatal(err)
}

`knowledge_base_retrieve`

Get or delete a single KB.

result, err := client.KnowledgeBase.Retrieve("knowledge_base_id")
if err != nil {
    log.Fatal(err)
}

`knowledge_base_draft_retrieve`

Poll the atlas draft.

result, err := client.KnowledgeBase.PollDraft("knowledge_base_id")
if err != nil {
    log.Fatal(err)
}

`knowledge_base_finalize_create`

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

result, err := client.KnowledgeBase.Finalize(
    "knowledge_base_id",
    "",   // name (optional)
    true, // MCP enabled
    true, // public
)
if err != nil {
    log.Fatal(err)
}

`knowledge_base_regenerate_create`

Kick off another async generation round with feedback.

result, err := client.KnowledgeBase.Regenerate("knowledge_base_id", "")
if err != nil {
    log.Fatal(err)
}

`knowledge_base_resolve_create`

Approve or decline a pending regeneration proposal.

result, err := client.KnowledgeBase.Resolve(
    "knowledge_base_id",
    nil,   // refs (optional)
    "",    // suggested name (optional)
    false, // accept summary
    false, // discard
)
if err != nil {
    log.Fatal(err)
}

`knowledge_base_selection_partial_update`

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

result, err := client.KnowledgeBase.PatchSelection(
    "knowledge_base_id",
    []map[string]any{},
    "", // suggested name (optional)
)
if err != nil {
    log.Fatal(err)
}

`knowledge_base_sync_create`

Standalone best-effort lens sync (display mode).

result, err := client.KnowledgeBase.Sync("knowledge_base_id")
if err != nil {
    log.Fatal(err)
}

`knowledge_base_unlink_destroy`

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

err := client.KnowledgeBase.Unlink("knowledge_base_id")
if err != nil {
    log.Fatal(err)
}

Policies

`policies_list`

List all policies and create a new policy.

result, err := client.Policies.List(
    1,
    1,
)
if err != nil {
    log.Fatal(err)
}

`policies_create`

List all policies and create a new policy.

result, err := client.Policies.Create(
    "name",
    map[string]any{},
    "description",
    "versionName",
)
if err != nil {
    log.Fatal(err)
}

`policies_destroy`

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

err := client.Policies.Delete(
    "policyID",
)
if err != nil {
    log.Fatal(err)
}

`policies_retrieve`

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

result, err := client.Policies.Retrieve(
    "policyID",
)
if err != nil {
    log.Fatal(err)
}

`policies_partial_update`

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

result, err := client.Policies.Update(
    "policyID",
    &[]string{"value"}[0],
    &[]string{"value"}[0],
)
if err != nil {
    log.Fatal(err)
}

`policies_update`

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

result, err := client.Policies.Replace(
    "policyID",
    "name",
    "description",
)
if err != nil {
    log.Fatal(err)
}

`policies_versions_list`

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

result, err := client.Policies.Versions.List("policy_id")
if err != nil {
    log.Fatal(err)
}

`policies_versions_create`

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

result, err := client.Policies.Versions.Create(
    "policy_id",
    map[string]any{},
    "version_name",
    "base_version_id",
)
if err != nil {
    log.Fatal(err)
}

`policies_versions_retrieve`

Get a specific policy version by policy_id and version_id.

result, err := client.Policies.Versions.Retrieve(
    "policy_id",
    "version_id",
)
if err != nil {
    log.Fatal(err)
}

Tables

`tables_list`

List Roe tables

result, err := client.Tables.List(
)
if err != nil {
    log.Fatal(err)
}

`tables_query_create`

Run a read-only Roe table query

result, err := client.Tables.Query(
    "sql",
    1,
)
if err != nil {
    log.Fatal(err)
}

`tables_query_result_retrieve`

Get a Roe table query result

result, err := client.Tables.QueryResult(
    "tableQueryID",
)
if err != nil {
    log.Fatal(err)
}

`tables_destroy`

Delete a Roe table

err := client.Tables.Delete(
    "tableName",
)
if err != nil {
    log.Fatal(err)
}

`tables_describe_retrieve`

Describe a Roe table

result, err := client.Tables.Describe(
    "tableName",
)
if err != nil {
    log.Fatal(err)
}

`tables_preview_retrieve`

Preview a Roe table

result, err := client.Tables.Preview(
    "tableName",
    1,
)
if err != nil {
    log.Fatal(err)
}

`upload_table`

Upload a CSV as a Roe table

file := roe.FileUpload{Path: "file.csv"}

result, err := client.Tables.Upload(
    "table_name",
    file,
    true,
)
if err != nil {
    log.Fatal(err)
}

Users

`users_current_user_retrieve`

Get the current user

result, err := client.Users.Me()
if err != nil {
    log.Fatal(err)
}

Overview Use Cases

​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_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

​Users

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

Users