Skip to content
Changelog

Report a bug

Turbot Pipes integration: operations for AI agents

Turbot Pipes connects to Type.com as an integration. This page lists the 530 operations documented for Claude and Codex in Type.com: 275 read, 179 write, 76 destructive.

About Turbot Pipes

Turbot Pipes is an intelligence, automation, and security platform built specifically for DevOps, offering hosted Steampipe database instances, shared dashboards, snapshots, and more.

Categories: Developer Tools & IT

How to connect Turbot Pipes to Type.com

Access
Organization connection: one shared account for the workspace.

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

Documented operations

530 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.

530 operations listed.

Actors

  • Read

    Actor information

    Returns the actor information.

  • Read

    List actor activity

    List the activity for an actor.

  • Read

    List actor connections

    List the connections for an actor.

  • Read

    List actor orgs

    List the orgs and org workspaces for an actor, along with role within each.

  • Read

    List org invites for actor

    List the orgs to which the actor has been invited.

  • Read

    List actor workspaces

    List the workspaces for an actor.

AIKeys

  • Read

    List tenant AI keys

    Lists AI provider API keys configured at the tenant level.

  • Read

    Get tenant AI key

    Retrieves the AI provider API key metadata at the tenant level.

  • Read

    List org AI keys

    Lists AI provider API keys configured at the organization level.

  • Read

    Get org AI key

    Retrieves the AI provider API key metadata at the organization level.

  • Read

    List user AI keys

    Lists AI provider API keys configured at the user level.

  • Read

    Get user AI key

    Retrieves the AI provider API key metadata at the user level.

  • Write

    Create tenant AI key

    Creates a new AI provider API key at the tenant level.

  • Write

    Update tenant AI key

    Updates an existing AI provider API key at the tenant level.

  • Write

    Test tenant AI key

    Tests whether an AI provider API key is valid at the tenant level. If a key is not provided in the body, the existing saved key for the provider will be tested.

  • Write

    Create org AI key

    Creates a new AI provider API key at the organization level.

  • Write

    Update org AI key

    Updates an existing AI provider API key at the organization level.

  • Write

    Test org AI key

    Tests whether an AI provider API key is valid at the organization level. If a key is not provided in the body, the existing saved key for the provider will be tested.

  • Write

    Create user AI key

    Creates a new AI provider API key at the user level.

  • Write

    Update user AI key

    Updates an existing AI provider API key at the user level.

  • Write

    Test user AI key

    Tests whether an AI provider API key is valid at the user level. If a key is not provided in the body, the existing saved key for the provider will be tested.

  • Destructive

    Delete tenant AI key

    Deletes an existing AI provider API key at the tenant level.

  • Destructive

    Delete org AI key

    Deletes an existing AI provider API key at the organization level.

  • Destructive

    Delete user AI key

    Deletes an existing AI provider API key at the user level.

Tenants

  • Read

    Tenant audit logs

    Returns the audit logs for a custom tenant.

  • Read

    Get tenant settings

    Retrieves the tenant settings.

  • Read

    List tenants

    List tenants the actor is a member of.

  • Read

    Get tenant

    Retrieves the tenant information.

  • Read

    Get tenant avatar

    Get public avatar for a tenant.

  • Read

    List tenant constraints

    List all applicable constraints for a tenant.

  • Read

    List tenant usage

    List all usage metrics for a tenant.

  • Write

    Update tenant settings

    Update settings for a custom tenant.

  • Write

    Create tenant

    Creates a tenant.

  • Write

    Update tenant

    Updates various information about a tenant.

  • Write

    Create tenant avatar

    Create custom avatar for a tenant.

  • Destructive

    Delete tenant

    Deletes the specified tenant.

  • Destructive

    Delete tenant avatar

    Delete custom avatar for a tenant.

Auth

  • Read

    Auth Provider

    With an authentication provider, users can access Turbot Pipes with single sign-on (SSO) using credentials from a third party. Turbot Pipes currently supports GitHub and Google as an authentication provider.

  • Read

    Auth provider callback

    Auth provider callback.

  • Read

    Confirm user login

    Confirm user login. An invalid, expired or used link redirects to the invalid link page.

  • Read

    Get temporary token request

    Get a temporary token request status with token.

  • Read

    User logout

    Removes the session that is associated with the user.

  • Read

    Confirm user signup

    Confirm user signup. An invalid, expired or used link redirects to the invalid link page.

  • Write

    Post auth provider callback

    Auth provider callback.

  • Write

    User login

    User login.

  • Write

    Generate temporary token request

    Generate a temporary token request for CLI login.

  • Write

    Update temporary token request

    Update a temporary token request status.

  • Write

    User signup

    New user signup.

  • Destructive

    Delete temporary token request

    Delete a temporary token request status.

Tenant Connections

  • Read

    List tenant connections

    List connections for a tenant.

  • Read

    Get tenant connection

    Get connection for a tenant.

  • Read

    List tenant connection permissions

    List permissions for a connection defined on a custom tenant.

  • Read

    Get tenant connection permission

    Get permission for a connection defined on a custom tenant.

  • Read

    List tenant connection workspaces

    List the workspaces that a tenant connection has been added to.

  • Write

    Create tenant connection

    Creates a new connection for a custom tenant.

  • Write

    Update tenant connection

    Update the details of a connection belonging to a tenant.

  • Write

    Create tenant connection permission

    Create permissions for a tenant connection.

  • Write

    Update tenant connection permission

    Update permission for a connection defined on a custom tenant.

  • Write

    Test tenant connection

    Test the config for a tenant connection to check for basic connectivity.

  • Destructive

    Delete tenant connection

    Deletes a connection defined at the tenant level.

  • Destructive

    Delete tenant connection permission

    Delete permission for a connection defined on a custom tenant.

