Skip to content
Changelog

Report a bug

Seqera integration: operations for AI agents

Seqera connects to Type.com as an integration. This page lists the 269 operations documented for Claude and Codex in Type.com: 137 read, 61 write, 71 destructive.

About Seqera

Seqera Platform is an intuitive, centralized command post that enables data analysis at scale, allowing users to launch, manage, and monitor scalable Nextflow pipelines and compute environments on-premises or across cloud providers.

Categories: Developer Tools & IT

How to connect Seqera to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

269 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

269 operations listed.

Actions

  • Read

    List actions

    Lists all available actions in a user context, enriched by attributes. Append ?workspaceId to list actions in a workspace context.

  • Read

    List action event types

    Lists the supported event types that trigger a pipeline action. Append ?workspaceId to list event types in a workspace context.

  • Read

    Validate action name

    Confirms the validity of the given action name. Append ?name= .

  • Read

    Describe action

    Retrieves the details of the action identified by the given actionId.

  • Read

    List action triggers

    Lists the trigger history of the action identified by the given actionId, newest first. Append ?workspaceId to read a workspace action.

  • Read

    Describe action trigger

    Retrieves one trigger of the action identified by the given actionId, including the event that caused it. The event payload is untrusted input: escape it before displaying it. Append ?workspaceId to read a workspace action.

  • Write

    Create action

    Creates a new action. Append ?workspaceId to associate the action with the given workspace. Send the trigger block that matches the source: bucket, cron, or pipelineStatus.

  • Write

    Resolve a schedule description to a cron expression

    Resolves a free-text schedule description, such as Every 10 minutes, to a standard 5-field cron expression. A valid cron expression is returned unchanged. Append ?workspaceId to resolve in a workspace context.

  • Write

    Trigger Tower Launch action

    Triggers the execution of the Tower Launch action identified by the given actionId.

  • Write

    Pause or resume action

    Pauses or resumes the pipeline action identified by the given actionId.

  • Destructive

    Update action

    Updates the details of the action identified by the given actionId. The source, responseType and launch.id of an existing action cannot change. A pipeline action requires the whole launch on every update, because the update overwrites every stored launch setting.

  • Destructive

    Delete action

    Deletes the pipeline action identified by the given actionId.

Labels

  • Read

    List labels

    Lists all available labels in a user context. Append ?workspaceId to list labels in a workspace context.

  • Read

    Get Allowed Dynamic Labels

    GET /labels/dynamic/allowed

  • Write

    Add labels to actions

    Adds the given list of labels to the given pipeline actions. Existing labels are preserved.

  • Write

    Replace action labels

    Applies the given list of labels to the given pipeline actions. Existing labels are replaced — include labels to be preserved in labelIds.

  • Write

    Add labels to datasets

    Adds the given list of labels to the given datasets. Existing labels are preserved.

  • Write

    Replace datasets labels

    Applies the given list of labels to the given datasets. Existing labels are replaced - include labels to be preserved in labelIds. Only simple labels can be attached to datasets

  • Write

    Create label

    Creates a new label or returns an existing label based on name/value. By default the operation works in a user context, append ?workspaceId to create/retrieve a label in a workspace context. Resource labels include resource: true and a value.

  • Write

    Add labels to pipelines

    Adds the given list of labels to the given pipelines. Existing labels are preserved.

  • Write

    Replace pipeline labels

    Applies the given list of labels to the given pipelines. Existing labels are replaced — include labels to be preserved in labelIds.

  • Write

    Add labels to workflows

    Adds the given list of labels to the given workflows. Existing labels are preserved.

  • Write

    Replace workflow labels

    Applies the given list of labels to the given workflows. Existing labels are replaced — include labels to be preserved in labelIds.

  • Destructive

    Remove labels from actions

    Removes the given list of labels from the given pipeline actions.

  • Destructive

    Remove labels from datasets

    Removes the given list of labels from the given datasets.

  • Destructive

    Update label

    Updates the label identified by the given labelId.

  • Destructive

    Delete label

    Deletes the label identified by the given labelId.

  • Destructive

    Remove labels from pipelines

    Removes the given list of labels from the given pipelines.

  • Destructive

    Remove labels from workflows

    Removes the given list of labels from the given workflows.

