Robocorp

opencollection: 1.0.0
info:
  name: Robocorp Control Room API
  version: v1
items:
- info:
    name: Workspace
    type: folder
  items:
  - info:
      name: Get Workspace
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Retrieve workspace details by workspace ID.
- info:
    name: Workers
    type: folder
  items:
  - info:
      name: List Workers
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/workers
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: limit
        value: ''
        type: query
        description: Maximum number of workers to return
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: List all workers in a workspace.
  - info:
      name: Create Worker Link Token
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/workers/link-tokens
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Generate a link token to connect a new worker to the workspace.
  - info:
      name: Get Worker
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/workers/:worker_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: worker_id
        value: ''
        type: path
        description: The worker identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Retrieve a specific worker by ID.
  - info:
      name: Update Worker
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/workers/:worker_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: worker_id
        value: ''
        type: path
        description: The worker identifier
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Modify worker details such as name and group assignment.
  - info:
      name: Delete Worker
      type: http
    http:
      method: DELETE
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/workers/:worker_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: worker_id
        value: ''
        type: path
        description: The worker identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Remove a worker from the workspace.
- info:
    name: Worker Groups
    type: folder
  items:
  - info:
      name: List Worker Groups
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/worker-groups
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: List all worker groups in a workspace.
  - info:
      name: Create Worker Group
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/worker-groups
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Create a new worker group for organizing workers.
  - info:
      name: Get Worker Group
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/worker-groups/:worker_group_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: worker_group_id
        value: ''
        type: path
        description: The worker group identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Retrieve a specific worker group by ID.
  - info:
      name: Update Worker Group
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/worker-groups/:worker_group_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: worker_group_id
        value: ''
        type: path
        description: The worker group identifier
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Modify worker group details.
  - info:
      name: Delete Worker Group
      type: http
    http:
      method: DELETE
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/worker-groups/:worker_group_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: worker_group_id
        value: ''
        type: path
        description: The worker group identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Delete a worker group from the workspace.
- info:
    name: Processes
    type: folder
  items:
  - info:
      name: List Processes
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/processes
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: limit
        value: ''
        type: query
      - name: cursor
        value: ''
        type: query
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: List all processes defined in a workspace.
  - info:
      name: Create Process
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/processes
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Create a new process with steps, schedules, triggers, and notifications.
  - info:
      name: Get Process
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/processes/:process_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: process_id
        value: ''
        type: path
        description: The process identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Retrieve a specific process by ID.
- info:
    name: Process Runs
    type: folder
  items:
  - info:
      name: List Process Runs
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/processes/:process_id/runs
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: process_id
        value: ''
        type: path
        description: The process identifier
      - name: limit
        value: ''
        type: query
      - name: cursor
        value: ''
        type: query
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: List all runs for a specific process.
  - info:
      name: Start Process Run
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/processes/:process_id/runs
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: process_id
        value: ''
        type: path
        description: The process identifier
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Start a new execution run for a process.
  - info:
      name: Get Process Run
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/processes/:process_id/runs/:run_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: process_id
        value: ''
        type: path
        description: The process identifier
      - name: run_id
        value: ''
        type: path
        description: The process run identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Retrieve details for a specific process run.
  - info:
      name: Delete Process Run
      type: http
    http:
      method: DELETE
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/processes/:process_id/runs/:run_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: process_id
        value: ''
        type: path
        description: The process identifier
      - name: run_id
        value: ''
        type: path
        description: The process run identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Delete a process run record.
  - info:
      name: Stop Process Run
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/processes/:process_id/runs/:run_id/stop
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: process_id
        value: ''
        type: path
        description: The process identifier
      - name: run_id
        value: ''
        type: path
        description: The process run identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Stop an active process run execution.