Tenant Connection Folders

  • Read

    List tenant connection folders

    List connection folders for a custom tenant.

  • Read

    Get tenant connection folder

    Get connection folder for a custom tenant.

  • Read

    List tenant connection folder permissions

    List permissions for a connection folder defined on a custom tenant.

  • Read

    Get tenant connection folder permission

    Get permission for a connection folder defined on a custom tenant.

  • Read

    List tenant connection folder workspaces

    List the workspaces that a tenant connection folder has been added to.

  • Write

    Create tenant connection folder

    Creates a new connection folder for a custom tenant.

  • Write

    Update tenant connection folder

    Update the details of a connection folder belonging to a custom tenant.

  • Write

    Create tenant connection folder permission

    Create permissions for a connection folder defined on a custom tenant.

  • Write

    Update tenant connection folder permission

    Update permission for a connection folder defined on a custom tenant.

  • Destructive

    Delete tenant connection folder

    Deletes a connection folder defined at the tenant level.

  • Destructive

    Delete tenant connection folder permission

    Delete permission for a connection folder defined on a custom tenant.

Tenant Connection Tree

  • Read

    List tenant connection tree

    List connection tree for a tenant.

Identities

  • Read

    List identities

    List identities with their public information.

  • Read

    Get identity

    Get public information for an identity.

  • Read

    Get identity avatar

    Get public avatar for an identity.

Tenant Integrations

  • Read

    List tenant integrations

    List integrations configured on a custom tenant.

  • Read

    Get tenant integration

    Get details of an integration configured on a custom tenant.

  • Read

    Install GitHub integration on a custom tenant

    Install a GitHub integration on a custom tenant.

  • Read

    List tenant integration Slack channels

    List Slack channels that are given access to a tenant Slack integration.

  • Read

    Install Slack integration on a custom tenant

    Install a Slack integration on a custom tenant.

  • Write

    Create tenant integration

    Creates a new integration on a custom tenant.

  • Write

    Update tenant integration

    Update details of an integration configured on a custom tenant.

  • Write

    Run tenant integration command

    Run a command for a tenant integration

  • Write

    Test custom tenant integration

    Test the config for a custom tenant integration to check for basic connectivity before you create it.

  • Destructive

    Delete tenant integration

    Delete an integration configured on a custom tenant.

Tenant Log Archives

  • Read

    List tenant log archives

    List log archives for the tenant

  • Read

    Get tenant log archive

    Get a log archive for the tenant

  • Read

    Download a tenant log archive

    Download a log archive for the tenant

  • Destructive

    Delete tenant log archive

    Delete a log archive for the tenant

Tenant Notifiers

  • Read

    List tenant notifiers

    List all notifiers for a custom tenant

  • Read

    Get tenant notifier

    Get a notifier for a custom tenant

  • Write

    Create tenant notifier

    Create a new notifier for a custom tenant

  • Write

    Update tenant notifier

    Update a notifier for a custom tenant

  • Destructive

    Delete tenant notifier

    Delete a notifier for a custom tenant

Orgs

  • Read

    List orgs

    List all the organizations.

  • Read

    Get org

    Retrieves the organization information.

  • Read

    Org audit logs

    Returns the audit logs for an org.

  • Read

    Get org billing plan.

    Get the current organization billing plan.

  • Read

    List org constraints

    List all applicable constraints for an org.

  • Read

    List org usage

    List all usage metrics for an org.

  • Write

    Create org

    Creates an organization.

  • Write

    Update org

    Updates the handle name, display name, or the URL of an organization.

  • Write

    Create org avatar

    Create custom avatar for an org.

  • Destructive

    Delete org

    Deletes the specified organization if you have the appropriate access.

  • Destructive

    Delete org avatar

    Delete custom avatar for an org.

Org Billing

  • Read

    List org invoices

    List org invoices. TODO: paging, Stripe suports this we need to to implement it.

  • Read

    Get an organization invoice

    Get an invoice for an organization.

  • Read

    List org billing payment methods.

    List org billing payment methods.

  • Read

    Get org billing payment method.

    List org billing payment method.

  • Read

    Get upcoming invoice

    Get upcoming invoice. Can be used to let subscriber know the estimated amount for next invoice.

  • Read

    List org subscriptions

    List org subscriptions. TODO: org should only have 1 active subscriptions, but what if we change subscriptions (is it possible?). Should we display old subscriptions?

  • Read

    Get org subscription

    Get org subscription

  • Write

    Create Stripe billing intent

    Create Stripe billing intent

  • Write

    Update org billing payment method.

    Update org billing payment method.

  • Write

    Create a new subscription

    Create a new subscription for the org. There can only be 1 active subscription per org.

  • Write

    Update org subscription

    Update org subscription. Use this API to "stop cancel at the next billing period" by passing "stopcancel" in the action parameter.

  • Destructive

    Delete org billing payment method.

    Delete org billing payment method. Deleting default payment method will result in a 403 (forbidden) error.

  • Destructive

    Delete org subscription

    Delete org subscription. TODO: prorate, when to delete subscription. Webhook when the Subscription is finally deleted.

Org Connections

  • Read

    List org connections

    List connections for an organization.

  • Read

    Get org connection

    Get the details of a connection belonging to an org.

  • Read

    List org connection permissions

    List permissions for a connection defined on an org.

  • Read

    Get org connection permission

    Get permission for a connection defined on an org.

  • Read

    List org connection workspaces

    List the workspaces that an org connection has been added to.

  • Write

    Create org connection

    Creates a new connection for an organization.

  • Write

    Update org connection

    Update the details of a connection belonging to an org.

  • Write

    Create org connection permission

    Create permissions for a connection defined on an org.

  • Write

    Update org connection permission

    Update permission for a connection defined on an org.

  • Write

    Test org connection

    Test the config for an org connection to check for basic connectivity before you create it.

  • Destructive

    Delete org connection

    Deletes a connection belonging to an org.

  • Destructive

    Delete org connection permission

    Delete permission for a connection defined on an org.

Org Connection Folders

  • Read

    List org connection folders

    List connection folders for an org.

  • Read

    Get org connection folder

    Get connection folder for an org.

  • Read

    List org connection folder permissions

    List permissions for a connection folder defined on an organization.

  • Read

    Get org connection folder permission

    Get permission for a connection folder defined on an org.

  • Read

    List org connection folder workspaces

    List the workspaces that an org connection folder has been added to.

  • Write

    Create org connection folder

    Creates a new connection folder for an org.

  • Write

    Update org connection folder

    Update the details of an org connection folder.

  • Write

    Create org connection folder permission

    Create permissions for a connection folder defined on the organization level.

  • Write

    Update org connection folder permission

    Update permission for a connection folder defined on an org.

  • Destructive

    Delete org connection folder

    Deletes an org connection folder.

  • Destructive

    Delete org connection folder permission

    Delete permission for a connection folder defined on an org.