Admin

  • Read

    List audit logs (v2)

    Lists audit logs with token-based pagination, ordered by timestamp (descending). Supports filtering by timestamp range.

  • Read

    Export audit logs (v2) as CSV

    Exports audit log entries as a CSV file. Supports filtering by timestamp range. Fails if the number of matching logs exceeds a certain maximum.

  • Read

    Describe a single audit log (v2)

    Retrieves the pre/post change images associated with a specific audit log V2 record.

Agents

  • Read

    List agents

    Lists non-deleted agents in a workspace.

  • Read

    List agent runs

    Lists background agent runs in a workspace, newest first.

  • Read

    Get agent run status

    Retrieves the current status and chat identifiers for a background agent run in a workspace.

  • Read

    Describe agent

    Retrieves an agent in a workspace.

  • Write

    Create agent

    Creates an agent in a workspace.

  • Write

    Launch agent

    Launches a background AI agent run

  • Write

    Disable agent

    Marks an active agent as inactive.

  • Write

    Enable agent

    Marks an inactive agent as active.

  • Destructive

    Update agent

    Replaces an agent in a workspace. Every field is overwritten, so an omitted optional field is cleared.

  • Destructive

    Delete agent

    Tombstones an agent in a workspace.

Avatars

  • Read

    Download the avatar image

    GET /avatars/{avatarId}

  • Write

    Create the avatar image

    POST /avatars

Compatibility

  • Read

    Catalog versions for a single component

    As /versions but scoped to {key}; the same registered component compatibility-filter parameters apply (PF-2).

  • Read

    Component compatibility catalog versions

    Returns catalog versions with servedFrom provenance and observed deploymentVersions. Optionally narrowed to a single component and compatibility-constrained by registered component query parameters plus platform/nextflow/fusion/sched/wave deployment context, for example fusion=2.

Compute envs

  • Read

    List compute environments

    Lists all available compute environments in a user context. Append ?workspaceId to list compute environments in a workspace context, and ?status to filter by compute environment status.

  • Read

    Validate compute environment name

    Confirms the validity of the given compute environment name in a user context. Append ?name= .

  • Read

    Describe compute environment

    Retrieves the details of the compute environment identified by the given computeEnvId.

  • Read

    Validate a compute environment

    Re-runs the pre-flight checks (associated-credential validation and work-directory accessibility) for the compute environment identified by the given computeEnvId and persists the outcome to the compute environment and its credential.

  • Write

    Create compute environment

    Creates a new compute environment. Append ?workspaceId to create the environment in a workspace context.

  • Write

    Disable compute environment

    Disables the compute environment identified by the given computeEnvId. A disabled compute environment cannot be used to launch workflows. If the compute environment is primary, it will be automatically unset as primary.

  • Write

    Enable compute environment

    Enables the compute environment identified by the given computeEnvId. An enabled compute environment can be used to launch workflows.

  • Write

    Define primary compute environment

    Selects the compute environment identified by the given computeEnvId as the primary compute environment in the given workspace context.

  • Destructive

    Update compute environment

    Updates the details of the compute environment identified by the given computeEnvId.

  • Destructive

    Delete compute environment

    Deletes the compute environment identified by the given computeEnvId. When force=true, bypasses active-job checks and SCMS/forge cleanup; only allowed for environments in ERRORED, INVALID, or DELETING status.

