# robocorp OpenAPI overview

> Below is an overview of the robocorp openapi in simple language. This API contains 64 endpoints.

For more detailed information of an endpoint, visit https://oapis.org/summary/robocorp/[idOrRoute]

Robocorp Control Room API v1.0 - https://cloud.robocorp.com
Robocorp Control Room API

## asset

Asset Storage

- [listAssets](https://oapis.org/openapi/robocorp/listAssets): GET https://cloud.robocorp.com/workspaces/{workspace_id}/assets?limit=number - List assets
- [createAsset](https://oapis.org/openapi/robocorp/createAsset): POST https://cloud.robocorp.com/workspaces/{workspace_id}/assets - Create new asset
- [getAsset](https://oapis.org/openapi/robocorp/getAsset): GET https://cloud.robocorp.com/workspaces/{workspace_id}/assets/{asset_id} - Get asset
- [deleteAsset](https://oapis.org/openapi/robocorp/deleteAsset): DELETE https://cloud.robocorp.com/workspaces/{workspace_id}/assets/{asset_id} - Delete asset
- [createAssetUpload](https://oapis.org/openapi/robocorp/createAssetUpload): POST https://cloud.robocorp.com/workspaces/{workspace_id}/assets/{asset_id}/uploads - Create asset upload
- [getAssetUpload](https://oapis.org/openapi/robocorp/getAssetUpload): GET https://cloud.robocorp.com/workspaces/{workspace_id}/assets/{asset_id}/uploads/{upload_id} - Get asset upload

## assistant

Assistant

- [listAssistants](https://oapis.org/openapi/robocorp/listAssistants): GET https://cloud.robocorp.com/workspaces/{workspace_id}/assistants?limit=number - List assistants
- [createAssistant](https://oapis.org/openapi/robocorp/createAssistant): POST https://cloud.robocorp.com/workspaces/{workspace_id}/assistants - Create assistant
- [getAssistant](https://oapis.org/openapi/robocorp/getAssistant): GET https://cloud.robocorp.com/workspaces/{workspace_id}/assistants/{assistant_id} - Get assistant
- [getAssistantRun](https://oapis.org/openapi/robocorp/getAssistantRun): GET https://cloud.robocorp.com/workspaces/{workspace_id}/assistant-runs/{assistant_run_id} - Get assistant run
- [listAssistantRuns](https://oapis.org/openapi/robocorp/listAssistantRuns): GET https://cloud.robocorp.com/workspaces/{workspace_id}/assistant-runs?assistant_id=string&limit=number - List assistant runs

## process

Process

- [listProcesses](https://oapis.org/openapi/robocorp/listProcesses): GET https://cloud.robocorp.com/workspaces/{workspace_id}/processes?limit=number - List processes
- [createProcess](https://oapis.org/openapi/robocorp/createProcess): POST https://cloud.robocorp.com/workspaces/{workspace_id}/processes - Create process
- [getProcess](https://oapis.org/openapi/robocorp/getProcess): GET https://cloud.robocorp.com/workspaces/{workspace_id}/processes/{process_id} - Get process

## process-run

Process Run

- [listProcessRuns](https://oapis.org/openapi/robocorp/listProcessRuns): GET https://cloud.robocorp.com/workspaces/{workspace_id}/process-runs?process_id=string&state=string&limit=number - List process runs
- [startProcessRunQsAuth](https://oapis.org/openapi/robocorp/startProcessRunQsAuth): POST https://cloud.robocorp.com/workspaces/{workspace_id}/processes/{process_id}/process-runs-integrations?token=string&with_handshake=string - Start process run (for integrations)
- [startProcessRun](https://oapis.org/openapi/robocorp/startProcessRun): POST https://cloud.robocorp.com/workspaces/{workspace_id}/processes/{process_id}/process-runs - Start process run
- [getProcessRun](https://oapis.org/openapi/robocorp/getProcessRun): GET https://cloud.robocorp.com/workspaces/{workspace_id}/process-runs/{process_run_id} - Get process run
- [deleteProcessRun](https://oapis.org/openapi/robocorp/deleteProcessRun): DELETE https://cloud.robocorp.com/workspaces/{workspace_id}/process-runs/{process_run_id} - Delete process run
- [stopProcessRun](https://oapis.org/openapi/robocorp/stopProcessRun): POST https://cloud.robocorp.com/workspaces/{workspace_id}/process-runs/{process_run_id}/stop - Stop process run
- [listProcessRunOutputs](https://oapis.org/openapi/robocorp/listProcessRunOutputs): GET https://cloud.robocorp.com/workspaces/{workspace_id}/outputs?process_run_id=string&limit=number - List process run outputs

## step-run

Step Run

- [listStepRuns](https://oapis.org/openapi/robocorp/listStepRuns): GET https://cloud.robocorp.com/workspaces/{workspace_id}/step-runs?process_run_id=string&limit=number - List step runs
- [getStepRun](https://oapis.org/openapi/robocorp/getStepRun): GET https://cloud.robocorp.com/workspaces/{workspace_id}/step-runs/{step_run_id} - Get step run
- [listStepRunArtifacts](https://oapis.org/openapi/robocorp/listStepRunArtifacts): GET https://cloud.robocorp.com/workspaces/{workspace_id}/step-runs/{step_run_id}/artifacts?limit=number - List step run artifacts
- [getStepRunArtifact](https://oapis.org/openapi/robocorp/getStepRunArtifact): GET https://cloud.robocorp.com/workspaces/{workspace_id}/step-runs/{step_run_id}/artifacts/{artifact_id} - Get step run artifact
- [listStepRunConsoleMessages](https://oapis.org/openapi/robocorp/listStepRunConsoleMessages): GET https://cloud.robocorp.com/workspaces/{workspace_id}/step-runs/{step_run_id}/console-messages?limit=number - List step run console messages
- [listStepRunEvents](https://oapis.org/openapi/robocorp/listStepRunEvents): GET https://cloud.robocorp.com/workspaces/{workspace_id}/step-runs/{step_run_id}/events?limit=number - List step run events

## task-package

Task Package

- [listTaskPackages](https://oapis.org/openapi/robocorp/listTaskPackages): GET https://cloud.robocorp.com/workspaces/{workspace_id}/task-packages?limit=number - List task packages
- [createTaskPackage](https://oapis.org/openapi/robocorp/createTaskPackage): POST https://cloud.robocorp.com/workspaces/{workspace_id}/task-packages - Create new task package
- [getTaskPackage](https://oapis.org/openapi/robocorp/getTaskPackage): GET https://cloud.robocorp.com/workspaces/{workspace_id}/task-packages/{task_package_id} - Get task package
- [updateTaskPackage](https://oapis.org/openapi/robocorp/updateTaskPackage): POST https://cloud.robocorp.com/workspaces/{workspace_id}/task-packages/{task_package_id} - Update task package
- [deleteTaskPackage](https://oapis.org/openapi/robocorp/deleteTaskPackage): DELETE https://cloud.robocorp.com/workspaces/{workspace_id}/task-packages/{task_package_id} - Delete task package

## vault

Vault

- [listSecrets](https://oapis.org/openapi/robocorp/listSecrets): GET https://cloud.robocorp.com/workspaces/{workspace_id}/secrets - List secrets
- [createSecret](https://oapis.org/openapi/robocorp/createSecret): POST https://cloud.robocorp.com/workspaces/{workspace_id}/secrets - Create secret
- [updateSecret](https://oapis.org/openapi/robocorp/updateSecret): POST https://cloud.robocorp.com/workspaces/{workspace_id}/secrets/{secret_name} - Update secret
- [deleteSecret](https://oapis.org/openapi/robocorp/deleteSecret): DELETE https://cloud.robocorp.com/workspaces/{workspace_id}/secrets/{secret_name} - Delete secret

## webhooks

Webhooks

- [listWebhooks](https://oapis.org/openapi/robocorp/listWebhooks): GET https://cloud.robocorp.com/workspaces/{workspace_id}/webhooks?limit=number - List webhooks
- [createWebhook](https://oapis.org/openapi/robocorp/createWebhook): POST https://cloud.robocorp.com/workspaces/{workspace_id}/webhooks - Create process webhook
- [getWebhook](https://oapis.org/openapi/robocorp/getWebhook): GET https://cloud.robocorp.com/workspaces/{workspace_id}/webhooks/{webhook_id} - Get webhook
- [deleteWebhook](https://oapis.org/openapi/robocorp/deleteWebhook): DELETE https://cloud.robocorp.com/workspaces/{workspace_id}/webhooks/{webhook_id} - Delete webhook

## work-item

Work Item

- [runWorkItemBatchOperation](https://oapis.org/openapi/robocorp/runWorkItemBatchOperation): POST https://cloud.robocorp.com/workspaces/{workspace_id}/work-items/batch - Retry, delete or mark work items as done
- [listWorkItems](https://oapis.org/openapi/robocorp/listWorkItems): GET https://cloud.robocorp.com/workspaces/{workspace_id}/work-items?process_id=string&process_run_id=string&state=state&limit=number - List work items
- [createWorkItem](https://oapis.org/openapi/robocorp/createWorkItem): POST https://cloud.robocorp.com/workspaces/{workspace_id}/work-items - Create work item
- [getWorkItem](https://oapis.org/openapi/robocorp/getWorkItem): GET https://cloud.robocorp.com/workspaces/{workspace_id}/work-items/{work_item_id} - Get work item
- [createWorkItemFile](https://oapis.org/openapi/robocorp/createWorkItemFile): POST https://cloud.robocorp.com/workspaces/{workspace_id}/work-items/{work_item_id}/files - Create work item file
- [updateWorkItemPayload](https://oapis.org/openapi/robocorp/updateWorkItemPayload): POST https://cloud.robocorp.com/workspaces/{workspace_id}/work-items/{work_item_id}/payload - Update work item payload

## worker

Worker

- [listWorkers](https://oapis.org/openapi/robocorp/listWorkers): GET https://cloud.robocorp.com/workspaces/{workspace_id}/workers?limit=number - List workers
- [createLinkToken](https://oapis.org/openapi/robocorp/createLinkToken): POST https://cloud.robocorp.com/workspaces/{workspace_id}/workers/link-tokens - Create worker link token
- [getWorker](https://oapis.org/openapi/robocorp/getWorker): GET https://cloud.robocorp.com/workspaces/{workspace_id}/workers/{worker_id} - Get worker
- [updateWorker](https://oapis.org/openapi/robocorp/updateWorker): POST https://cloud.robocorp.com/workspaces/{workspace_id}/workers/{worker_id} - Update worker
- [deleteWorker](https://oapis.org/openapi/robocorp/deleteWorker): DELETE https://cloud.robocorp.com/workspaces/{workspace_id}/workers/{worker_id} - Delete worker

## worker-group

Worker Group

- [listWorkerGroups](https://oapis.org/openapi/robocorp/listWorkerGroups): GET https://cloud.robocorp.com/workspaces/{workspace_id}/worker-groups?limit=number - List worker groups
- [createWorkerGroup](https://oapis.org/openapi/robocorp/createWorkerGroup): POST https://cloud.robocorp.com/workspaces/{workspace_id}/worker-groups - Create worker group
- [getWorkerGroup](https://oapis.org/openapi/robocorp/getWorkerGroup): GET https://cloud.robocorp.com/workspaces/{workspace_id}/worker-groups/{worker_group_id} - Get worker group
- [updateWorkerGroup](https://oapis.org/openapi/robocorp/updateWorkerGroup): POST https://cloud.robocorp.com/workspaces/{workspace_id}/worker-groups/{worker_group_id} - Update worker group
- [deleteWorkerGroup](https://oapis.org/openapi/robocorp/deleteWorkerGroup): DELETE https://cloud.robocorp.com/workspaces/{workspace_id}/worker-groups/{worker_group_id} - Delete worker group
- [addWorkerToGroup](https://oapis.org/openapi/robocorp/addWorkerToGroup): POST https://cloud.robocorp.com/workspaces/{workspace_id}/worker-groups/{worker_group_id}/workers - Add worker to worker group
- [removeWorkerFromGroup](https://oapis.org/openapi/robocorp/removeWorkerFromGroup): DELETE https://cloud.robocorp.com/workspaces/{workspace_id}/worker-groups/{worker_group_id}/workers/{worker_id} - Remove worker from worker group
- [listWorkerGroupLinkTokens](https://oapis.org/openapi/robocorp/listWorkerGroupLinkTokens): GET https://cloud.robocorp.com/workspaces/{workspace_id}/worker-groups/{worker_group_id}/link-tokens?limit=number - List worker group link tokens
- [createWorkerGroupLinkToken](https://oapis.org/openapi/robocorp/createWorkerGroupLinkToken): POST https://cloud.robocorp.com/workspaces/{workspace_id}/worker-groups/{worker_group_id}/link-tokens - Create worker group link token
- [getWorkerGroupLinkToken](https://oapis.org/openapi/robocorp/getWorkerGroupLinkToken): GET https://cloud.robocorp.com/workspaces/{workspace_id}/worker-groups/{worker_group_id}/link-tokens/{link_token_id} - Get worker group link token
- [updateWorkerGroupLinkToken](https://oapis.org/openapi/robocorp/updateWorkerGroupLinkToken): POST https://cloud.robocorp.com/workspaces/{workspace_id}/worker-groups/{worker_group_id}/link-tokens/{link_token_id} - Update worker group link token
- [deleteWorkerGroupLinkToken](https://oapis.org/openapi/robocorp/deleteWorkerGroupLinkToken): DELETE https://cloud.robocorp.com/workspaces/{workspace_id}/worker-groups/{worker_group_id}/link-tokens/{link_token_id} - Delete worker group link token

## workspace

Workspace

- [getWorkspace](https://oapis.org/openapi/robocorp/getWorkspace): GET https://cloud.robocorp.com/workspaces/{workspace_id} - Get workspace