Org Connection Tree

  • Read

    List tenant connection tree

    List connection tree for a tenant.

Org Integrations

  • Read

    List org integrations

    List integrations configured for an organization.

  • Read

    Get org integration

    Get details of an integration configured on an organization.

  • Read

    Install GitHub integration for an org

    Install a GitHub integration for an org identity.

  • Read

    List org integration Slack channels

    List Slack channels that are given access to a user Slack integration.

  • Read

    Install Slack integration for an org

    Install a Slack integration for an org identity.

  • Write

    Create org integration

    Creates a new integration for an organization.

  • Write

    Update org integration

    Update details of an integration configured for an organization.

  • Write

    Run org integration command

    Run a command for an org integration

  • Write

    Test org integration

    Test the config for an org integration to check for basic connectivity before you create it.

  • Destructive

    Delete org integration

    Delete an integration configured for an organization.

Org Members

  • Read

    List Organization Members

    List all members of an organization who are invited / accepted.

  • Read

    Confirm org member invite

    Confirm org member invite.

  • Read

    Get org member

    Get org member.

  • Write

    Create Org Member

    Add a user as a member of an org in a custom tenant.

  • Write

    Invite org member

    Invite member to an org.

  • Write

    Update org member

    Update the role of the member.

  • Destructive

    Delete org member invite

    Delete the org member invite.

  • Destructive

    Delete org member

    Delete the user from the org.

Org Notifiers

  • Read

    List org notifiers

    List all notifiers for an org

  • Read

    Get org notifier

    Get a notifier for an org

  • Write

    Create org notifier

    Create a new notifier for an org

  • Write

    Update org notifier

    Update a notifier for an org

  • Destructive

    Delete org notifier

    Delete a notifier for an org

Org Processes

  • Read

    List Org processes

    List processes for an org.

  • Read

    Get Org process

    Get a process for an org.

  • Read

    List Org process logs

    List the process logs for a given process of an org.

Org Service Accounts

  • Read

    List organization service accounts

    Lists service accounts at the organization level.

  • Read

    Get organization service account

    Retrieves a specific org-level service account.

  • Write

    Create a service account at the organization level

    Create a new service account at the organization level.

  • Write

    Update an organization service account

    Update an existing service account at the organization level.

  • Destructive

    Delete an organization service account

    Delete an existing service account at the organization level.

Org Service Account Audit Logs

  • Read

    List audit logs for an org service account

    Returns the audit logs where the service account is either the actor or the identity (org-level service account).

Org Service Account Tokens

  • Read

    List organization service account tokens

    Lists tokens for an organization-level service account.

  • Read

    Get an organization service account token

    Retrieves a specific token for an organization-level service account.

  • Write

    Create an organization service account token

    Create a new token for an organization-level service account.

  • Write

    Update an organization service account token

    Update an existing token for an organization-level service account.

  • Destructive

    Delete an organization service account token

    Delete a token for an organization-level service account.

Org Workspaces

  • Read

    List org workspaces

    List the workspace for an organization.

  • Read

    Get org workspace

    Get the details for a workspace in an organization.

  • Read

    Org workspace audit logs

    Returns the audit logs for an org workspace.

  • Read

    Org workspace logs

    Returns the workspace logs for an org.

  • Read

    Query org workspace

    Performs a query in an org workspace. Results are limited to 5000 rows or 30 seconds of query execution.

  • Read

    Query org workspace

    Performs a query in an org workspace. Results are limited to 5000 rows or 30 seconds of query execution.

  • Read

    Query org workspace with extensions

    Performs a query in an org workspace, with content type and content encoding forming part of the API path. Results are limited to 5000 rows or 30 seconds of query execution.

  • Read

    Query org workspace with extensions

    Performs a query in an org workspace, with content type and content encoding forming part of the API path. Results are limited to 5000 rows or 30 seconds of query execution.

  • Write

    Create org workspace

    Creates a new workspace for an organization. The limit is 10 per organization. If you require more than 10, you must contact support to request an increase.

  • Write

    Update org workspace

    Update a workspace in an organization.

  • Write

    Run org workspace command

    Run a command in the workspace. Valid commands are: reboot.

  • Destructive

    Delete org workspace

    Deletes the workspace specified in the request.

Org Workspace Aggregators

  • Read

    List aggregators for an org workspace

    List aggregators for a workspace of an org.

  • Read

    Get an aggregator for a org workspace

    Get the details of an aggregator belonging to a workspace of an org.

  • Read

    List connections in the scope of an aggregator for a org workspace

    List all connections that are a part of an aggregator defined in a workspace of an org.

  • Read

    Get a connection in the scope of an aggregator for a org workspace

    Get a connection that is a part of an aggregator defined in a workspace of an org.

  • Write

    Create an aggregator for an org workspace

    Creates an aggregator for a workspace of an org.

  • Write

    Update an aggregator for a org workspace

    Update the details of an aggregator belonging to a workspace of an org.

  • Destructive

    Delete an aggregator for a org workspace

    Deletes an aggregator belonging to a workspace of an org.

Org Workspace Conversations

  • Read

    List org workspace conversations

    Lists AI conversations in an org workspace with optional filtering and pagination.

  • Read

    Get org workspace conversation

    Retrieves details for a specific org workspace conversation.

  • Write

    Chat in org workspace

    Sends a chat message to the AI agent in an org workspace. Creates a new conversation if conversationid is not provided.

  • Write

    Update org workspace conversation

    Updates an org workspace conversation (e.g., title).

  • Destructive

    Delete org workspace conversation

    Deletes a specific org workspace conversation.

Org Workspace Conversation Artifacts

  • Read

    Get org workspace conversation artifact metadata

    Retrieves metadata for a specific artifact created by an org workspace conversation.

Org Workspace Artifacts

  • Read

    Download org workspace artifact

    Downloads an artifact file from an org workspace AI conversation.

Org Workspace Conversation Messages

  • Read

    List org workspace conversation messages

    Lists messages for a specific org workspace conversation with pagination.

Org Workspace AIModels

  • Read

    List org workspace AI models

    Lists available AI models for an org workspace based on configured AI keys.