Credentials

  • Read

    List credentials

    Lists all available credentials in a user context. Append ?workspaceId to list credentials in a workspace context, and ?platformId to filter credentials by computing platform.

  • Read

    Describe credential provider setup values

    Returns the labelled values an administrator copies into their cloud provider console to set up a credential of the given provider — for AWS OIDC workload identity: this installation's public address and the subject claims Platform mints.

  • Read

    Validate credential name

    Validates the given credentials name. Append ?name= .

  • Read

    Describe credentials

    Retrieves the details of the credentials identified by the given credentialsId. Include workspaceId when accessing workspace credentials; omit it for user-owned credentials.

  • Read

    Get encrypted credentials

    Retrieves the encrypted keys for the credentials identified by the given credentialsId.

  • Read

    Validate credentials against their cloud provider and report the outcome

    POST /credentials/{credentialsId}/validate

  • Write

    Create credentials

    Creates new credentials in a user context. Append ?workspaceId to create the credentials in a workspace context. For AWS credentials with IAM Role ARN, append ?useExternalId=true to generate a Platform-managed External ID.

  • Destructive

    Update credentials

    Updates the details of the credentials identified by the given credentialsId. For AWS credentials with IAM Role ARN, append ?useExternalId=true to generate a Platform-managed External ID.

  • Destructive

    Delete credentials

    Deletes the credentials identified by the given credentialsId.

Data links

  • Read

    Refresh data-link cache

    Refreshes the data-link cache for the given workspaceId or credentialsId

  • Read

    Explore a data-link tree

    Provides a list of all files in the provided paths (including files in sub-paths).

  • Read

    Explore data-link path

    Retrieves the content of the data-link associated with the given dataLinkId, at the given path.

  • Read

    Generate download script

    Creates a script to download files from the data-link associated with the given dataLinkId. Append ?dirs or ?files to specify a list of files or paths to download within the data-link.

  • Write

    Generate data-link file upload URL

    Creates a URL to upload files to the data-link associated with the given dataLinkId. For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the /upload/finish endpoint.

  • Write

    Finish data-link file upload

    Finish upload of a data-link file. This is necessary for AWS S3 data-links (DataLinkProvider=aws) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the /upload endpoint.

  • Write

    Finish data-link file upload to given path

    Finish upload of a data-link file, specifying a file path (dirPath).

  • Write

    Generate data-link file upload URL (to given path)

    Creates a URL to upload files to the data-link associated with the given dataLinkId, specifying a file path (dirPath).

  • Destructive

    Delete data-link content

    Deletes the content of the data-link associated with the given dataLinkId. The data-link itself is preserved.

Datasets

  • Read

    List datasets

    Lists all available datasets in a user context. Append ?workspaceId to list datasets in a workspace context.

  • Read

    Preview content from a URL

    Fetches a partial content preview from an arbitrary HTTP/HTTPS URL, without creating a dataset. Intended for the dataset form preview after URL validation.

  • Read

    Show dataset

    Show the given datasetIds

  • Read

    Validate URL for dataset linking

    Validates that a remote dataset URL is accessible and returns a supported CSV/TSV format, without creating a dataset.

  • Read

    List latest dataset versions

    Lists the latest version of each dataset in the user context. Append ?workspaceId to list latest versions in a workspace context.

  • Read

    Describe dataset

    Retrieves the metadata of the dataset identified by the given datasetId.

  • Read

    Download dataset content

    Downloads the content of the dataset identified by the given datasetId and version.

  • Read

    Preview linked dataset content

    Fetches a partial preview of the content for a linked dataset version.

  • Read

    List all dataset versions

    Lists all versions of the given datasetId.

  • Read

    Describe launch datasets

    Retrieves the details of the datasets used in the launch identified by the given launchId.

  • Write

    Create dataset

    Creates a new dataset in the user context. Include the dataset file and details in your request body. Append ?workspaceId to create the dataset in a workspace context.

  • Write

    Hide dataset

    Hide the given datasetIds

  • Write

    Link external URL as dataset version

    Creates a new linked DatasetVersion for an existing LINKED dataset by supplying a public HTTP/HTTPS URL.

  • Write

    Upload new dataset version

    Uploads the CSV or TSV content to create a new version of the dataset identified by the given datasetId.

  • Write

    Disable a dataset version

    Disable a dataset version, the dataset version cannot be used for runs, and cannot be enabled again

  • Destructive

    Delete dataset

    Deletes the dataset identified by the given datasetId.

  • Destructive

    Update dataset

    Updates the details of the dataset identified by the given datasetId.

  • Destructive

    Delete dataset

    Deletes the dataset identified by the given datasetId.