- info:
    name: Step Runs
    type: folder
  items:
  - info:
      name: List Step Runs
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/processes/:process_id/runs/:run_id/step-runs
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: process_id
        value: ''
        type: path
        description: The process identifier
      - name: run_id
        value: ''
        type: path
        description: The process run identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: List all step runs within a process run.
  - info:
      name: Get Step Run
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/processes/:process_id/runs/:run_id/step-runs/:step_run_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: process_id
        value: ''
        type: path
        description: The process identifier
      - name: run_id
        value: ''
        type: path
        description: The process run identifier
      - name: step_run_id
        value: ''
        type: path
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Retrieve details for a specific step run.
- info:
    name: Work Items
    type: folder
  items:
  - info:
      name: List Work Items
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/work-items
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: process_id
        value: ''
        type: query
      - name: state
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: List all work items in a workspace.
  - info:
      name: Create Work Item
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/work-items
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Create a new work item in the queue.
  - info:
      name: Get Work Item
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/work-items/:work_item_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: work_item_id
        value: ''
        type: path
        description: The work item identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Retrieve a specific work item by ID.
- info:
    name: Assets
    type: folder
  items:
  - info:
      name: List Assets
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/assets
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: List all assets in a workspace.
  - info:
      name: Create Asset
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/assets
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Create a new asset in storage.
  - info:
      name: Get Asset
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/assets/:asset_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: asset_id
        value: ''
        type: path
        description: The asset identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Retrieve a specific asset by ID.
  - info:
      name: Delete Asset
      type: http
    http:
      method: DELETE
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/assets/:asset_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: asset_id
        value: ''
        type: path
        description: The asset identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Remove an asset from storage.
- info:
    name: Vault
    type: folder
  items:
  - info:
      name: List Secrets
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/vault/secrets
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: List all secrets in the workspace vault.
  - info:
      name: Create Secret
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/vault/secrets
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Create a new secret in the workspace vault.
  - info:
      name: Update Secret
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/vault/secrets/:secret_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: secret_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Update an existing secret value in the vault.
  - info:
      name: Delete Secret
      type: http
    http:
      method: DELETE
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/vault/secrets/:secret_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: secret_id
        value: ''
        type: path
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Remove a secret from the vault.
- info:
    name: Webhooks
    type: folder
  items:
  - info:
      name: List Webhooks
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/webhooks
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: List all webhooks configured in a workspace.
  - info:
      name: Create Process Webhook
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/webhooks
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Create a new webhook for process event notifications.
  - info:
      name: Get Webhook
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/webhooks/:webhook_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: webhook_id
        value: ''
        type: path
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Retrieve a specific webhook by ID.
  - info:
      name: Delete Webhook
      type: http
    http:
      method: DELETE
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/webhooks/:webhook_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: webhook_id
        value: ''
        type: path
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Remove a webhook configuration.
- info:
    name: Task Packages
    type: folder
  items:
  - info:
      name: List Task Packages
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/task-packages
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: List all task packages in a workspace.
  - info:
      name: Create Task Package
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/task-packages
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Create a new task package from a zip file, GitHub, or GitLab source.
  - info:
      name: Get Task Package
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/task-packages/:package_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: package_id
        value: ''
        type: path
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Retrieve a specific task package by ID.
  - info:
      name: Update Task Package
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/task-packages/:package_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: package_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Update a task package source configuration.
  - info:
      name: Delete Task Package
      type: http
    http:
      method: DELETE
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/task-packages/:package_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: package_id
        value: ''
        type: path
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Remove a task package from the workspace.
- info:
    name: Assistants
    type: folder
  items:
  - info:
      name: List Assistants
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/assistants
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: List all AI assistants in a workspace.
  - info:
      name: Create Assistant
      type: http
    http:
      method: POST
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/assistants
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Create a new AI assistant.
  - info:
      name: Get Assistant
      type: http
    http:
      method: GET
      url: https://cloud.robocorp.com/api/v1/workspaces/:workspace_id/assistants/:assistant_id
      params:
      - name: workspace_id
        value: ''
        type: path
        description: The workspace identifier
      - name: assistant_id
        value: ''
        type: path
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Retrieve a specific AI assistant by ID.
bundled: true