Org Workspace Connection Associations

  • Read

    List org workspace connection associations

    List the connections associated with a workspace.

  • Read

    Get org workspace connection association

    Get the details for a workspace and connection association on an organization.

  • Write

    Create org workspace connection association

    Associate a connection with the workspace. A workspace can have multiple association.

  • Destructive

    Delete org workspace connection association

    Dissociates or delete the workspace and connection association.

Org Workspace Connections

  • Read

    List org workspace connection associations

    List the connections associated with a workspace.

  • Read

    Get org workspace connection association

    Get the details for a workspace and connection association on an organization.

  • Write

    Create a connection for an org workspace or associate an org connection to the workspace

    Allows to create a connection on a workspace for an org or associate a connection already existing on the org to the workspace.

  • Write

    Update org workspace connection

    Update the details of a connection belonging to a workspace of an org.

  • Write

    Test org workspace connection

    Test the config for a connection configured on an org workspace to check for basic connectivity.

  • Destructive

    Delete org workspace connection association

    Dissociates or delete the workspace and connection association.

Org Workspace Connection Folders

  • Read

    List org workspace connection folders

    List connection folders for an org workspace.

  • Read

    Get org workspace connection folder

    Get connection folder for a org workspace.

  • Write

    Create org workspace connection folder

    Creates a new connection folder in a workspace of an org.

  • Write

    Update org workspace connection folder

    Update the details of a connection folder belonging to an org workspace.

  • Destructive

    Delete org workspace connection folder

    Deletes a connection folder defined at an org workspace.

Org Workspace Connection Tree

  • Read

    List org workspace connection tree

    List connection tree for an org workspace.

Org Workspace Datatanks

  • Read

    List org workspace Datatank

    List the org workspace Datatank.

  • Read

    Get org workspace Datatank

    Get the details for the workspace Datatank.

  • Write

    Create org workspace Datatank

    Creates a new org workspace tank.

  • Write

    Update org workspace Datatank

    Update the org workspace Datatank.

  • Destructive

    Delete org workspace Datatank

    Deletes the org workspace Datatank.

Org Workspace Datatank Tables

  • Read

    List org workspace Datatank tables

    List the org workspace Datatank tables.

  • Read

    Get org workspace Datatank table

    Get the details for the workspace Datatank table

  • Write

    Create org workspace Datatank table

    Creates a new org workspace tank table.

  • Write

    Update org workspace Datatank table

    Update the org workspace Datatank table.

  • Destructive

    Delete org workspace Datatank table

    Deletes the org workspace Datatank table.

Org Workspace Datatank Parts

  • Read

    List org workspace Datatank partitions

    List the org workspace Datatank partitions

  • Read

    Get org workspace Datatank table partition

    Get the details for the workspace Datatank table partition

  • Write

    Update org workspace Datatank table partition

    Update the org workspace Datatank table partition.

  • Write

    Run org workspace Datatank table partition command

    Run org workspace Datatank table partition command. Valid commands are: refresh.

Org Workspace Flowpipe Inputs

  • Read

    Get org workspace flowpipe form

    Get details of a Flowpipe input step form for an org workspace

  • Read

    List org workspace flowpipe inputs

    List Flowpipe inputs for an org workspace

  • Read

    Get org workspace flowpipe input

    Get details of a Flowpipe input for an org workspace

  • Write

    Post org workspace flowpipe form response

    Submit response to a Flowpipe input step form for an org workspace

  • Write

    Create org workspace flowpipe input

    Create a Flowpipe input for an org workspace

Org Workspace Flowpipe Mods

  • Read

    Get organization workspace installed flowpipe mod

    Get organization workspace installed flowpipe mod by mod alias

  • Write

    Install flowpipe mod to organization workspace.

    Install flowpipe mod to a organization workspace.

  • Write

    Update a flowpipe mod in an organization workspace

    Update a flowpipe mod in an organization workspace

  • Destructive

    Uninstall flowpipe mod from organization workspace.

    Uninstall flowpipe mod from organization workspace.

Org Workspace Flowpipe Mod Variables

  • Read

    List variables in an organization flowpipe workspace mod

    List all variables applicable for a flowpipe mod in a workspace specific to an organization

  • Read

    Get setting for a flowpipe mod variable in an organization workspace

    Get setting for a flowpipe mod variable in an organization workspace

  • Write

    Create a setting for a flowpipe mod variable in an organization workspace

    Create a setting for a flowpipe mod variable in an organization workspace

  • Write

    Update setting for a flowpipe mod variable in an organization workspace

    Update setting for a flowpipe mod variable in an organization workspace

  • Destructive

    Delete setting for a flowpipe mod variable in an organization workspace

    Delete setting for a flowpipe mod variable in an organization workspace

Org Workspace Flowpipe Pipelines

  • Read

    List organization workspace pipelines

    Lists the pipelines for an organization workspace.

  • Read

    Get org workspace pipeline

    Get the details of a pipeline for a workspace of an organization.

  • Read

    Get org workspace pipeline triggers

    Get the list of triggers that a pipeline is associated with.

  • Write

    Run organization workspace Flowpipe pipeline command

    Run a command on a pipeline in a workspace belonging to an organization.

Org Workspace Flowpipe Triggers

  • Read

    Get org workspace flowpipe trigger

    Get the details of a trigger for a workspace of an org.

  • Read

    List organization workspace triggers

    Lists the pipelines for an organization workspace.

  • Write

    Update org workspace trigger

    Updates a trigger for a workspace of an org.

  • Write

    Run organization workspace Flowpipe trigger command

    Run a command on a trigger in a workspace belonging to an organization.

  • Write

    Create org workspace trigger

    Creates a new trigger for an org workspace.

  • Destructive

    Delete org workspace pipeline

    Deletes the pipeline specified in the request for a workspace of an organization.

Org Workspace Integrations

  • Read

    List org workspace integrations

    List integrations available for an organization workspace. If run on a custom tenant this will return integrations configured both on tenant and org level.

  • Read

    Get org workspace integration

    Get details of an integration available for a workspace belonging to an organization.

  • Read

    List org workspace integration github respositories

    List respositories that are given access to the integration available for an organization workspace.

  • Read

    List org workspace integration github respository heads

    List heads for a respository of an integration available for an organization workspace.

  • Read

    List org workspace integration gitlab projects

    List projects that are given access to the integration available for an organization workspace.

  • Read

    List org workspace integration gitlab project branches

    List branches for a gitlab project of an integration available for an organization workspace.