Ga4gh

  • Read

    GA4GH: List runs

    Uses the GA4GH workflow execution service API to list all run records.

  • Read

    GA4GH: Describe run

    Uses the GA4GH workflow execution service API to retrieve the details of the run assoiated with the given runid.

  • Read

    GA4GH: Retrieve run status

    Uses the GA4GH workflow execution service API to retrieve the status of the run associated with the given runid.

  • Read

    GA4GH workflow execution service API info

    GET /ga4gh/wes/v1/service-info

  • Write

    GA4GH: Launch run

    Uses the GA4GH workflow execution service API to launch a new run. Runs are launched in the user workspace context by default. To launch in an organization workspace context, include the workspaceId in workflowengineparameters.

  • Write

    GA4GH: Cancel run

    Uses the GA4GH workflow execution service API to cancel the run associated with the given runid.

Identities

  • Read

    List Managed Identities

    List all Managed Identities in an organization.

  • Read

    Describe a Managed Identity

    Describe a Managed Identity in an organization.

  • Read

    List Managed Credentials

    List Managed Credentials belonging to a Managed Identity.

  • Write

    Create Managed Identity

    Create a new Managed Identity in an organization.

  • Write

    Creates Managed Credentials

    Creates Managed Credentials for the given Managed Identity

  • Destructive

    Update a Managed Identity

    Update a Managed Identity identified by the given ID.

  • Destructive

    Delete a Managed Identity

    Delete a Managed Identity identified by the given ID.

  • Destructive

    Updates Managed Credentials

    Update Managed Credentials for the given Managed Identity

  • Destructive

    Delete a user's Managed Credentials record belonging to a Managed Identity

    Delete Managed Credentials

Launch

  • Read

    Describe Launch record

    Retrieves the details of the launch identified by the given launchId.

Lineage

  • Read

    Resolve a platform identifier to a lineage LID

    Resolves a Nextflow run or file path to a lineage LID. Exactly one of sessionId or filePath must be provided. A run is identified by sessionId and runName: a resumed run inherits the parent run's sessionId but produces its own lineage record.

  • Read

    Search lineage records across a selectable set of accessible workspaces

    Cross-workspace lineage search. The q DSL uses a simple set of conventions: whitespace = AND, a comma inside a qualifier = OR, and repeating a qualifier = AND. Filter the lineage index by type:, workflow:, task:, pipeline:, pipelineId:, label:, and/or free-text tokens.

  • Read

    Get the full Nextflow lineage record from the object store

    Always reads the record from the lineage object store (golden source). For the slim denormalized projection, use /lineage/{lid}/summary instead.

  • Read

    Get the slim index projection for a lineage record

    Returns a thin projection ({name, path|sessionId|workflowRun, labels}) served directly from the index — no object-store read. 404 when no index row exists for the LID.

