B3 Pipedream API
The Pipedream API from B3 — 5 operation(s) for pipedream.
OpenAPI Specification
openapi: 3.1.0
info:
description: Workflow management API for B3OS
title: B3OS Workflow Action Pipedream API
version: '1.0'
tags:
- name: Pipedream
paths:
/v1/pipedream/accounts/{id}:
delete:
description: Disconnect a Pipedream account
parameters:
- description: Account ID
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePipedreamAccountSuccessResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Not Found
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Service Unavailable
tags:
- Pipedream
get:
description: Get a Pipedream account by ID
parameters:
- description: Account ID
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetPipedreamAccountSuccessResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Not Found
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Service Unavailable
tags:
- Pipedream
/v1/pipedream/actions/{action}/run:
post:
description: Execute a Pipedream action
parameters:
- description: Action key
in: path
name: action
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
- $ref: '#/components/schemas/RunPipedreamActionParams'
summary: body
description: Action execution parameters
description: Action execution parameters
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RunPipedreamActionSuccessResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Not Found
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Internal Server Error
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Service Unavailable
tags:
- Pipedream
/v1/pipedream/apps:
get:
description: List available Pipedream apps/integrations
parameters:
- description: Search query to filter apps
in: query
name: q
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListPipedreamAppsSuccessResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Service Unavailable
tags:
- Pipedream
/v1/pipedream/apps/{app}/actions:
get:
description: List available actions for a Pipedream app
parameters:
- description: App slug (e.g., 'twilio', 'google_sheets')
in: path
name: app
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListPipedreamActionsSuccessResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Not Found
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Service Unavailable
tags:
- Pipedream
/v1/pipedream/connect-token:
get:
description: Get a Pipedream Connect token for the frontend SDK
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetConnectTokenSuccessResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Service Unavailable
tags:
- Pipedream
components:
schemas:
ListPipedreamAppsSuccessResponse:
properties:
code:
example: 200
type: integer
data:
items:
$ref: '#/components/schemas/PipedreamApp'
type: array
uniqueItems: false
message:
example: success
type: string
requestId:
example: abc-123
type: string
type: object
ListPipedreamActionsSuccessResponse:
properties:
code:
example: 200
type: integer
data:
items:
$ref: '#/components/schemas/PipedreamAction'
type: array
uniqueItems: false
message:
example: success
type: string
requestId:
example: abc-123
type: string
type: object
RunPipedreamActionSuccessResponse:
properties:
code:
example: 200
type: integer
data:
additionalProperties: {}
type: object
message:
example: success
type: string
requestId:
example: abc-123
type: string
type: object
RunPipedreamActionParams:
properties:
accountId:
type: string
configuredProps:
additionalProperties: {}
type: object
required:
- accountId
- configuredProps
type: object
PipedreamAccount:
properties:
appName:
type: string
appSlug:
type: string
createdAt:
type: string
healthy:
type: boolean
id:
type: string
name:
type: string
type: object
PipedreamAction:
properties:
description:
type: string
key:
type: string
name:
type: string
version:
type: string
type: object
PipedreamApp:
properties:
authType:
type: string
categories:
items:
type: string
type: array
uniqueItems: false
description:
type: string
id:
type: string
imgSrc:
type: string
name:
type: string
nameSlug:
type: string
type: object
GetConnectTokenSuccessResponse:
properties:
code:
example: 200
type: integer
data:
$ref: '#/components/schemas/PipedreamConnectToken'
message:
example: success
type: string
requestId:
example: abc-123
type: string
type: object
GetPipedreamAccountSuccessResponse:
properties:
code:
example: 200
type: integer
data:
$ref: '#/components/schemas/PipedreamAccount'
message:
example: success
type: string
requestId:
example: abc-123
type: string
type: object
DeletePipedreamAccountSuccessResponse:
properties:
code:
example: 200
type: integer
message:
example: success
type: string
requestId:
example: abc-123
type: string
type: object
PipedreamConnectToken:
properties:
expiresAt:
type: string
token:
type: string
type: object
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse:
properties:
code:
type: integer
details:
items: {}
type: array
uniqueItems: false
message:
type: string
requestId:
type: string
type: object