Org Workspace Members

  • Read

    List Organization Workspace Members

    List all members of a workspace in an organization who has accepted / invited.

  • Read

    Get Org Workspace Member

    Get details of a member belonging to a workspace of an organization.

  • Write

    Create Org Workspace Member

    Add an individual as a member of a workspace in an organization.

  • Write

    Update Org Workspace Member

    Update the role of a member belonging to a workspace of an organization.

  • Destructive

    Delete Org Workspace Member

    Remove a member from a workspace of an organization.

Org Workspace Mods

  • Read

    List organization workspace installed mods

    List organization workspace installed mods

  • Read

    Get organization workspace installed mod

    Get organization workspace installed mod by mod alias

  • Write

    Install a mod to an organization workspace

    Install a mod to an organization workspace

  • Write

    Update a mod in an organization workspace

    Update a mod in an organization workspace

  • Destructive

    Uninstall mod from organization workspace.

    Uninstall mod from organization workspace.

Org Workspace Mod Variables

  • Read

    List variables in an organization workspace mod

    List all variables applicable for a mod in a workspace specific to an organization

  • Read

    Get setting for a mod variable in an organization workspace

    Get setting for a mod variable in an organization workspace

  • Write

    Create a setting for a mod variable in an organization workspace

    Create a setting for a mod variable in an organization workspace

  • Write

    Update setting for a mod variable in an organization workspace

    Update setting for a mod variable in an organization workspace

  • Destructive

    Delete setting for a mod variable in an organization workspace

    Delete setting for a mod variable in an organization workspace

Org Workspace Notifiers

  • Read

    List org workspace notifiers

    List all notifiers for an org workspace

  • Read

    Get org workspace notifier

    Get a notifier for an org workspace

  • Write

    Create org workspace notifier

    Create a new notifier for an org workspace

  • Write

    Update org workspace notifier

    Update a notifier for an org workspace

  • Write

    Post org workspace notifier commands

    Post a command for a notifier for an orgs workspace

  • Destructive

    Delete org workspace notifier

    Delete a notifier for an org workspace

Org Workspace Pipelines

  • Read

    List org workspace pipelines

    Lists the pipelines for a workspace of an organization.

  • Read

    Get org workspace pipeline

    Get the details of a pipeline for a workspace of an organization.

  • Write

    Create org workspace pipeline

    Creates a new pipeline for a workspace of an organization.

  • Write

    Update org workspace pipeline

    Updates a pipeline for a workspace of an organization.

  • Write

    Run org workspace pipeline command

    Run a command on a pipeline in a workspace belonging to an organization.

  • Destructive

    Delete org workspace pipeline

    Deletes the pipeline specified in the request for a workspace of an organization.

Org Workspace Processes

  • Read

    List org workspace processes

    List the processes associated with an org workspace.

  • Read

    Get org workspace process

    Get the details for the process.

  • Read

    List org workspace process logs

    List the process logs associated with a workspace process.

  • Write

    Run org workspace process command

    Run a command against an org workspace process.

Org Workspace Schemas

  • Read

    List org workspace schemas

    List the schemas for the org workspace. This will consist of the aggregators, datatanks and identity-level connections associated with the workspace.

  • Read

    Get org workspace schema

    Get the details for an org workspace schema.

  • Read

    List org workspace schema tables

    List the tables for an org workspace schema.

  • Read

    Get org workspace schema table

    Get details about a specific table in a org workspace schema.

  • Write

    Attach a schema to an org workspace

    Attach an identity-level connection schema to an org workspace.

  • Destructive

    Detach a schema from an org workspace

    Detach an identity-level connection schema from an org workspace.

Org Workspace Snapshots

  • Read

    List org workspace snapshots

    List the workspace snapshots for an org.

  • Read

    Get org workspace snapshot

    Get the details for an org workspace snapshot.

  • Read

    Download org workspace snapshot

    Downloads the full data for an org workspace snapshot.

  • Write

    Create org workspace snapshot

    Creates a new workspace snapshot for an org.

  • Write

    Update org workspace snapshot

    Updates an org workspace snapshot.

  • Destructive

    Delete org workspace snapshot

    Deletes an org workspace snapshot.

Org Workspace Usages

  • Read

    List org workspace usage

    List the usage associated with an org workspace.

Tenant Service Accounts

  • Read

    List tenant service accounts

    Lists service accounts at the tenant level.

  • Read

    Get tenant service account

    Retrieves a specific tenant-level service account.

  • Write

    Create a tenant service account

    Create a new service account at the tenant level.

  • Write

    Update a tenant service account

    Update an existing service account at the tenant level.

  • Destructive

    Delete a tenant service account

    Delete an existing service account at the tenant level.

Tenant Service Account Audit Logs

  • Read

    List audit logs for a tenant service account

    Returns the audit logs where the service account is either the actor or the identity (tenant-level service account).

Tenant Service Account Tokens

  • Read

    List tenant service account tokens

    Lists tokens for a tenant-level service account.

  • Read

    Get a tenant service account token

    Retrieves a specific token for a tenant-level service account.

  • Write

    Create a tenant service account token

    Create a new token for a tenant-level service account.

  • Write

    Update a tenant service account token

    Update an existing token for a tenant-level service account.

  • Destructive

    Delete a tenant service account token

    Delete a token for a tenant-level service account.

Tenant Billing

  • Read

    List tenant invoices

    List tenant invoices. TODO: paging, Stripe suports this we need to to implement it.

  • Read

    Get a tenant invoice

    Get an invoice for a tenant.

  • Read

    List tenant billing payment methods.

    List tenant billing payment methods.

  • Read

    Get tenant billing payment method.

    List tenant billing payment method.

  • Read

    Get tenant billing plan.

    Get the current tenant billing plan.

  • Read

    Get upcoming invoice

    Get upcoming invoice. Can be used to let subscriber know the estimated amount for next invoice.

  • Read

    List tenant subscriptions

    List tenant subscriptions.

  • Read

    Get tenant subscription

    Get tenant subscription

  • Write

    Create tenant Stripe billing intent

    Create tenant Stripe billing intent

  • Write

    Update tenant billing payment method.

    Update tenant billing payment method.

  • Write

    Create a new subscription

    Create a new subscription for the tenant. There can only be 1 active subscription per tenant.

  • Write

    Update tenant subscription

    Update tenant subscription. Use this API to "stop cancel at the next billing period" by passing "stopcancel" in the action parameter.

  • Destructive

    Delete tenant billing payment method.

    Delete tenant billing payment method. Deleting default payment method will result in a 403 (forbidden) error.

  • Destructive

    Delete tenant subscription

    Delete tenant subscription.