Orgs

  • Read

    List organizations

    Lists all available organizations in a user context.

  • Read

    Validate organization name

    Confirms the validity of the given organization name. Append ?name= .

  • Read

    Describe organization

    Retrieves the details of the organization identified by the given orgId.

  • Read

    List organization collaborators

    Lists the collaborators of the organization identified by the given orgId.

  • Read

    List IdP groups for an organization

    Returns the IdP group catalog for the organization, including both SCIM-pushed and manually entered groups.

  • Read

    List organization members

    Lists the members of the organization identified by the given orgId.

  • Read

    Describe organization quotas

    Retrieves the details of the organization quotas identified by the given orgId.

  • Read

    View SCIM configuration

    Returns the SCIM configuration for the organization, including token metadata, group count, and SSO state. Accessible to all org members (read access).

  • Read

    List all user roles and permissions in an organization

    List all user roles and permissions in an organization; also list the sources of those roles (via team assignment or direct user assignment).

  • Write

    Create organization

    Creates a new organization.

  • Write

    Manually add an IdP group to the catalog

    Adds a group entry to the IdP group catalog via manual entry. The admin must enter the exact claim value their IdP sends in the groups claim.

  • Write

    Generate a SCIM bearer token

    Generates a new SCIM bearer token for the organization. If an active token already exists it is revoked first. The plaintext token is returned only once.

  • Write

    Rotate the SCIM bearer token

    Revokes the current active token and generates a new one. The new plaintext token is returned only once.

  • Destructive

    Update organization

    Updates the details of the organization identified by the given orgId.

  • Destructive

    Delete organization

    Deletes the organization identified by the given orgId.

  • Destructive

    Remove an IdP group from the catalog

    Removes a manually-entered group from the catalog. SCIM-managed groups cannot be deleted via this endpoint.

  • Destructive

    Add organization member

    Adds a new member to the organization identified by the given orgId.

  • Destructive

    Leave organization

    Removes the requesting user from the organization identified by the given orgId.

  • Destructive

    Delete member

    Deletes the member identified by the given memberId.

  • Destructive

    Update member role

    Updates the role of the member identified by the given memberId.

  • Destructive

    Revoke the active SCIM bearer token

    Revokes the active SCIM bearer token for the organization. Returns 404 if no active token exists.

Service accounts

  • Read

    List service accounts

    GET /orgs/{orgId}/service-accounts

  • Read

    Describe a service account

    GET /orgs/{orgId}/service-accounts/{saId}

  • Read

    List workspace service accounts

    Lists the service accounts assigned to the workspace identified by the given workspaceId.

  • Write

    Create a service account

    POST /orgs/{orgId}/service-accounts

  • Write

    Update a service account

    Updates the fields present in the request. Omitted fields keep their current values.

  • Destructive

    Delete a service account

    DELETE /orgs/{orgId}/service-accounts/{saId}

Teams

  • Read

    List organization teams

    Lists all teams in the organization identified by the given orgId.

  • Read

    Validate team name

    Confirms the validity of the given team name. Append ?name= .

  • Read

    Describe team

    Retrieves the details of the team identified by the given teamId.

  • Read

    List team members

    Lists the team members associated with the given teamId.

  • Read

    List team workspaces

    Lists all the workspaces of which the given teamId is a participant.

  • Write

    Create team

    Creates a new team in the organization identified by the given orgId.

  • Write

    Create team member

    Adds a new member to the team identified by the given teamId.

  • Destructive

    Update team

    Updates the details of the team identified by the given teamId.

  • Destructive

    Delete team

    Deletes the team identified by the given teamId.

  • Destructive

    Delete team member

    Deletes the team member identified by the given memberId.

Workspaces

  • Read

    List organization workspaces

    Lists the organization workspaces in orgId to which the requesting user belongs.

  • Read

    Validate workspace name

    Confirms the validity of the given workspace name. Append ?name= .

  • Read

    Describe workspace

    Retrieves the details of the workspace identified by the given workspaceId.

  • Read

    List workspace participants

    Lists the participants of the workspace identified by the given workspaceId.

  • Read

    Get workspace lineage settings

    Retrieves the lineage settings of the workspace identified by the given workspaceId.

  • Read

    List workspace Studios settings

    Retrieves the Studios settings of the workspace identified by the given workspaceId.

  • Read

    List user workspaces and organizations

    Lists the workspaces and organizations to which the user identified by the given userId belongs.

  • Write

    Create workspace

    Creates a new organization workspace.

  • Destructive

    Update workspace

    Updates the details of the workspace identified by the given workspaceId.

  • Destructive

    Delete workspace

    Deletes the workspace identified by the given workspaceId.

  • Destructive

    Leave workspace

    Removes the requesting user from the given workspace.

  • Destructive

    Create workspace participant

    Adds a new participant to the workspace identified by the given workspaceId. The participant is assigned the requested role, defaulting to launch when omitted (view for service accounts).

  • Destructive

    Delete workspace participant

    Deletes the given participant from the given workspace.

  • Destructive

    Update participant role

    Updates the role of the given participant in the given workspace.

  • Destructive

    Update workspace lineage settings

    Updates the lineage settings of the workspace identified by the given workspaceId. credentialsId and region are always required. In MANUAL provisioning mode, storeName and topicArn are also required.

  • Destructive

    Delete workspace lineage settings

    Disables lineage for the workspace identified by the given workspaceId. Stops queue polling and removes the lineage configuration. AWS infrastructure is left intact.

  • Destructive

    Update workspace Studios settings

    Updates the Studios settings of the workspace identified by the given workspaceId.

  • Destructive

    Delete workspace user

    Deletes the given user (member or collaborator) from the given workspace.

Pipeline schemas

  • Write

    Create pipeline schema

    Creates a new pipeline schema in a user context. Append ?workspaceId to create the schema in a workspace context.

Pipeline secrets

  • Read

    List pipeline secrets

    Lists all available pipeline secrets in a user context. Append ?workspaceId to list secrets in a workspace context.

  • Read

    Validate secret name

    Confirms the validity of the given pipeline secret name in a user context. Append ?name= . Append ?workspaceId to validate the name in a workspace context.

  • Read

    Describe pipeline secret

    Retrieves the details of the pipeline secret identified by the given secretId.

  • Write

    Create pipeline secret

    Creates a new pipeline secret in the user context. Append ?workspaceId to create the secret in a workspace context.

  • Destructive

    Update secret

    Updates the pipeline secret identified by the given secretId.

  • Destructive

    Delete secret

    Deletes the pipeline secret identified by the given secretId.

Pipelines

  • Read

    List pipelines

    Lists all available pipelines in a user context, enriched by attributes. Append workspaceId to list pipelines in a workspace context.

  • Read

    Describe remote pipeline repository

    Retrieves the details of a remote Nextflow pipeline Git repository. Append the repository name or full URL with ?name.

  • Read

    List user pipeline repositories

    Lists known Nextflow pipeline Git repositories, extracted from existing runs. Append ?workspaceId to list repositories in a workspace context.

  • Read

    Validate pipeline name

    Confirms the validity of the given pipeline name in a user context. Append ?name= . Append ?workspaceId to validate the name in a workspace context.

  • Read

    Describe pipeline

    Retrieves the details of the pipeline identified by the given pipelineId, enriched by attributes.

  • Read

    Describe pipeline launch

    Retrieves the launch details of the pipeline identified by the given pipelineId.

  • Read

    Describe pipeline schema

    Retrieves the pipeline schema of the pipeline identified by the given pipelineId, enriched by attributes. 200 - OK responses include the pipeline schema. 204 - OK responses indicate a successful request, with no saved schema found for the given pipeline ID.

  • Write

    Create pipeline

    Creates a new pipeline in a user context. Append ?workspaceId to create the pipeline in a workspace context.

  • Destructive

    Update pipeline (default version)

    Updates the details of the pipeline identified by the given pipelineId. Note: If labelIds is null, empty, or omitted, existing pipeline labels are removed. Include labelIds: [ , ] to override existing labels. Labels to be preserved must be included.

  • Destructive

    Delete pipeline

    Deletes the pipeline identified by the given pipelineId.

Pipeline versions

  • Read

    List pipeline versions

    Lists all available pipeline versions in a user context. Append workspaceId to list pipeline versions in a workspace context.

  • Read

    Validate pipeline version name

    Confirms the validity of the given pipeline version name in a user context.

  • Write

    Update pipeline version

    Updates the details of the pipeline version identified by the given pipelineId and versionId. Note: If labelIds is null, empty, or omitted, existing pipeline labels are removed. Include labelIds: [ , ] to override existing labels. Labels to be preserved must be included.

  • Destructive

    Update pipeline version name and default flag

    Updates a pipeline version's name and/or marks it as the default version. When setting a version as default, any previously default version is automatically unset. Version names cannot be changed if the version is already referenced by workflow runs.