Tenant Members

  • Read

    List Tenant Members

    List all members of a tenant who are invited / accepted.

  • Read

    Confirm tenant member invite

    Confirm tenant member invite.

  • Read

    Get tenant member

    Get tenant member.

  • Write

    Invite tenant member

    Invite member to a tenant.

  • Write

    Update tenant member

    Update the role of a member of a tenant.

  • Destructive

    Delete tenant member invite

    Delete the tenant member invite.

  • Destructive

    Delete tenant member

    Delete the user from the tenant.

Users

  • Read

    List users

    List the users.

  • Read

    Get user

    Retrieves information of the specified user.

  • Read

    User audit logs

    Returns the audit logs for a user.

  • Read

    Get user billing plan.

    Get the current user billing plan.

  • Read

    List user constraints

    List all applicable constraints for a user.

  • Read

    List user emails

    List emails for a user along with other metadata information for each item.

  • Read

    Get user email

    Get a particular user email record along with its metadata information.

  • Read

    Get user password

    Get user password.

  • Read

    Get user preferences

    Get preferences for the user such as email preferences.

  • Read

    List user usage

    List all usage metrics for a user.

  • Write

    Create user

    Creates a new user.

  • Write

    Update user

    Updates the handle name, display name, or the URL of a user.

  • Write

    Create user avatar

    Create custom avatar for a user.

  • Write

    Create user password

    Create or rotate user password.

  • Write

    Update user preferences

    Update preferences for the user e.g. opting out of receiving certain kind of emails.

  • Destructive

    Delete user

    Deletes the specified user.

  • Destructive

    Delete user avatar

    Delete custom avatar for a user.

User Billing

  • Read

    List user invoices

    List user invoices. TODO: paging, Stripe suports this we need to to implement it.

  • Read

    Get a user invoice

    Get an invoice.

  • Read

    List user billing payment methods.

    List user billing payment methods.

  • Read

    Get user billing payment method.

    List user billing payment method.

  • Read

    Get upcoming user invoice

    Get the upcoming invoice for this user. Can be used to let the user know the estimated amount for next invoice.

  • Read

    List user subscriptions

    List user subscriptions. TODO: user should only have 1 active subscriptions, but what if we change subscriptions (is it possible?). Should we display old subscriptions?

  • Read

    Get user subscription

    Get user subscription

  • Write

    Create Stripe billing intent

    Create Stripe billing intent

  • Write

    Update user billing payment method.

    Update user billing payment method.

  • Write

    Create a new subscription

    Create a new subscription for the user. There can only be 1 active subscription per user. TODO: webhook when subscription payment fail? What to do when subscription is deactivated?

  • Destructive

    Delete user billing payment method.

    Delete user billing payment method. Deleting default payment method will result in a 403 (forbidden) error.

  • Destructive

    Delete user subscription

    Delete user subscription. TODO: prorate, when to delete subscription. Webhook when the Subscription is finally deleted.

User Connections

  • Read

    List user connections

    List connections for a user.

  • Read

    Get user connection

    Get the details of a connection belonging to a user.

  • Read

    List user connection workspaces

    List the workspaces that a user connection has been added to.

  • Write

    Create user connection

    Creates a new connection for a user.

  • Write

    Update user connection

    Update the details of a connection belonging to a user.

  • Write

    Test user connection

    Test the config for a user connection to check for basic connectivity.

  • Destructive

    Delete user connection

    Deletes a connection belonging to a user.

User Integrations

  • Read

    List user integrations

    List integrations configuered for a user.

  • Read

    Get user integration

    Get details of an integration configured on a user.

  • Read

    Install GitHub integration for a user

    Install a GitHub integration for a user identity.

  • Read

    List user integration Slack channels

    List Slack channels that are given access to a user Slack integration.

  • Read

    Install Slack integration for a user

    Install a Slack integration for a user identity.

  • Write

    Create user integration

    Creates a new integration for a user. A user can only create a Github integration.

  • Write

    Update user integration

    Update details of an integration configured for a user.

  • Write

    Run user integration command

    Run a command for a user integration

  • Write

    Test user integration

    Test the config for a user integration to check for basic connectivity before you create it.

  • Destructive

    Delete user integration

    Delete an integration configured for a user.

User Notifiers

  • Read

    List user notifiers

    List all notifiers for a user

  • Read

    Get user notifier

    Get a notifier for a user

  • Write

    Create user notifier

    Create a new notifier for a user

  • Write

    Update user notifier

    Update a notifier for a user

  • Destructive

    Delete user notifier

    Delete a notifier for a user

User Processes

  • Read

    List User processes

    List processes for a user.

  • Read

    Get User process

    Get process for a user.

  • Read

    List user process logs

    List the process logs for a given process of a user.

User Tokens

  • Read

    List tokens

    List the token for a user.

  • Read

    Get token

    Retrieves the information of a specified token.

  • Write

    Create token

    Creates a new token for the specified user. The limit is 2 per user.

  • Write

    Update token

    Changes the status of the specified token from Active to Inactive or vice versa.

  • Destructive

    Delete token

    Deletes the token associated with the specified user.