Nextflow

  • Read

    Nextflow version catalog

    Returns the system-wide catalog of selectable Nextflow versions and the per-run version-selection policy used by the launch form.

Platforms

  • Read

    List platforms

    Lists all available computing platforms in a user context. Append ?workspaceId to list platforms in a workspace context.

  • Read

    Describe platform

    Retrieves the details of the computing platform identified by the given platformId.

  • Read

    List platform regions

    Lists the available regions for the computing platform identified by the given platformId.

Roles

  • Read

    List all roles

    GET /roles

  • Read

    List all role permissions available in the system

    GET /roles/permissions

  • Read

    Validate if a role name is available within the organization

    GET /roles/validate

  • Read

    Describe role and its permissions fetching by role name

    GET /roles/{roleName}

  • Write

    Create a role with the given name

    POST /roles

  • Destructive

    Update a role with the given name

    PUT /roles/{roleName}

  • Destructive

    Delete a role with the given name

    DELETE /roles/{roleName}

Service info

  • Read

    General Seqera service features and version.

    GET /service-info

Ssh keys

  • Read

    List SSH keys

    Retrieves the list of all SSH public keys for the authenticated user.

  • Read

    Validate SSH key

    Confirms the availability of the given key for a SSH key in the user context.

  • Read

    Validate SSH key name

    Confirms the availability of the given name for a SSH key in the user context.

  • Read

    Describe SSH key

    Retrieves the details of an SSH public key by its ID.

  • Write

    Create SSH key

    Creates a new SSH public key with the details in the given request body.

  • Destructive

    Delete SSH key

    Deletes the given SSH public key by its ID.

Studios

  • Read

    List Studios

    Lists all available Studios in a user context. Append ?workspaceId to list Studios in a workspace context.

  • Read

    List mounted data-links

    Lists the IDs of all available data-links mounted in existing Studios. Append orgId or ?workspaceId to list mounted data-links in an organization or workspace context, respectively.

  • Read

    List available Studio templates

    Returns the list of available, configured Studio templates.

  • Read

    Validate Studio name

    Confirms the availability of the given name for a Studio in the user context. Append ?workspaceId= to validate the name in a workspace context.

  • Read

    Describe Studio

    Retrieves the details of the Studio session identified by the given sessionId.

  • Read

    List Studio checkpoints

    Retrieves the list of checkpoints for the given Studio session ID, sorted by creation date in descending order.

  • Read

    Get Studio checkpoint

    Retrieves the details of the given Studio checkpoint ID.

  • Read

    List compute environments compatible with a Studio

    Lists the compute environments in the same workspace as the given Studio that are compatible with its compute environment.

  • Read

    Get Studio logs

    Retrieves the process log of the latest session of the given Studio, read from the compute environment's log stream (e.g. CloudWatch). Availability depends on the compute provider and its log retention.

  • Write

    Create Studio

    Creates a new Studio environment, starting it by default. Default behavior can be changed using the query parameter autoStart=false.

  • Write

    Extend Data Studio Lifespan

    Extends the lifespan of the given Studio session ID.

  • Write

    Star studio

    Adds the studio identified by the given sessionId to your list of starred studios.

  • Destructive

    Update a Studio

    Updates the given Studio session ID. Can only update non-running Studios. The compute environment can be changed by setting computeEnvId to a CE compatible with the Studio's current one; see GET /studios/{sessionId}/compatible-ce.

  • Destructive

    Delete Studio

    Deletes the Studio associated with the given Studio session ID.

  • Destructive

    Update Studio checkpoint name

    Updates the name of the given Studio checkpoint ID.

  • Destructive

    Unstar studio

    Removes the studio identified by the given sessionId from your list of starred studios.

  • Destructive

    Starts a Studio

    Starts the given Studio session ID.

  • Destructive

    Stop Studio

    Stops the given Studio session ID.