User Workspaces

  • Read

    List user workspaces

    List the workspace for a user.

  • Read

    Get user workspace

    Get the details for the workspace.

  • Read

    User workspace audit logs

    Returns the audit logs for a user workspace.

  • Read

    User workspace logs

    Returns the workspace logs for a user.

  • Read

    Query user workspace

    Performs a query in a user workspace. Results are limited to 5000 rows or 30 seconds of query execution.

  • Read

    Query user workspace

    Performs a query in a user workspace. Results are limited to 5000 rows or 30 seconds of query execution.

  • Read

    Query user workspace with extensions

    Performs a query in a user workspace, with content type and content encoding forming part of the API path. Results are limited to 5000 rows or 30 seconds of query execution.

  • Read

    Query user workspace with extensions

    Performs a query in a user workspace, with content type and content encoding forming part of the API path. Results are limited to 5000 rows or 30 seconds of query execution.

  • Write

    Create user workspace

    Creates a new workspace for a user.

  • Write

    Update user workspace

    Update the workspace for a user.

  • Write

    Run user workspace command

    Run a command in the workspace. Valid commands are: reboot.

  • Destructive

    Delete user workspace

    Deletes the workspace specified in the request by the user.

User Workspace Aggregators

  • Read

    List aggregators for a user workspace

    List aggregators for a workspace of a user.

  • Read

    Get an aggregator for a user workspace

    Get the details of an aggregator belonging to a workspace of a user.

  • Read

    List connections in the scope of an aggregator for a user workspace

    List all connections that are a part of an aggregator defined in a workspace of a user.

  • Read

    Get a connection in the scope of an aggregator for a user workspace

    Get a connection that is a part of an aggregator defined in a workspace of a user.

  • Write

    Create an aggregator for a user workspace

    Creates an aggregator for a workspace of a user.

  • Write

    Update an aggregator for a user workspace

    Update the details of an aggregator belonging to workspace of a user.

  • Destructive

    Delete an aggregator for a user workspace

    Deletes an aggregator belonging to a workspace of a user.

User Workspace Conversations

  • Read

    List user workspace conversations

    Lists AI conversations in a user workspace with optional filtering and pagination.

  • Read

    Get user workspace conversation

    Retrieves details for a specific user workspace conversation.

  • Write

    Chat in user workspace

    Sends a chat message to the AI agent in a user workspace. Creates a new conversation if conversationid is not provided.

  • Write

    Update user workspace conversation

    Updates a user workspace conversation (e.g., title).

  • Destructive

    Delete user workspace conversation

    Deletes a specific user workspace conversation.

User Workspace Conversation Artifacts

  • Read

    Get user workspace conversation artifact metadata

    Retrieves metadata for a specific artifact created by a user workspace conversation.

User Workspace Artifacts

  • Read

    Download user workspace artifact

    Downloads an artifact file from a user workspace AI conversation.

User Workspace Conversation Messages

  • Read

    List user workspace conversation messages

    Lists messages for a specific user workspace conversation with pagination.

User Workspace AIModels

  • Read

    List user workspace AI models

    Lists available AI models for a user workspace based on configured AI keys.

User Workspace Connection Associations

  • Read

    List user workspace connection associations

    List the connections associated with a workspace.

  • Read

    Get user workspace connection association

    Get the details for a workspace and connection association.

  • Write

    Create user workspace connection association

    Associate a connection with the workspace. A workspace can have multiple association.

  • Destructive

    Delete user workspace connection association

    Dissociates or delete the workspace and connection association.

User Workspace Connections

  • Read

    List connections for a user workspace

    List connections explicitly defined or associated to the workspace.

  • Read

    Get user workspace connection association

    Get the details for a workspace and connection association.

  • Write

    Create a connection for a user workspace

    Allows to create a connection on a workspace for a user.

  • Write

    Update user workspace connection

    Update the details of a connection belonging to a workspace of a user.

  • Write

    Test user workspace connection

    Test the config for a connection configured on a user workspace to check for basic connectivity.

  • Destructive

    Delete user workspace connection

    Dissociates or delete the workspace and connection association.

User Workspace Connection Folders

  • Read

    List user workspace connections folders

    List connection folders for a user workspace.

  • Read

    Get user workspace connection folder

    Get connection folder for a user workspace.

  • Write

    Create user workspace connection folder

    Creates a new connection folder in a workspace of a user.

  • Write

    Update user workspace connection folder

    Update the details of a connection folder belonging to a user workspace.

  • Destructive

    Delete user workspace connection folder

    Deletes a connection folder defined at a user workspace.

User Workspace Connection Tree

  • Read

    List user workspace connection tree

    List connection tree for a user workspace.

User Workspace Datatanks

  • Read

    List user workspace Datatank

    List the user workspace Datatank.

  • Read

    Get user workspace Datatank

    Get the details for the workspace Datatank.

  • Write

    Create user workspace Datatank

    Creates a new user workspace tank.

  • Write

    Update user workspace Datatank

    Update the user workspace Datatank.

  • Destructive

    Delete user workspace Datatank table

    Deletes the user workspace Datatank table.

User Workspace Datatank Tables

  • Read

    List user workspace Datatank tables

    List the user workspace Datatank tables.

  • Read

    Get user workspace Datatank table

    Get the details for the workspace Datatank table

  • Write

    Create user workspace Datatank table

    Creates a new user workspace tank table.

  • Write

    Update user workspace Datatank table

    Update the user workspace Datatank table.

  • Destructive

    Delete user workspace Datatank table

    Deletes the user workspace Datatank table.

User Workspace Datatank Parts

  • Read

    List user workspace Datatank partitions

    List the user workspace Datatank partitions

  • Read

    Get user workspace Datatank table partition

    Get the details for the workspace Datatank table partition

  • Write

    Update user workspace Datatank table partition

    Update the user workspace Datatank table partition.

  • Write

    Run user workspace Datatank table partition command

    Run user workspace Datatank table partition command. Valid commands are: refresh.

User Workspace Flowpipe Inputs

  • Read

    Get user workspace flowpipe form

    Get details of a Flowpipe input step form for a user workspace

  • Read

    List user workspace flowpipe inputs

    List Flowpipe inputs for a user workspace

  • Read

    Get user workspace flowpipe input

    Get details of a Flowpipe input for a user workspace

  • Write

    Post user workspace flowpipe form response

    Submit response to a Flowpipe input step form for a user workspace

  • Write

    Create user workspace flowpipe input

    Create a Flowpipe input for a user workspace

User Workspace Flowpipe Mods

  • Read

    Get user workspace installed flowpipe mod

    Get user workspace installed flowpipe mod by mod alias

  • Write

    Install flowpipe mod to a user's workspace

    Install flowpipe mod to a user's workspace

  • Write

    Update a flowpipe mod in a user's workspace

    Update a flowpipe mod in a user's workspace

  • Destructive

    Uninstall flowpipe mod from a user's workspace.

    Uninstall flowpipe mod from a user's workspace