Tokens

  • Read

    List tokens

    Retrieves the list of all available API access tokens.

  • Write

    Create token

    Creates an API access token with the details in the given request body.

  • Destructive

    Delete all user tokens

    Deletes all API access tokens in the user context.

  • Destructive

    Delete token

    Deletes the given API access token ID.

Trace

  • Write

    Create workflow execution trace

    Creates a new workflow execution trace.

  • Destructive

    Signal workflow execution start

    Updates the workflow execution trace for the given workflowId.

  • Destructive

    Signal workflow execution completion

    Updates the workflow execution trace for the given workflowId.

  • Destructive

    Signal workflow execution heartbeat

    Update the workflow execution trace heartbeat for the given workflowId to signal that execution is ongoing.

  • Destructive

    Store workflow task execution metadata

    Store the execution metadata for one or more tasks in the given workflowId.

Users

  • Read

    Describe current user

    GET /user-info

  • Read

    Check that the user name is valid

    GET /users/validate

  • Write

    Update an user entity

    POST /users/{userId}

  • Destructive

    Delete a user entity

    DELETE /users/{userId}

Workflows

  • Read

    List workflows

    Lists all workflow records, enriched with attributes. Append ?workspaceId to list workflow records in a workspace context.

  • Read

    Generates a random name

    GET /workflow/random-name

  • Read

    Validate run name

    Check that the given run name of a workflow has a valid format. When the session ID is given: check that no other workflow in the system exists with the combination of both elements.

  • Read

    Describe workflow

    Retrieves the details of the workflow record associated with the given workflowId.

  • Read

    Download workflow files

    Downloads the workflow files for the Nextflow main job associated with the given workflowId.

  • Read

    Download workflow task files

    Downloads the workflow files of the task identified by the given taskId.

  • Read

    Describe workflow launch

    Retrieves the details of the workflow launch associated with the given workflowId.

  • Read

    Get workflow logs

    Retrieves the output logs for the Nextflow main job of the workflow identified by the given workflowId.

  • Read

    Get workflow task logs

    Retrieves the output logs for the workflow task identified by the given taskId.

  • Read

    Get the execution metrics for the given Workflow ID

    GET /workflow/{workflowId}/metrics

  • Read

    Retrieve the execution progress for the given Workflow ID

    GET /workflow/{workflowId}/progress

  • Read

    Check workflow star status

    Confirms whether the given workflowId is starred.

  • Read

    Describe a task entity with the given ID

    GET /workflow/{workflowId}/task/{taskId}

  • Read

    List the tasks for the given Workflow ID and filter parameters

    GET /workflow/{workflowId}/tasks

  • Read

    Summarize the tasks of the given workflow per process, optionally filtered by search

    Rolls up matching tasks per process so the run-timeline grouped view stays complete on large runs, where a capped/paged task list could hide processes whose matches fall past the page.

  • Write

    Launch workflow

    Submits a workflow execution.

  • Write

    Apply a partial update to the workflow-extension metadata for the given Workflow ID

    Updates only the workflow-extension store; never a core workflow field. Designed to carry workflow-extension attributes generally so future fields reuse this operation. Returns the updated workflow representation.

  • Write

    Star workflow

    Adds the workflow identified by the given workflowId to your list of starred workflows.

  • Destructive

    Delete workflows

    Deletes the workflow records identified by the given list of workflowIds.

  • Destructive

    Delete the Workflow entity with the given ID

    DELETE /workflow/{workflowId}

  • Destructive

    Cancel workflow

    Cancels the workflow execution identified by the given workflowId.

  • Destructive

    Unstar workflow

    Removes the workflow identified by the given workflowId from your list of starred workflows.

See How connections work for access and permissions, or browse all integrations.