User Workspace Flowpipe Mod Variables

  • Read

    List variables for a user workspace flowpipe mod

    List all variables applicable for a flowpipe mod in a workspace specific to a user

  • Read

    Get setting for a flowpipe mod variable in a user workspace

    Get setting for a flowpipe mod variable in a user workspace

  • Write

    Create a setting for a flowpipe mod variable in a user workspace

    Create a setting for a flowpipe mod variable in a user workspace

  • Write

    Update setting for a flowpipe mod variable in a user workspace

    Update setting for a flowpipe mod variable in a user workspace

  • Destructive

    Delete setting for a flowpipe mod variable in a user workspace

    Delete setting for a flowpipe mod variable in a user workspace

User Workspace Flowpipe Pipelines

  • Read

    List user workspace pipelines

    Lists the pipelines for a user workspace.

  • Read

    Get user workspace pipeline

    Get the details of a pipeline for a workspace of a user.

  • Read

    Get user workspace pipeline triggers

    Get the list of triggers that a pipeline is associated with.

  • Write

    Run user workspace Flowpipe pipeline command

    Run a command on a pipeline in a workspace belonging to a user.

User Workspace Flowpipe Triggers

  • Read

    Get user workspace flowpipe trigger

    Get the details of a trigger for a workspace of a user.

  • Read

    List user workspace triggers

    Lists the triggers for a user workspace.

  • Write

    Update user workspace trigger

    Updates a trigger for a workspace of a user.

  • Write

    Run user workspace Flowpipe trigger command

    Run a command on a trigger in a workspace belonging to a user.

  • Write

    Create user workspace trigger

    Creates a new trigger for a user workspace.

  • Destructive

    Delete user workspace pipeline

    Deletes the pipeline specified in the request for a workspace of a user.

User Workspace Integrations

  • Read

    List user workspace integrations

    List integrations available for a user workspace. If run on a custom tenant this will return integrations configured both on tenant and user level.

  • Read

    Get user workspace integration

    Get details of an integration available for a workspace belonging to a user.

  • Read

    List user workspace integration github respositories

    List respositories that are given access to the integration available for a user workspace.

  • Read

    List user workspace integration github respository heads

    List heads for a respository of an integration available for a user workspace.

  • Read

    List user workspace integration gitlab projects

    List gitlab proejcts that are given access to the integration available for a user workspace.

  • Read

    List user workspace integration gitlab project branches

    List branches for a gitlab project of an integration available for a user workspace.

User Workspace Mods

  • Read

    List user workspace installed mods

    List user workspace installed mods

  • Read

    Get user workspace installed mod

    Get user workspace installed mod by mod alias

  • Write

    Install a mod to a user's workspace

    Install a mod to a user's workspace

  • Write

    Update a mod in a user's workspace

    Update a mod in a user's workspace

  • Destructive

    Uninstall mod from a user's workspace.

    Uninstall mod from a user's workspace

User Workspace Mod Variables

  • Read

    List variables for a user workspace mod

    List all variables applicable for a mod in a workspace specific to a user

  • Read

    Get setting for a mod variable in a user workspace

    Get setting for a mod variable in a user workspace

  • Write

    Create a setting for a mod variable in a user workspace

    Create a setting for a mod variable in a user workspace

  • Write

    Update setting for a mod variable in a user workspace

    Update setting for a mod variable in a user workspace

  • Destructive

    Delete setting for a mod variable in a user workspace

    Delete setting for a mod variable in a user workspace

User Workspace Notifiers

  • Read

    List user workspace notifiers

    List all notifiers for a user workspace

  • Read

    Get user workspace notifier

    Get a notifier for a user workspace

  • Write

    Create user workspace notifier

    Create a new notifier for a user workspace

  • Write

    Update user workspace notifier

    Update a notifier for a user workspace

  • Write

    Post user workspace notifier commands

    Post a command for a notifier for a users workspace

  • Destructive

    Delete user workspace notifier

    Delete a notifier for a user workspace

User Workspace Pipelines

  • Read

    List user workspace pipelines

    Lists the pipelines for a workspace of a user.

  • Read

    Get user workspace pipeline

    Get the details of a pipeline for a workspace of a user.

  • Write

    Create user workspace pipeline

    Creates a new pipeline for a workspace of a user.

  • Write

    Update user workspace pipeline

    Updates a pipeline for a workspace of a user.

  • Write

    Run user workspace pipeline command

    Run a command on a pipeline in a workspace belonging to a user.

  • Destructive

    Delete user workspace pipeline

    Deletes the pipeline specified in the request for a workspace of a user.

User Workspace Processes

  • Read

    List user workspace processes

    List the process associated with a user workspace.

  • Read

    Get user workspace process

    Get the details for a user workspace process.

  • Read

    List user workspace process logs

    List the process logs associated with a workspace process.

  • Write

    Run user workspace process command

    Run a command against a users workspace process.

User Workspace Schemas

  • Read

    List user workspace schemas

    List the schemas for the user workspace. This will consist of the aggregators, datatanks and identity-level connections associated with the workspace.

  • Read

    Get user workspace schema

    Get the details for a user workspace schema.

  • Read

    List user workspace schema tables

    List the tables for a user workspace schema.

  • Read

    Get user workspace schema table

    Get details about a specific table in a user workspace schema.

  • Write

    Attach a schema to a user workspace

    Attach an identity-level connection schema to a user workspace.

  • Destructive

    Detach a schema from a user workspace

    Detach an identity-level connection schema from a user workspace.

User Workspace Snapshots

  • Read

    List user workspace snapshots

    List the workspace snapshots for a user.

  • Read

    Get user workspace snapshot

    Get the details for a user workspace snapshot.

  • Read

    Download user workspace snapshot

    Downloads the full data for a user workspace snapshot.

  • Write

    Create user workspace snapshot

    Creates a new workspace snapshot for a user.

  • Write

    Update user workspace snapshot

    Updates a user workspace snapshot.

  • Destructive

    Delete user workspace snapshot

    Deletes a user workspace snapshot.

User Workspace Usages

  • Read

    List user workspace usage

    List the usage associated with a user workspace.

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