Skip to main content
API docs by Redocly

SkillFlaw (0.1)

Download OpenAPI specification:Download

Chat

Get Public Build Events

Get events for a public build job without requiring authentication.

path Parameters
job_id
required
string (Job Id)
query Parameters
event_delivery
string (EventDeliveryType)
Default: "streaming"
Enum: "streaming" "direct" "polling"

Responses

Response samples

Content type
application/json
null

Cancel Public Build

Cancel a public build job without requiring authentication.

path Parameters
job_id
required
string (Job Id)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Get Public Chat Messages

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)
query Parameters
Session Id (string) or Session Id (null) (Session Id)
Sender (string) or Sender (null) (Sender)
Sender Name (string) or Sender Name (null) (Sender Name)
Order By (string) or Order By (null) (Order By)
Default: "id"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Build Public Tmp

Build a public flow without requiring authentication.

This endpoint is specifically for public flows that don't require authentication. It validates the public flow and runs it using the original flow ID so messages and sessions remain manageable by flow_id.

The endpoint:

  1. Verifies the requested flow is marked as public in the database
  2. Uses the flow owner's permissions to build the flow

Requirements:

  • The flow must be marked as PUBLIC in the database
  • The request must include a client_id cookie

Args: flow_id: UUID of the public flow to build background_tasks: Background tasks manager inputs: Optional input values for the flow data: Optional flow data files: Optional files to include stop_component_id: Optional ID of component to stop at start_component_id: Optional ID of component to start from log_builds: Whether to log the build process flow_name: Optional name for the flow request: FastAPI request object (needed for cookie access) queue_service: Queue service for job management event_delivery: Optional event delivery type - default is streaming

Returns: Dict with job_id that can be used to poll for build status

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)
query Parameters
Stop Component Id (string) or Stop Component Id (null) (Stop Component Id)
Start Component Id (string) or Start Component Id (null) (Start Component Id)
Log Builds (boolean) or Log Builds (null) (Log Builds)
Default: true
Flow Name (string) or Flow Name (null) (Flow Name)
event_delivery
string (EventDeliveryType)
Default: "polling"
Enum: "streaming" "direct" "polling"
Request Body schema: application/json
InputValueRequest (object) or null
FlowDataRequest (object) or null
Array of Files (strings) or Files (null) (Files)

Responses

Request samples

Content type
application/json
{
  • "inputs": {
    },
  • "data": {
    },
  • "files": [
    ]
}

Response samples

Content type
application/json
null

Build Flow

Build and process a flow, returning a job ID for event polling.

This endpoint requires authentication through the CurrentActiveUser dependency. For public flows that don't require authentication, use the /build_public_tmp/flow_id/flow endpoint.

Args: flow_id: UUID of the flow to build background_tasks: Background tasks manager inputs: Optional input values for the flow data: Optional flow data files: Optional files to include stop_component_id: Optional ID of component to stop at start_component_id: Optional ID of component to start from log_builds: Whether to log the build process current_user: The authenticated user queue_service: Queue service for job management flow_name: Optional name for the flow event_delivery: Optional event delivery type - default is streaming request: FastAPI request object used to derive client metadata such as IP

Returns: Dict with job_id that can be used to poll for build status

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)
query Parameters
Stop Component Id (string) or Stop Component Id (null) (Stop Component Id)
Start Component Id (string) or Start Component Id (null) (Start Component Id)
log_builds
boolean (Log Builds)
Default: true
Flow Name (string) or Flow Name (null) (Flow Name)
event_delivery
string (EventDeliveryType)
Default: "polling"
Enum: "streaming" "direct" "polling"
Request Body schema: application/json
InputValueRequest (object) or null
FlowDataRequest (object) or null
Array of Files (strings) or Files (null) (Files)

Responses

Request samples

Content type
application/json
{
  • "inputs": {
    },
  • "data": {
    },
  • "files": [
    ]
}

Response samples

Content type
application/json
null

Get Build Events

Get events for a specific build job.

Requires authentication to prevent unauthorized access to build events.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
job_id
required
string (Job Id)
query Parameters
event_delivery
string (EventDeliveryType)
Default: "streaming"
Enum: "streaming" "direct" "polling"

Responses

Response samples

Content type
application/json
null

Cancel Build

Cancel a specific build job.

Requires authentication to prevent unauthorized build cancellation.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
job_id
required
string (Job Id)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Files

Download Profile Picture

Download profile picture from local filesystem.

Profile pictures are first looked up in config_dir/profile_pictures/, then fallback to the package's bundled profile_pictures directory.

path Parameters
folder_name
required
string (Folder Name)
file_name
required
string (File Name)

Responses

Response samples

Content type
application/json
null

List Profile Pictures

List profile pictures from local filesystem.

Profile pictures are first looked up in config_dir/profile_pictures/, then fallback to the package's bundled profile_pictures directory.

Responses

Response samples

Content type
application/json
null

Upload File

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)
Request Body schema: multipart/form-data
required
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "flowId": "string",
  • "file_path": "string"
}

Download File

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
file_name
required
string (File Name)
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
null

Download Image

Download image from storage for browser rendering.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)
file_name
required
string (File Name)

Responses

Response samples

Content type
application/json
null

List Files

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
null

Delete File

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
file_name
required
string (File Name)
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
null

Upload User File

Upload a file for the current user and track it in the database.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
append
boolean (Append)
Default: false
Request Body schema: multipart/form-data
required
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "user_id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "name": "string",
  • "path": "string",
  • "size": 0,
  • "provider": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List Files

List the files available to the current user.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete All Files

Delete all files for the current user.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "files_deleted": 0,
  • "files_kept": 0
}

Upload User File

Upload a file for the current user and track it in the database.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
append
boolean (Append)
Default: false
Request Body schema: multipart/form-data
required
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "user_id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "name": "string",
  • "path": "string",
  • "size": 0,
  • "provider": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List Files

List the files available to the current user.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete All Files

Delete all files for the current user.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "files_deleted": 0,
  • "files_kept": 0
}

Download Files Batch

Download multiple files as a zip file by their IDs.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
Array
string <uuid>

Responses

Request samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type
application/json
null

Delete Files Batch

Delete multiple files by their IDs.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
Array
string <uuid>

Responses

Request samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "files_deleted": 0,
  • "files_kept": 0
}

Download File

Download a file by its ID or return its content as a string/bytes.

Args: file_id: UUID of the file. current_user: Authenticated user. session: Database session. storage_service: File storage service. return_content: If True, return raw content (str) instead of StreamingResponse.

Returns: StreamingResponse for client downloads or str for internal use.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
file_id
required
string <uuid> (File Id)
query Parameters
return_content
boolean (Return Content)
Default: false

Responses

Response samples

Content type
application/json
null

Edit File Name

Edit the name of a file by its ID.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
file_id
required
string <uuid> (File Id)
query Parameters
name
required
string (Name)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "user_id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "name": "string",
  • "path": "string",
  • "size": 0,
  • "provider": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete File

Delete a file by its ID.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
file_id
required
string <uuid> (File Id)

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}

Flows

Read Public Flow

Read a chat-accessible flow.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "is_component": false,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "webhook": false,
  • "endpoint_name": "string",
  • "tags": [
    ],
  • "locked": false,
  • "is_online": false,
  • "is_version": false,
  • "is_hold": false,
  • "is_endpoint": false,
  • "is_deleted": false,
  • "flow_type": "",
  • "online_version": "string",
  • "mcp_enabled": false,
  • "action_name": "string",
  • "action_description": "string",
  • "access_type": "PRIVATE",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "org_id": 0,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "create_at": "2019-08-24T14:15:22Z",
  • "m_uid": 0,
  • "creator_name": "string"
}

Create Flow

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)
Flow Skill (string) or Flow Skill (null) (Flow Skill)
Icon (string) or Icon (null) (Icon)
Icon Bg Color (string) or Icon Bg Color (null) (Icon Bg Color)
Gradient (string) or Gradient (null) (Gradient)
Data (object) or Data (null) (Data)
Is Component (boolean) or Is Component (null) (Is Component)
Default: false
Updated At (string) or Updated At (null) (Updated At)
Webhook (boolean) or Webhook (null) (Webhook)
Default: false

Can be used on the webhook endpoint

Endpoint Name (string) or Endpoint Name (null) (Endpoint Name)
Array of Tags (strings) or Tags (null) (Tags)
Locked (boolean) or Locked (null) (Locked)
Default: false
is_online
boolean (Is Online)
Default: false
is_version
boolean (Is Version)
Default: false
is_hold
boolean (Is Hold)
Default: false
is_endpoint
boolean (Is Endpoint)
Default: false
is_deleted
boolean (Is Deleted)
Default: false
flow_type
string (Flow Type)
Default: ""
Online Version (string) or Online Version (null) (Online Version)
Mcp Enabled (boolean) or Mcp Enabled (null) (Mcp Enabled)
Default: false

Can be exposed in the MCP server

Action Name (string) or Action Name (null) (Action Name)

The name of the action associated with the flow

Action Description (string) or Action Description (null) (Action Description)

The description of the action associated with the flow

access_type
string (AccessTypeEnum)
Default: "PRIVATE"
Enum: "PRIVATE" "PUBLIC" "RESTRICTED"
User Id (integer) or User Id (null) (User Id)
Tenant Id (string) or Tenant Id (null) (Tenant Id)
Business Id (integer) or Business Id (null) (Business Id)
Default: 0
is_self
boolean (Is Self)
Default: false
org_id
integer (Org Id)
Default: 0
Project Id (string) or Project Id (null) (Project Id)
Fs Path (string) or Fs Path (null) (Fs Path)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "is_component": false,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "webhook": false,
  • "endpoint_name": "string",
  • "tags": [
    ],
  • "locked": false,
  • "is_online": false,
  • "is_version": false,
  • "is_hold": false,
  • "is_endpoint": false,
  • "is_deleted": false,
  • "flow_type": "",
  • "online_version": "string",
  • "mcp_enabled": false,
  • "action_name": "string",
  • "action_description": "string",
  • "access_type": "PRIVATE",
  • "user_id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "org_id": 0,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "fs_path": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "is_component": false,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "webhook": false,
  • "endpoint_name": "string",
  • "tags": [
    ],
  • "locked": false,
  • "is_online": false,
  • "is_version": false,
  • "is_hold": false,
  • "is_endpoint": false,
  • "is_deleted": false,
  • "flow_type": "",
  • "online_version": "string",
  • "mcp_enabled": false,
  • "action_name": "string",
  • "action_description": "string",
  • "access_type": "PRIVATE",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "org_id": 0,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "create_at": "2019-08-24T14:15:22Z",
  • "m_uid": 0,
  • "creator_name": "string"
}

Read Flows

Retrieve a list of flows with pagination support.

Args: current_user (User): The current authenticated user. session (Session): The database session. settings_service (SettingsService): The settings service. components_only (bool, optional): Whether to return only components. Defaults to False.

get_all (bool, optional): Whether to return all flows without pagination. Defaults to True.
**This field must be True because of backward compatibility with the frontend - Release: 1.0.20**

project_id (UUID, optional): The project ID. Defaults to None.
params (Params): Pagination parameters.
remove_example_flows (bool, optional): Whether to remove example flows. Defaults to False.
header_flows (bool, optional): Whether to return only specific headers of the flows. Defaults to False.

Returns: list[FlowRead] | Page[FlowRead] | list[FlowHeader] A list of flows or a paginated response containing the list of flows or a list of flow headers.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
remove_example_flows
boolean (Remove Example Flows)
Default: false
components_only
boolean (Components Only)
Default: false
get_all
boolean (Get All)
Default: true
Project Id (string) or Project Id (null) (Project Id)
header_flows
boolean (Header Flows)
Default: false
all_projects
boolean (All Projects)
Default: false
exclude_deleted
boolean (Exclude Deleted)
Default: false
include_scope_sub_businesses
boolean (Include Scope Sub Businesses)
Default: false
Keyword (string) or Keyword (null) (Keyword)
Flow Type (string) or Flow Type (null) (Flow Type)
Workflow Status (string) or Workflow Status (null) (Workflow Status)
Sort By (string) or Sort By (null) (Sort By)
Sort Order (string) or Sort Order (null) (Sort Order)
Default: "desc"
Org Id (integer) or Org Id (null) (Org Id)
include_descendant_orgs
boolean (Include Descendant Orgs)
Default: false
Filter-Business-Id (integer) or Filter-Business-Id (null) (Filter-Business-Id)
include-sub-businesses
boolean (Include-Sub-Businesses)
Default: false
page
integer (Page) >= 1
Default: 1
size
integer (Size) [ 1 .. 100 ]
Default: 50

Responses

Response samples

Content type
application/json
Example
[ ]

Delete Multiple Flows

Delete multiple flows by their IDs.

Args: flow_ids (List[str]): The list of flow IDs to delete. user (User, optional): The user making the request. Defaults to the current active user. db (Session, optional): The database session.

Returns: dict: A dictionary containing the number of flows deleted.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
Array
string <uuid>

Responses

Request samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type
application/json
null

Read Flow

Read a flow.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "is_component": false,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "webhook": false,
  • "endpoint_name": "string",
  • "tags": [
    ],
  • "locked": false,
  • "is_online": false,
  • "is_version": false,
  • "is_hold": false,
  • "is_endpoint": false,
  • "is_deleted": false,
  • "flow_type": "",
  • "online_version": "string",
  • "mcp_enabled": false,
  • "action_name": "string",
  • "action_description": "string",
  • "access_type": "PRIVATE",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "org_id": 0,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "create_at": "2019-08-24T14:15:22Z",
  • "m_uid": 0,
  • "creator_name": "string"
}

Update Flow

Update a flow.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Description (string) or Description (null) (Description)
Flow Skill (string) or Flow Skill (null) (Flow Skill)
Data (object) or Data (null) (Data)
Last Known Updated At (string) or Last Known Updated At (null) (Last Known Updated At)
Tenant Id (string) or Tenant Id (null) (Tenant Id)
Business Id (integer) or Business Id (null) (Business Id)
Is Self (boolean) or Is Self (null) (Is Self)
Org Id (integer) or Org Id (null) (Org Id)
Project Id (string) or Project Id (null) (Project Id)
Endpoint Name (string) or Endpoint Name (null) (Endpoint Name)
Mcp Enabled (boolean) or Mcp Enabled (null) (Mcp Enabled)
Locked (boolean) or Locked (null) (Locked)
Is Online (boolean) or Is Online (null) (Is Online)
Is Version (boolean) or Is Version (null) (Is Version)
Is Hold (boolean) or Is Hold (null) (Is Hold)
Is Endpoint (boolean) or Is Endpoint (null) (Is Endpoint)
Is Deleted (boolean) or Is Deleted (null) (Is Deleted)
Flow Type (string) or Flow Type (null) (Flow Type)
Online Version (string) or Online Version (null) (Online Version)
Action Name (string) or Action Name (null) (Action Name)
Action Description (string) or Action Description (null) (Action Description)
AccessTypeEnum (string) or null
Fs Path (string) or Fs Path (null) (Fs Path)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "data": { },
  • "last_known_updated_at": "2019-08-24T14:15:22Z",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": true,
  • "org_id": 0,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "endpoint_name": "string",
  • "mcp_enabled": true,
  • "locked": true,
  • "is_online": true,
  • "is_version": true,
  • "is_hold": true,
  • "is_endpoint": true,
  • "is_deleted": true,
  • "flow_type": "string",
  • "online_version": "string",
  • "action_name": "string",
  • "action_description": "string",
  • "access_type": "PRIVATE",
  • "fs_path": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "is_component": false,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "webhook": false,
  • "endpoint_name": "string",
  • "tags": [
    ],
  • "locked": false,
  • "is_online": false,
  • "is_version": false,
  • "is_hold": false,
  • "is_endpoint": false,
  • "is_deleted": false,
  • "flow_type": "",
  • "online_version": "string",
  • "mcp_enabled": false,
  • "action_name": "string",
  • "action_description": "string",
  • "access_type": "PRIVATE",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "org_id": 0,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "create_at": "2019-08-24T14:15:22Z",
  • "m_uid": 0,
  • "creator_name": "string"
}

Delete Flow

Delete a flow.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
null

Read Online Flow

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "is_component": false,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "webhook": false,
  • "endpoint_name": "string",
  • "tags": [
    ],
  • "locked": false,
  • "is_online": false,
  • "is_version": false,
  • "is_hold": false,
  • "is_endpoint": false,
  • "is_deleted": false,
  • "flow_type": "",
  • "online_version": "string",
  • "mcp_enabled": false,
  • "action_name": "string",
  • "action_description": "string",
  • "access_type": "PRIVATE",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "org_id": 0,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "create_at": "2019-08-24T14:15:22Z",
  • "m_uid": 0,
  • "creator_name": "string"
}

Delete Online Flow

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "is_component": false,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "webhook": false,
  • "endpoint_name": "string",
  • "tags": [
    ],
  • "locked": false,
  • "is_online": false,
  • "is_version": false,
  • "is_hold": false,
  • "is_endpoint": false,
  • "is_deleted": false,
  • "flow_type": "",
  • "online_version": "string",
  • "mcp_enabled": false,
  • "action_name": "string",
  • "action_description": "string",
  • "access_type": "PRIVATE",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "org_id": 0,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "create_at": "2019-08-24T14:15:22Z",
  • "m_uid": 0,
  • "creator_name": "string"
}

Read Release Flow

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)
query Parameters
v
required
string (V)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "is_component": false,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "webhook": false,
  • "endpoint_name": "string",
  • "tags": [
    ],
  • "locked": false,
  • "is_online": false,
  • "is_version": false,
  • "is_hold": false,
  • "is_endpoint": false,
  • "is_deleted": false,
  • "flow_type": "",
  • "online_version": "string",
  • "mcp_enabled": false,
  • "action_name": "string",
  • "action_description": "string",
  • "access_type": "PRIVATE",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "org_id": 0,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "create_at": "2019-08-24T14:15:22Z",
  • "m_uid": 0,
  • "creator_name": "string"
}

Read Flow Versions

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Flow Version

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)
Request Body schema: application/json
required
version
required
string (Version)
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "version": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "name": "string",
  • "description": "string",
  • "version_note": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "is_component": false,
  • "webhook": false,
  • "endpoint_name": "string",
  • "mcp_enabled": false,
  • "action_name": "string",
  • "action_description": "string",
  • "access_type": "PRIVATE",
  • "tags": [
    ],
  • "is_hold": false,
  • "flow_version": "string",
  • "flow_type": "",
  • "flow_skill": "string",
  • "id": 0,
  • "user_id": 0,
  • "creator_name": "string",
  • "create_at": "2019-08-24T14:15:22Z"
}

Rollback Flow Version

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)
version_id
required
integer (Version Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "is_component": false,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "webhook": false,
  • "endpoint_name": "string",
  • "tags": [
    ],
  • "locked": false,
  • "is_online": false,
  • "is_version": false,
  • "is_hold": false,
  • "is_endpoint": false,
  • "is_deleted": false,
  • "flow_type": "",
  • "online_version": "string",
  • "mcp_enabled": false,
  • "action_name": "string",
  • "action_description": "string",
  • "access_type": "PRIVATE",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "org_id": 0,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "create_at": "2019-08-24T14:15:22Z",
  • "m_uid": 0,
  • "creator_name": "string"
}

Publish Flow Version

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)
version_id
required
integer (Version Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "is_component": false,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "webhook": false,
  • "endpoint_name": "string",
  • "tags": [
    ],
  • "locked": false,
  • "is_online": false,
  • "is_version": false,
  • "is_hold": false,
  • "is_endpoint": false,
  • "is_deleted": false,
  • "flow_type": "",
  • "online_version": "string",
  • "mcp_enabled": false,
  • "action_name": "string",
  • "action_description": "string",
  • "access_type": "PRIVATE",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "org_id": 0,
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "create_at": "2019-08-24T14:15:22Z",
  • "m_uid": 0,
  • "creator_name": "string"
}

Create Flow Template

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)
Request Body schema: application/json
required
name
required
string (Name)
Note (string) or Note (null) (Note)
scope
string (FlowTemplateScope)
Default: "tenant"
Enum: "system" "tenant" "business" "personal"
Business Id (integer) or Business Id (null) (Business Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "note": "string",
  • "scope": "system",
  • "business_id": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "tags": [
    ],
  • "flow_type": "",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "user_id": 0,
  • "creator_name": "string",
  • "create_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Read Flow Template

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
template_id
required
string <uuid> (Template Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "tags": [
    ],
  • "flow_type": "",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "user_id": 0,
  • "creator_name": "string",
  • "create_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Flow Template

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
template_id
required
string <uuid> (Template Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Description (string) or Description (null) (Description)
Flow Skill (string) or Flow Skill (null) (Flow Skill)
Flow Type (string) or Flow Type (null) (Flow Type)
Icon (string) or Icon (null) (Icon)
Icon Bg Color (string) or Icon Bg Color (null) (Icon Bg Color)
Gradient (string) or Gradient (null) (Gradient)
Data (object) or Data (null) (Data)
Array of Tags (strings) or Tags (null) (Tags)
Business Id (integer) or Business Id (null) (Business Id)
Is Self (boolean) or Is Self (null) (Is Self)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "flow_type": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "tags": [
    ],
  • "business_id": 0,
  • "is_self": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "flow_skill": "string",
  • "icon": "string",
  • "icon_bg_color": "string",
  • "gradient": "string",
  • "data": { },
  • "tags": [
    ],
  • "flow_type": "",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "is_self": false,
  • "user_id": 0,
  • "creator_name": "string",
  • "create_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Flow Template

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
template_id
required
string <uuid> (Template Id)

Responses

Response samples

Content type
application/json
null

Create Flows

Create multiple new flows.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
required
Array of objects (Flows)
Array
name
required
string (Name)
Description (string) or Description (null) (Description)
Flow Skill (string) or Flow Skill (null) (Flow Skill)
Icon (string) or Icon (null) (Icon)
Icon Bg Color (string) or Icon Bg Color (null) (Icon Bg Color)
Gradient (string) or Gradient (null) (Gradient)
Data (object) or Data (null) (Data)
Is Component (boolean) or Is Component (null) (Is Component)
Default: false
Updated At (string) or Updated At (null) (Updated At)
Webhook (boolean) or Webhook (null) (Webhook)
Default: false

Can be used on the webhook endpoint

Endpoint Name (string) or Endpoint Name (null) (Endpoint Name)
Array of Tags (strings) or Tags (null) (Tags)
Locked (boolean) or Locked (null) (Locked)
Default: false
is_online
boolean (Is Online)
Default: false
is_version
boolean (Is Version)
Default: false
is_hold
boolean (Is Hold)
Default: false
is_endpoint
boolean (Is Endpoint)
Default: false
is_deleted
boolean (Is Deleted)
Default: false
flow_type
string (Flow Type)
Default: ""
Online Version (string) or Online Version (null) (Online Version)
Mcp Enabled (boolean) or Mcp Enabled (null) (Mcp Enabled)
Default: false

Can be exposed in the MCP server

Action Name (string) or Action Name (null) (Action Name)

The name of the action associated with the flow

Action Description (string) or Action Description (null) (Action Description)

The description of the action associated with the flow

access_type
string (AccessTypeEnum)
Default: "PRIVATE"
Enum: "PRIVATE" "PUBLIC" "RESTRICTED"
User Id (integer) or User Id (null) (User Id)
Tenant Id (string) or Tenant Id (null) (Tenant Id)
Business Id (integer) or Business Id (null) (Business Id)
Default: 0
is_self
boolean (Is Self)
Default: false
org_id
integer (Org Id)
Default: 0
Project Id (string) or Project Id (null) (Project Id)
Fs Path (string) or Fs Path (null) (Fs Path)

Responses

Request samples

Content type
application/json
{
  • "flows": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Upload File

Upload flows from a file.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: multipart/form-data
required
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download Multiple File

Download all flows as a zip file.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
Array
string <uuid>

Responses

Request samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type
application/json
null

Read Basic Examples

Retrieve a list of visible flow templates.

Args: session (Session): The database session.

Returns: list[FlowTemplateRead]: A list of visible flow templates.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Starter Projects

Get a list of starter projects.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Base

Get All

Retrieve all component types with compression for better performance.

Returns a compressed response containing all available component types.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
null

Simplified Run Dev Flow

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id_or_name
required
string (Flow Id Or Name)
query Parameters
stream
boolean (Stream)
Default: false
User Id (string) or User Id (integer) or User Id (null) (User Id)
Request Body schema: application/json
SimplifiedAPIRequest (object) or null
Context (object) or Context (null) (Context)

Responses

Request samples

Content type
application/json
{
  • "input_request": {
    },
  • "context": { }
}

Response samples

Content type
application/json
null

Simplified Run Online Flow

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id_or_name
required
string (Flow Id Or Name)
query Parameters
stream
boolean (Stream)
Default: false
Request Body schema: application/json
SimplifiedAPIRequest (object) or null
Context (object) or Context (null) (Context)

Responses

Request samples

Content type
application/json
{
  • "input_request": {
    },
  • "context": { }
}

Response samples

Content type
application/json
null

Simplified Run Release Flow

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id_or_name
required
string (Flow Id Or Name)
query Parameters
v
required
string (V)
stream
boolean (Stream)
Default: false
Request Body schema: application/json
SimplifiedAPIRequest (object) or null
Context (object) or Context (null) (Context)

Responses

Request samples

Content type
application/json
{
  • "input_request": {
    },
  • "context": { }
}

Response samples

Content type
application/json
null

Simplified Run Flow

Executes a specified flow by ID with support for streaming and telemetry (API key auth).

This endpoint executes a flow identified by ID or name, with options for streaming the response and tracking execution metrics. It handles both streaming and non-streaming execution modes. This endpoint uses API key authentication (Bearer token).

Args: background_tasks (BackgroundTasks): FastAPI background task manager flow (FlowRead | None): The flow to execute, loaded via dependency input_request (SimplifiedAPIRequest | None): Input parameters for the flow stream (bool): Whether to stream the response api_key_user (UserRead): Authenticated user from API key context (dict | None): Optional context to pass to the flow http_request (Request): The incoming HTTP request for extracting global variables

Returns: Union[StreamingResponse, RunResponse]: Either a streaming response for real-time results or a RunResponse with the complete execution results

Raises: HTTPException: For flow not found (404) or invalid input (400) APIException: For internal execution errors (500)

Notes: - Supports both streaming and non-streaming execution modes - Tracks execution time and success/failure via telemetry - Handles graceful client disconnection in streaming mode - Provides detailed error handling with appropriate HTTP status codes - Extracts global variables from HTTP headers with prefix X-SKILLFLAW-GLOBAL-VAR-* - Merges extracted variables with the context parameter as "request_variables" - In streaming mode, uses EventManager to handle events: - "add_message": New messages during execution - "token": Individual tokens during streaming - "end": Final execution result - Authentication: Requires API key (Bearer token)

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id_or_name
required
string (Flow Id Or Name)
query Parameters
stream
boolean (Stream)
Default: false
User Id (string) or User Id (integer) or User Id (null) (User Id)
Request Body schema: application/json
SimplifiedAPIRequest (object) or null
Context (object) or Context (null) (Context)

Responses

Request samples

Content type
application/json
{
  • "input_request": {
    },
  • "context": { }
}

Response samples

Content type
application/json
null

Webhook Run Flow

Run a flow using a webhook request.

Args: flow_id_or_name: The flow ID or endpoint name (used by dependency). flow: The flow to be executed. request: The incoming HTTP request.

Returns: A dictionary containing the status of the task.

Raises: HTTPException: If the flow is not found or if there is an error processing the request.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id_or_name
required
string (Flow Id Or Name)
query Parameters
User Id (string) or User Id (integer) or User Id (null) (User Id)

Responses

Response samples

Content type
application/json
{ }

Experimental Run Flow

Executes a specified flow by ID with optional input values, output selection, tweaks, and streaming capability.

This endpoint supports running flows with caching to enhance performance and efficiency.

Parameters:

  • flow (Flow): The flow object to be executed, resolved via dependency injection.
  • inputs (List[InputValueRequest], optional): A list of inputs specifying the input values and components for the flow. Each input can target specific components and provide custom values.
  • outputs (List[str], optional): A list of output names to retrieve from the executed flow. If not provided, all outputs are returned.
  • tweaks (Optional[Tweaks], optional): A dictionary of tweaks to customize the flow execution. The tweaks can be used to modify the flow's parameters and components. Tweaks can be overridden by the input values.
  • stream (bool, optional): Specifies whether the results should be streamed. Defaults to False.
  • session_id (Union[None, str], optional): An optional session ID to utilize existing session data for the flow execution.
  • api_key_user (User): The user associated with the current API key. Automatically resolved from the API key.

Returns:

A RunResponse object containing the selected outputs (or all if not specified) of the executed flow and the session ID. The structure of the response accommodates multiple inputs, providing a nested list of outputs for each input.

Raises:

HTTPException: Indicates issues with finding the specified flow, invalid input formats, or internal errors during flow execution.

Example usage:

POST /run/flow_id
x-api-key: YOUR_API_KEY
Payload:
{
    "inputs": [
        {"components": ["component1"], "input_value": "value1"},
        {"components": ["component3"], "input_value": "value2"}
    ],
    "outputs": ["Component Name", "component_id"],
    "tweaks": {"parameter_name": "value", "Component Name": {"parameter_name": "value"}, "component_id": {"parameter_name": "value"}}
    "stream": false
}

This endpoint facilitates complex flow executions with customized inputs, outputs, and configurations, catering to diverse application requirements.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_id_or_name
required
string (Flow Id Or Name)
query Parameters
User Id (string) or User Id (integer) or User Id (null) (User Id)
Request Body schema: application/json
Array of Inputs (objects) or Inputs (null) (Inputs)
Array of Outputs (strings) or Outputs (null) (Outputs)
Tweaks (object) or null
stream
boolean (Stream)
Default: false
Session Id (string) or Session Id (null) (Session Id)

Responses

Request samples

Content type
application/json
{
  • "inputs": [
    ],
  • "outputs": [
    ],
  • "tweaks": {
    },
  • "stream": false,
  • "session_id": "string"
}

Response samples

Content type
application/json
{
  • "outputs": [ ],
  • "session_id": "string"
}

Get Version

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
null

Get Config

Retrieve the current application configuration settings.

Requires authentication to prevent exposure of sensitive configuration details.

Returns: ConfigResponse: The configuration settings of the application.

Raises: HTTPException: If an error occurs while retrieving the configuration.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
{
  • "feature_flags": {
    },
  • "serialization_max_items_length": 0,
  • "serialization_max_text_length": 0,
  • "frontend_timeout": 0,
  • "auto_saving": true,
  • "auto_saving_interval": 0,
  • "health_check_max_retries": 0,
  • "max_file_size_upload": 0,
  • "webhook_polling_interval": 0,
  • "public_flow_cleanup_interval": 0,
  • "public_flow_expiration": 0,
  • "event_delivery": "polling",
  • "webhook_auth_enable": true,
  • "voice_mode_available": true,
  • "default_project_name": "string",
  • "hide_getting_started_progress": true
}

Users

Add User

Add a new user to the database.

This endpoint allows public user registration (sign up). User activation is controlled by the NEW_USER_IS_ACTIVE setting.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
username
required
string (Username)
Nickname (string) or Nickname (null) (Nickname)
password
required
string (Password)
Optins (object) or Optins (null) (Optins)
Default: {"github_starred":false,"dialog_dismissed":false,"discord_clicked":false}

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "nickname": "string",
  • "password": "string",
  • "optins": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "nickname": "string",
  • "mobile": "",
  • "email": "",
  • "profile_image": "string",
  • "store_api_key": "string",
  • "reset_passwd": false,
  • "is_active": true,
  • "is_superuser": true,
  • "is_locked": false,
  • "is_sso": false,
  • "create_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "optins": { }
}

Read All Users

Retrieve a list of users from the database with pagination.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 10
Search (string) or Search (null) (Search)
Is Active (boolean) or Is Active (null) (Is Active)
Is Locked (boolean) or Is Locked (null) (Is Locked)
sort_by
string (Sort By)
Default: "id"
Enum: "id" "username" "nickname" "is_sso" "mobile" "email"
sort_order
string (Sort Order)
Default: "desc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "users": [
    ]
}

Read Current User

Retrieve the current user's data.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "nickname": "string",
  • "mobile": "",
  • "email": "",
  • "profile_image": "string",
  • "store_api_key": "string",
  • "reset_passwd": false,
  • "is_active": true,
  • "is_superuser": true,
  • "is_locked": false,
  • "is_sso": false,
  • "create_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "optins": { }
}

Patch User

Update an existing user's data.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
user_id
required
integer (User Id)
Request Body schema: application/json
required
Username (string) or Username (null) (Username)
Nickname (string) or Nickname (null) (Nickname)
Mobile (string) or Mobile (null) (Mobile)
Email (string) or Email (null) (Email)
Profile Image (string) or Profile Image (null) (Profile Image)
Password (string) or Password (null) (Password)
Reset Passwd (boolean) or Reset Passwd (null) (Reset Passwd)
Is Active (boolean) or Is Active (null) (Is Active)
Is Superuser (boolean) or Is Superuser (null) (Is Superuser)
Is Locked (boolean) or Is Locked (null) (Is Locked)
Is Sso (boolean) or Is Sso (null) (Is Sso)
Store Api Key (string) or Store Api Key (null) (Store Api Key)
Last Login At (string) or Last Login At (null) (Last Login At)
Optins (object) or Optins (null) (Optins)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "nickname": "string",
  • "mobile": "string",
  • "email": "string",
  • "profile_image": "string",
  • "password": "string",
  • "reset_passwd": true,
  • "is_active": true,
  • "is_superuser": true,
  • "is_locked": true,
  • "is_sso": true,
  • "store_api_key": "string",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "optins": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "nickname": "string",
  • "mobile": "",
  • "email": "",
  • "profile_image": "string",
  • "store_api_key": "string",
  • "reset_passwd": false,
  • "is_active": true,
  • "is_superuser": true,
  • "is_locked": false,
  • "is_sso": false,
  • "create_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "optins": { }
}

Delete User

Delete a user from the database.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
user_id
required
integer (User Id)

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Reset Password

Reset a user's password.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
user_id
required
integer (User Id)
Request Body schema: application/json
required
Username (string) or Username (null) (Username)
Nickname (string) or Nickname (null) (Nickname)
Mobile (string) or Mobile (null) (Mobile)
Email (string) or Email (null) (Email)
Profile Image (string) or Profile Image (null) (Profile Image)
Password (string) or Password (null) (Password)
Reset Passwd (boolean) or Reset Passwd (null) (Reset Passwd)
Is Active (boolean) or Is Active (null) (Is Active)
Is Superuser (boolean) or Is Superuser (null) (Is Superuser)
Is Locked (boolean) or Is Locked (null) (Is Locked)
Is Sso (boolean) or Is Sso (null) (Is Sso)
Store Api Key (string) or Store Api Key (null) (Store Api Key)
Last Login At (string) or Last Login At (null) (Last Login At)
Optins (object) or Optins (null) (Optins)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "nickname": "string",
  • "mobile": "string",
  • "email": "string",
  • "profile_image": "string",
  • "password": "string",
  • "reset_passwd": true,
  • "is_active": true,
  • "is_superuser": true,
  • "is_locked": true,
  • "is_sso": true,
  • "store_api_key": "string",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "optins": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "nickname": "string",
  • "mobile": "",
  • "email": "",
  • "profile_image": "string",
  • "store_api_key": "string",
  • "reset_passwd": false,
  • "is_active": true,
  • "is_superuser": true,
  • "is_locked": false,
  • "is_sso": false,
  • "create_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "optins": { }
}

Monitor

Get Vertex Builds

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
{
  • "vertex_builds": {
    }
}

Delete Vertex Builds

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Get Message Sessions

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Flow Id (string) or Flow Id (null) (Flow Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Message Session

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
flow_id
required
string <uuid> (Flow Id)
Session Id (string) or Session Id (null) (Session Id)
Session Name (string) or Session Name (null) (Session Name)

Responses

Request samples

Content type
application/json
{
  • "flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2",
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "session_name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2",
  • "user_id": "string",
  • "user_name": "string",
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "session_name": "string",
  • "is_active": true,
  • "create_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Messages

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Flow Id (string) or Flow Id (null) (Flow Id)
Session Id (string) or Session Id (string) or Session Id (null) (Session Id)
Sender (string) or Sender (null) (Sender)
Sender Name (string) or Sender Name (null) (Sender Name)
Order By (string) or Order By (null) (Order By)
Default: "id"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Messages

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
Array
integer

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Update Message

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
message_id
required
integer (Message Id)
Request Body schema: application/json
required
Text (string) or Text (null) (Text)
Sender (string) or Sender (null) (Sender)
Sender Name (string) or Sender Name (null) (Sender Name)
Session Id (string) or Session Id (null) (Session Id)
Context Id (string) or Context Id (null) (Context Id)
Ip Address (string) or Ip Address (null) (Ip Address)
Flow Version (string) or Flow Version (null) (Flow Version)
Array of Files (strings) or Files (null) (Files)
Edit (boolean) or Edit (null) (Edit)
Error (boolean) or Error (null) (Error)
Start Time (string) or Start Time (null) (Start Time)
End Time (string) or End Time (null) (End Time)
Properties (object) or null

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "sender": "string",
  • "sender_name": "string",
  • "session_id": "string",
  • "context_id": "string",
  • "ip_address": "string",
  • "flow_version": "string",
  • "files": [
    ],
  • "edit": true,
  • "error": true,
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z",
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "sender": "string",
  • "sender_name": "string",
  • "session_id": "string",
  • "context_id": "string",
  • "ip_address": "string",
  • "flow_version": "string",
  • "text": "string",
  • "files": [
    ],
  • "error": false,
  • "edit": false,
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z",
  • "properties": {
    },
  • "category": "message",
  • "content_blocks": [
    ],
  • "id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Update Session Id

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
old_session_id
required
string <uuid> (Old Session Id)
query Parameters
new_session_name
required
string (New Session Name)

The new session name to update to

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Messages Session

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
session_id
required
string <uuid> (Session Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Get Transactions

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
flow_id
required
string <uuid> (Flow Id)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 100 ]
Default: 50

Page size

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Tenants

Read Tenant User Candidates

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Search (string) or Search (null) (Search)
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 10

Responses

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "users": [
    ]
}

Read Tenant Group Candidates

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Tenant Id (string) or Tenant Id (null) (Tenant Id)
Search (string) or Search (null) (Search)
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 10

Responses

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "users": [
    ]
}

Read Tenant Org Candidates

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Tenant Id (string) or Tenant Id (null) (Tenant Id)
Search (string) or Search (null) (Search)
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 10

Responses

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "users": [
    ]
}

Read Tenant User Roles

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Tenant Id (string) or Tenant Id (null) (Tenant Id)
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "id"
Enum: "id" "tenant_name" "username" "nickname" "role_id" "role_name"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Tenant User Role

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
tenant_id
required
string <uuid> (Tenant Id)
role_id
required
string (Role Id) [ 1 .. 32 ] characters
Uid (integer) or Uid (null) (Uid)
Username (string) or Username (null) (Username)

Responses

Request samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "role_id": "string",
  • "uid": 0,
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "tenant_name": "string",
  • "uid": 0,
  • "username": "string",
  • "nickname": "string",
  • "role_id": "string",
  • "role_name": "string"
}

Batch Remove Tenant User Role

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
ids
required
Array of integers (Ids)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "deleted_count": 0
}

Remove Tenant User Role

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
relation_id
required
integer (Relation Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Read Tenant Group Roles

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Tenant Id (string) or Tenant Id (null) (Tenant Id)
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "id"
Enum: "id" "tenant_name" "group_name" "role_id" "role_name"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Tenant Group Role

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
tenant_id
required
string <uuid> (Tenant Id)
role_id
required
string (Role Id) [ 1 .. 32 ] characters
Group Id (integer) or Group Id (null) (Group Id)
Group Name (string) or Group Name (null) (Group Name)

Responses

Request samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "role_id": "string",
  • "group_id": 0,
  • "group_name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "tenant_name": "string",
  • "group_id": 0,
  • "group_name": "string",
  • "role_id": "string",
  • "role_name": "string"
}

Batch Remove Tenant Group Role

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
ids
required
Array of integers (Ids)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "deleted_count": 0
}

Remove Tenant Group Role

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
relation_id
required
integer (Relation Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Read Tenant Org Roles

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Tenant Id (string) or Tenant Id (null) (Tenant Id)
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "id"
Enum: "id" "tenant_name" "org_name" "role_id" "role_name"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Tenant Org Role

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
tenant_id
required
string <uuid> (Tenant Id)
role_id
required
string (Role Id) [ 1 .. 32 ] characters
Org Id (integer) or Org Id (null) (Org Id)
Org Name (string) or Org Name (null) (Org Name)

Responses

Request samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "role_id": "string",
  • "org_id": 0,
  • "org_name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "tenant_name": "string",
  • "org_id": 0,
  • "org_name": "string",
  • "role_id": "string",
  • "role_name": "string"
}

Batch Remove Tenant Org Role

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
ids
required
Array of integers (Ids)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "deleted_count": 0
}

Remove Tenant Org Role

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
relation_id
required
integer (Relation Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Read Tenants

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
sort_by
string (Sort By)
Default: "tenant_name"
Enum: "tenant_id" "tenant_name" "is_sys" "is_active"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"
is_all
boolean (Is All)
Default: false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Tenant

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
tenant_name
required
string (Tenant Name) <= 64 characters
is_sys
boolean (Is Sys)
Default: false
is_active
boolean (Is Active)
Default: true
Note (string) or Note (null) (Note)
Tenant Id (string) or Tenant Id (null) (Tenant Id)

Responses

Request samples

Content type
application/json
{
  • "tenant_name": "string",
  • "is_sys": false,
  • "is_active": true,
  • "note": "string",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0"
}

Response samples

Content type
application/json
{
  • "tenant_name": "string",
  • "is_sys": false,
  • "is_active": true,
  • "note": "string",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Read Tenant

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
tenant_id
required
string <uuid> (Tenant Id)

Responses

Response samples

Content type
application/json
{
  • "tenant_name": "string",
  • "is_sys": false,
  • "is_active": true,
  • "note": "string",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Patch Tenant

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
tenant_id
required
string <uuid> (Tenant Id)
Request Body schema: application/json
required
Tenant Name (string) or Tenant Name (null) (Tenant Name)
Is Sys (boolean) or Is Sys (null) (Is Sys)
Is Active (boolean) or Is Active (null) (Is Active)
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "tenant_name": "string",
  • "is_sys": true,
  • "is_active": true,
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "tenant_name": "string",
  • "is_sys": false,
  • "is_active": true,
  • "note": "string",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Remove Tenant

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
tenant_id
required
string <uuid> (Tenant Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Business

Read Businesses

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)
level
integer (Level) [ 0 .. 3 ]
Default: 0
Is-Enable (boolean) or Is-Enable (null) (Is-Enable)
First-Business-Id (integer) or First-Business-Id (null) (First-Business-Id)
Second-Business-Id (integer) or Second-Business-Id (null) (Second-Business-Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Business

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
tenant_id
required
string <uuid> (Tenant Id)
business_name
required
string (Business Name) <= 64 characters
business_level
required
integer (Business Level)
first_business_id
integer (First Business Id)
Default: 0
second_business_id
integer (Second Business Id)
Default: 0
third_business_id
integer (Third Business Id)
Default: 0
is_enable
boolean (Is Enable)
Default: true
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_name": "string",
  • "business_level": 0,
  • "first_business_id": 0,
  • "second_business_id": 0,
  • "third_business_id": 0,
  • "is_enable": true,
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_name": "string",
  • "business_level": 0,
  • "first_business_id": 0,
  • "second_business_id": 0,
  • "third_business_id": 0,
  • "is_enable": true,
  • "note": "string",
  • "business_id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Read Business Tree

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)
level
integer (Level) [ 0 .. 3 ]
Default: 0
Is-Enable (boolean) or Is-Enable (null) (Is-Enable)
First-Business-Id (integer) or First-Business-Id (null) (First-Business-Id)
Second-Business-Id (integer) or Second-Business-Id (null) (Second-Business-Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Read Business

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
business_id
required
integer (Business Id)

Responses

Response samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_name": "string",
  • "business_level": 0,
  • "first_business_id": 0,
  • "second_business_id": 0,
  • "third_business_id": 0,
  • "is_enable": true,
  • "note": "string",
  • "business_id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Patch Business

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
business_id
required
integer (Business Id)
Request Body schema: application/json
required
Tenant Id (string) or Tenant Id (null) (Tenant Id)
Business Name (string) or Business Name (null) (Business Name)
Business Level (integer) or Business Level (null) (Business Level)
First Business Id (integer) or First Business Id (null) (First Business Id)
Second Business Id (integer) or Second Business Id (null) (Second Business Id)
Third Business Id (integer) or Third Business Id (null) (Third Business Id)
Is Enable (boolean) or Is Enable (null) (Is Enable)
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_name": "string",
  • "business_level": 0,
  • "first_business_id": 0,
  • "second_business_id": 0,
  • "third_business_id": 0,
  • "is_enable": true,
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_name": "string",
  • "business_level": 0,
  • "first_business_id": 0,
  • "second_business_id": 0,
  • "third_business_id": 0,
  • "is_enable": true,
  • "note": "string",
  • "business_id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Remove Business

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
business_id
required
integer (Business Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Read Business User Candidates

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
business_id
required
integer (Business Id)
query Parameters
Search (string) or Search (null) (Search)
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 10

Responses

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "users": [
    ]
}

Read Business User Roles

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
business_id
required
integer (Business Id)
query Parameters
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "uid"
Enum: "uid" "username" "nickname" "role_id" "role_name"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upsert Business User Roles

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
business_id
required
integer (Business Id)
Request Body schema: application/json
required
Uid (integer) or Uid (null) (Uid)
Username (string) or Username (null) (Username)
role_ids
Array of strings (Role Ids) non-empty

Responses

Request samples

Content type
application/json
{
  • "uid": 0,
  • "username": "string",
  • "role_ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Batch Remove Business User Role

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
business_id
required
integer (Business Id)
Request Body schema: application/json
required
ids
required
Array of integers (Ids)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "deleted_count": 0
}

Remove Business User Role

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
business_id
required
integer (Business Id)
relation_id
required
integer (Relation Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Remove Business User

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
business_id
required
integer (Business Id)
uid
required
integer (Uid)

Responses

Response samples

Content type
application/json
{
  • "deleted_count": 0
}

Read Business Resources

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
business_id
required
integer (Business Id)
query Parameters
resource-type
string (Resource-Type)
Default: "flow"
Enum: "flow" "project" "variable" "component" "skill" "mcp" "plugin" "knowledge_base"
Search (string) or Search (null) (Search)
sort-by
string (Sort-By)
Default: "id"
Enum: "id" "name"
sort-order
string (Sort-Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Configs

Read Configs

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "config_key"
Enum: "id" "config_key" "config_name" "config_value"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Config

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
config_key
required
string (Config Key) <= 128 characters
config_name
required
string (Config Name) <= 64 characters
config_value
required
string (Config Value)
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "config_key": "string",
  • "config_name": "string",
  • "config_value": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "config_key": "string",
  • "config_name": "string",
  • "config_value": "string",
  • "note": "string",
  • "id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Patch Config

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
config_id
required
integer (Config Id)
Request Body schema: application/json
required
Config Name (string) or Config Name (null) (Config Name)
Config Value (string) or Config Value (null) (Config Value)
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "config_name": "string",
  • "config_value": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "config_key": "string",
  • "config_name": "string",
  • "config_value": "string",
  • "note": "string",
  • "id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Remove Config

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
config_id
required
integer (Config Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Dictionary

Read Indexes

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "config_key"
Enum: "config_key" "config_name" "config_en_name"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Index

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
config_key
required
string (Config Key) [ 1 .. 128 ] characters
config_name
required
string (Config Name) [ 1 .. 64 ] characters
config_en_name
required
string (Config En Name) [ 1 .. 64 ] characters
Note (string) or Note (null) (Note)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "config_key": "string",
  • "config_name": "string",
  • "config_en_name": "string",
  • "note": ""
}

Response samples

Content type
application/json
{
  • "config_key": "string",
  • "config_name": "string",
  • "config_en_name": "string",
  • "key_order": 0,
  • "parent_id": 0,
  • "config_value": "",
  • "note": "",
  • "config_id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Patch Index

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
index_id
required
integer (Index Id)
Request Body schema: application/json
required
Config Name (string) or Config Name (null) (Config Name)
Config En Name (string) or Config En Name (null) (Config En Name)
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "config_name": "string",
  • "config_en_name": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "config_key": "string",
  • "config_name": "string",
  • "config_en_name": "string",
  • "key_order": 0,
  • "parent_id": 0,
  • "config_value": "",
  • "note": "",
  • "config_id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Remove Index

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
index_id
required
integer (Index Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Read Items By Index

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
index_id
required
integer (Index Id)
query Parameters
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "config_key"
Enum: "key_order" "config_key" "config_name" "config_en_name" "config_value"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Item

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
index_id
required
integer (Index Id)
Request Body schema: application/json
required
config_key
required
string (Config Key) [ 1 .. 128 ] characters
config_name
required
string (Config Name) [ 1 .. 64 ] characters
config_en_name
required
string (Config En Name) [ 1 .. 64 ] characters
key_order
integer (Key Order)
Default: 0
config_value
required
string (Config Value) non-empty
Note (string) or Note (null) (Note)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "config_key": "string",
  • "config_name": "string",
  • "config_en_name": "string",
  • "key_order": 0,
  • "config_value": "string",
  • "note": ""
}

Response samples

Content type
application/json
{
  • "config_key": "string",
  • "config_name": "string",
  • "config_en_name": "string",
  • "key_order": 0,
  • "parent_id": 0,
  • "config_value": "",
  • "note": "",
  • "config_id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Patch Item

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
item_id
required
integer (Item Id)
Request Body schema: application/json
required
Config Name (string) or Config Name (null) (Config Name)
Config En Name (string) or Config En Name (null) (Config En Name)
Key Order (integer) or Key Order (null) (Key Order)
Config Value (string) or Config Value (null) (Config Value)
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "config_name": "string",
  • "config_en_name": "string",
  • "key_order": 0,
  • "config_value": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "config_key": "string",
  • "config_name": "string",
  • "config_en_name": "string",
  • "key_order": 0,
  • "parent_id": 0,
  • "config_value": "",
  • "note": "",
  • "config_id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Remove Item

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
item_id
required
integer (Item Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Projects

Create Project

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
name
string (Name)
Default: ""
Description (string) or Description (null) (Description)
Org Id (integer) or Org Id (null) (Org Id)
Is Enable (boolean) or Is Enable (null) (Is Enable)
Is Hold (boolean) or Is Hold (null) (Is Hold)
Release Version (string) or Release Version (null) (Release Version)
Priv Type (string) or Priv Type (null) (Priv Type)
Project Skill (string) or Project Skill (null) (Project Skill)
Auth Settings (object) or Auth Settings (null) (Auth Settings)
Icon (string) or Icon (null) (Icon)
Array of Components List (strings) or Components List (null) (Components List)
Array of Flows List (strings) or Flows List (null) (Flows List)

Responses

Request samples

Content type
application/json
{
  • "name": "",
  • "description": "string",
  • "org_id": 0,
  • "is_enable": true,
  • "is_hold": true,
  • "release_version": "string",
  • "priv_type": "string",
  • "project_skill": "string",
  • "auth_settings": { },
  • "icon": "string",
  • "components_list": [
    ],
  • "flows_list": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "",
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "org_id": 0,
  • "is_self": true,
  • "is_enable": true,
  • "is_release": true,
  • "is_version": true,
  • "is_hold": true,
  • "is_deleted": true,
  • "release_version": "string",
  • "priv_type": "string",
  • "project_skill": "string",
  • "auth_settings": { },
  • "icon": "string",
  • "user_id": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z",
  • "creator_name": "string"
}

Read Projects

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Sort By (string) or Sort By (null) (Sort By)
sort_order
string (Sort Order)
Default: "desc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Read Project

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
project_id
required
string <uuid> (Project Id)
query Parameters
Page (integer) or Page (null) (Page)
Size (integer) or Size (null) (Size)
is_component
boolean (Is Component)
Default: false
is_flow
boolean (Is Flow)
Default: false
search
string (Search)
Default: ""

Responses

Response samples

Content type
application/json
Example
{
  • "project": {
    },
  • "flows": {
    }
}

Update Project

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
project_id
required
string <uuid> (Project Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Description (string) or Description (null) (Description)
Org Id (integer) or Org Id (null) (Org Id)
Is Enable (boolean) or Is Enable (null) (Is Enable)
Is Hold (boolean) or Is Hold (null) (Is Hold)
Release Version (string) or Release Version (null) (Release Version)
Priv Type (string) or Priv Type (null) (Priv Type)
Project Skill (string) or Project Skill (null) (Project Skill)
Auth Settings (object) or Auth Settings (null) (Auth Settings)
Icon (string) or Icon (null) (Icon)
components
Array of strings <uuid> (Components) [ items <uuid > ]
flows
Array of strings <uuid> (Flows) [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "org_id": 0,
  • "is_enable": true,
  • "is_hold": true,
  • "release_version": "string",
  • "priv_type": "string",
  • "project_skill": "string",
  • "auth_settings": { },
  • "icon": "string",
  • "components": [
    ],
  • "flows": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "",
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "business_id": 0,
  • "org_id": 0,
  • "is_self": true,
  • "is_enable": true,
  • "is_release": true,
  • "is_version": true,
  • "is_hold": true,
  • "is_deleted": true,
  • "release_version": "string",
  • "priv_type": "string",
  • "project_skill": "string",
  • "auth_settings": { },
  • "icon": "string",
  • "user_id": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z",
  • "creator_name": "string"
}

Delete Project

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Download File

Download all flows from project as a zip file.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
null

Upload File

Upload flows from a file.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: multipart/form-data
required
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

mcp

Handle Sse

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Im Alive

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Handle Messages

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
null

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Streamable Health

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
null

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Handle Sse

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Im Alive

Responses

Handle Messages

Responses

Response samples

Content type
application/json
null

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Streamable Health

Responses

Response samples

Content type
application/json
null

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

OpenAI Responses API

Create Response

Create a response using OpenAI Responses API format.

This endpoint accepts a flow_id in the model parameter and processes the input through the specified SkillFlaw flow.

Args: request: OpenAI Responses API request with model (flow_id) and input background_tasks: FastAPI background task manager api_key_user: Authenticated user from API key http_request: The incoming HTTP request telemetry_service: Telemetry service for logging

Returns: OpenAI-compatible response or streaming response

Raises: HTTPException: For validation errors or flow execution issues

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
model
required
string (Model)

The flow ID to execute (used instead of OpenAI model)

input
required
string (Input)

The input text to process

stream
boolean (Stream)
Default: false

Whether to stream the response

background
boolean (Background)
Default: false

Whether to process in background

Array of Tools (any) or Tools (null) (Tools)

Tools are not supported yet

Previous Response Id (string) or Previous Response Id (null) (Previous Response Id)

ID of previous response to continue conversation

Array of Include (strings) or Include (null) (Include)

Additional response data to include, e.g., ['tool_call.results']

Responses

Request samples

Content type
application/json
{
  • "model": "string",
  • "input": "string",
  • "stream": false,
  • "background": false,
  • "tools": [
    ],
  • "previous_response_id": "string",
  • "include": [
    ]
}

Response samples

Content type
application/json
null

Permission

Read Permission Modules

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "module_id"
Enum: "module_id" "module_name"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Read Privs By Module

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
module_id
required
string (Module Id)
query Parameters
Is Sys Priv (boolean) or Is Sys Priv (null) (Is Sys Priv)
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "priv_id"
Enum: "priv_id" "priv_name" "priv_opr_type" "is_sys_priv"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Module Priv

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
module_id
required
string (Module Id)
Request Body schema: application/json
required
priv_id
required
string (Priv Id) [ 1 .. 128 ] characters
priv_name
required
string (Priv Name) [ 1 .. 128 ] characters
is_sys_priv
required
boolean (Is Sys Priv)
priv_opr_type
string (PrivOperationTypeEnum)
Default: "READ"
Enum: "READ" "WRITE" "MODIFY" "DELETE"

Responses

Request samples

Content type
application/json
{
  • "priv_id": "string",
  • "priv_name": "string",
  • "is_sys_priv": true,
  • "priv_opr_type": "READ"
}

Response samples

Content type
application/json
{
  • "module_id": "string",
  • "priv_id": "string",
  • "priv_name": "string",
  • "is_sys_priv": true,
  • "priv_opr_type": "READ",
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Read Module Priv Tree

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "module_id"
Enum: "module_id" "module_name" "priv_id" "priv_name" "priv_opr_type" "is_sys_priv"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Patch Module Priv

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
module_id
required
string (Module Id)
priv_id
required
string (Priv Id)
Request Body schema: application/json
required
Priv Name (string) or Priv Name (null) (Priv Name)
Is Sys Priv (boolean) or Is Sys Priv (null) (Is Sys Priv)
PrivOperationTypeEnum (string) or null

Responses

Request samples

Content type
application/json
{
  • "priv_name": "string",
  • "is_sys_priv": true,
  • "priv_opr_type": "READ"
}

Response samples

Content type
application/json
{
  • "module_id": "string",
  • "priv_id": "string",
  • "priv_name": "string",
  • "is_sys_priv": true,
  • "priv_opr_type": "READ",
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Remove Module Priv

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
module_id
required
string (Module Id)
priv_id
required
string (Priv Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Read Roles

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "role_name"
Enum: "role_id" "role_name" "is_sys_role"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Role

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
{
  • "role_id": "string",
  • "role_name": "string",
  • "is_sys_role": true
}

Patch Role

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
role_id
required
string (Role Id)

Responses

Response samples

Content type
application/json
{
  • "role_id": "string",
  • "role_name": "string",
  • "is_sys_role": true
}

Remove Role

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
role_id
required
string (Role Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Read Role Privs

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
role_id
required
string (Role Id)
query Parameters
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "module_id"
Enum: "module_id" "module_name" "priv_id" "priv_name" "priv_opr_type"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Role Priv Item

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
role_id
required
string (Role Id)
Request Body schema: application/json
required
module_id
required
string (Module Id) [ 1 .. 64 ] characters
priv_id
required
string (Priv Id) [ 1 .. 64 ] characters

Responses

Request samples

Content type
application/json
{
  • "module_id": "string",
  • "priv_id": "string"
}

Response samples

Content type
application/json
{
  • "role_id": "string",
  • "module_id": "string",
  • "module_name": "string",
  • "priv_id": "string",
  • "priv_name": "string",
  • "is_sys_priv": true,
  • "priv_opr_type": "READ",
  • "c_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z"
}

Read Role Priv Tree

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "role_name"
Enum: "role_id" "role_name" "module_id" "module_name" "priv_id" "priv_name" "priv_opr_type"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Remove Role Priv Item

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
role_id
required
string (Role Id)
module_id
required
string (Module Id)
priv_id
required
string (Priv Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Organization

Read Orgs

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Org

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
tenant_id
required
string <uuid> (Tenant Id)
org_name
required
string (Org Name) <= 64 characters
Org Code (string) or Org Code (null) (Org Code)
Parent Org Id (integer) or Parent Org Id (null) (Parent Org Id)
is_enable
boolean (Is Enable)
Default: true
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "org_name": "string",
  • "org_code": "string",
  • "parent_org_id": 0,
  • "is_enable": true,
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "org_id": 0,
  • "org_name": "string",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "org_code": "string",
  • "org_level": 0,
  • "one_org_id": 0,
  • "two_org_id": 0,
  • "three_org_id": 0,
  • "four_org_id": 0,
  • "five_org_id": 0,
  • "six_org_id": 0,
  • "parent_org_id": 0,
  • "is_enable": true,
  • "note": "string",
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Read Org Tree

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Patch Org

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
org_id
required
integer (Org Id)
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)
Request Body schema: application/json
required
Org Name (string) or Org Name (null) (Org Name)
Org Code (string) or Org Code (null) (Org Code)
Is Enable (boolean) or Is Enable (null) (Is Enable)
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "org_name": "string",
  • "org_code": "string",
  • "is_enable": true,
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "org_id": 0,
  • "org_name": "string",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "org_code": "string",
  • "org_level": 0,
  • "one_org_id": 0,
  • "two_org_id": 0,
  • "three_org_id": 0,
  • "four_org_id": 0,
  • "five_org_id": 0,
  • "six_org_id": 0,
  • "parent_org_id": 0,
  • "is_enable": true,
  • "note": "string",
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Remove Org

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
org_id
required
integer (Org Id)
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Read Org Members

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)
org-id
required
integer (Org-Id)
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "uid"
Enum: "uid" "username" "nickname" "position" "job" "is_leader"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Org Members

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
tenant_id
required
string <uuid> (Tenant Id)
org_id
required
integer (Org Id)
uids
Array of integers (Uids)
position
required
string (Position) [ 1 .. 64 ] characters
job
required
string (Job) [ 1 .. 64 ] characters
is_leader
boolean (Is Leader)
Default: false

Responses

Request samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "org_id": 0,
  • "uids": [
    ],
  • "position": "string",
  • "job": "string",
  • "is_leader": false
}

Response samples

Content type
application/json
[
  • {
    }
]

Read Org Member User Candidates

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
org-id
required
integer (Org-Id)
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)
Search (string) or Search (null) (Search)
skip
integer (Skip) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 500 ]
Default: 200

Responses

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "users": [
    ]
}

Read User Group Member User Candidates

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
group-id
required
integer (Group-Id)
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)
Search (string) or Search (null) (Search)
skip
integer (Skip) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 500 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "users": [
    ]
}

Patch Org Member

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
member_id
required
integer (Member Id)
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)
Request Body schema: application/json
required
Position (string) or Position (null) (Position)
Job (string) or Job (null) (Job)
Is Leader (boolean) or Is Leader (null) (Is Leader)

Responses

Request samples

Content type
application/json
{
  • "position": "string",
  • "job": "string",
  • "is_leader": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "org_id": 0,
  • "uid": 0,
  • "username": "string",
  • "nickname": "string",
  • "position": "string",
  • "job": "string",
  • "is_leader": true,
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Remove Org Member

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
member_id
required
integer (Member Id)
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Read User Groups

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)
Search (string) or Search (null) (Search)
Is-Enable (boolean) or Is-Enable (null) (Is-Enable)
sort_by
string (Sort By)
Default: "group_id"
Enum: "group_id" "group_name" "is_enable"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add User Group

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
tenant_id
required
string <uuid> (Tenant Id)
group_name
required
string (Group Name) [ 1 .. 64 ] characters
is_enable
boolean (Is Enable)
Default: true
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "group_name": "string",
  • "is_enable": true,
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "group_id": 0,
  • "group_name": "string",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "is_enable": true,
  • "note": "string",
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Patch User Group

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
group_id
required
integer (Group Id)
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)
Request Body schema: application/json
required
Group Name (string) or Group Name (null) (Group Name)
Is Enable (boolean) or Is Enable (null) (Is Enable)
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "group_name": "string",
  • "is_enable": true,
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "group_id": 0,
  • "group_name": "string",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "is_enable": true,
  • "note": "string",
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Remove User Group

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
group_id
required
integer (Group Id)
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Read User Group Members

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
group-id
required
integer (Group-Id)
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)
Search (string) or Search (null) (Search)
Is-Leader (boolean) or Is-Leader (null) (Is-Leader)
sort_by
string (Sort By)
Default: "id"
Enum: "id" "uid" "username" "nickname" "is_leader"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add User Group Member

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)
Request Body schema: application/json
required
group_id
required
integer (Group Id)
uid
required
integer (Uid)
is_leader
boolean (Is Leader)
Default: false

Responses

Request samples

Content type
application/json
{
  • "group_id": 0,
  • "uid": 0,
  • "is_leader": false
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "group_id": 0,
  • "uid": 0,
  • "username": "string",
  • "nickname": "string",
  • "is_leader": true,
  • "c_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z"
}

Patch User Group Member

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
member_id
required
integer (Member Id)
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)
Request Body schema: application/json
required
is_leader
required
boolean (Is Leader)

Responses

Request samples

Content type
application/json
{
  • "is_leader": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "group_id": 0,
  • "uid": 0,
  • "username": "string",
  • "nickname": "string",
  • "is_leader": true,
  • "c_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z"
}

Remove User Group Member

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
member_id
required
integer (Member Id)
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Read Org User Search

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "uid"
Enum: "uid" "username" "nickname" "org_id" "org_level" "position" "job" "is_leader"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Read User Group User Search

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Tenant-Id (string) or Tenant-Id (null) (Tenant-Id)
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "group_id"
Enum: "group_id" "group_name" "uid" "username" "nickname" "is_leader"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Model Management

Read Model Types

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Read Model Providers

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Search (string) or Search (null) (Search)
sort_by
string (Sort By)
Default: "key_order"
Enum: "provider_key" "provider_name" "key_order"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Model Provider

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
provider_key
required
string (Provider Key) [ 1 .. 64 ] characters
provider_name
required
string (Provider Name) [ 1 .. 64 ] characters
icon
string (Icon) <= 64 characters
Default: "Bot"
variable_name
required
string (Variable Name) [ 1 .. 128 ] characters
requires_api_key
boolean (Requires Api Key)
Default: true
Api Docs Url (string) or Api Docs Url (null) (Api Docs Url)
model_class
required
string (Model Class) [ 1 .. 128 ] characters
model_name_param
string (Model Name Param) <= 64 characters
Default: "model"
api_key_param
string (Api Key Param) <= 64 characters
Default: "api_key"
Base Url Param (string) or Base Url Param (null) (Base Url Param)
Base Url (string) or Base Url (null) (Base Url)
Url Param (string) or Url Param (null) (Url Param)
max_tokens_field_name
string (Max Tokens Field Name) <= 64 characters
Default: "max_tokens"
is_active
boolean (Is Active)
Default: true
key_order
integer (Key Order)
Default: 0
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "provider_key": "string",
  • "provider_name": "string",
  • "icon": "Bot",
  • "variable_name": "string",
  • "requires_api_key": true,
  • "api_docs_url": "string",
  • "model_class": "string",
  • "model_name_param": "model",
  • "api_key_param": "api_key",
  • "base_url_param": "string",
  • "base_url": "string",
  • "url_param": "string",
  • "max_tokens_field_name": "max_tokens",
  • "is_active": true,
  • "key_order": 0,
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "provider_key": "string",
  • "provider_name": "string",
  • "icon": "Bot",
  • "variable_name": "string",
  • "requires_api_key": true,
  • "api_docs_url": "string",
  • "model_class": "string",
  • "model_name_param": "model",
  • "api_key_param": "api_key",
  • "base_url_param": "string",
  • "base_url": "string",
  • "url_param": "string",
  • "max_tokens_field_name": "max_tokens",
  • "is_active": true,
  • "key_order": 0,
  • "note": "string",
  • "provider_id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Patch Model Provider

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
provider_id
required
integer (Provider Id)
Request Body schema: application/json
required
Provider Key (string) or Provider Key (null) (Provider Key)
Provider Name (string) or Provider Name (null) (Provider Name)
Icon (string) or Icon (null) (Icon)
Variable Name (string) or Variable Name (null) (Variable Name)
Requires Api Key (boolean) or Requires Api Key (null) (Requires Api Key)
Api Docs Url (string) or Api Docs Url (null) (Api Docs Url)
Model Class (string) or Model Class (null) (Model Class)
Model Name Param (string) or Model Name Param (null) (Model Name Param)
Api Key Param (string) or Api Key Param (null) (Api Key Param)
Base Url Param (string) or Base Url Param (null) (Base Url Param)
Base Url (string) or Base Url (null) (Base Url)
Url Param (string) or Url Param (null) (Url Param)
Max Tokens Field Name (string) or Max Tokens Field Name (null) (Max Tokens Field Name)
Is Active (boolean) or Is Active (null) (Is Active)
Key Order (integer) or Key Order (null) (Key Order)
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "provider_key": "string",
  • "provider_name": "string",
  • "icon": "string",
  • "variable_name": "string",
  • "requires_api_key": true,
  • "api_docs_url": "string",
  • "model_class": "string",
  • "model_name_param": "string",
  • "api_key_param": "string",
  • "base_url_param": "string",
  • "base_url": "string",
  • "url_param": "string",
  • "max_tokens_field_name": "string",
  • "is_active": true,
  • "key_order": 0,
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "provider_key": "string",
  • "provider_name": "string",
  • "icon": "Bot",
  • "variable_name": "string",
  • "requires_api_key": true,
  • "api_docs_url": "string",
  • "model_class": "string",
  • "model_name_param": "model",
  • "api_key_param": "api_key",
  • "base_url_param": "string",
  • "base_url": "string",
  • "url_param": "string",
  • "max_tokens_field_name": "max_tokens",
  • "is_active": true,
  • "key_order": 0,
  • "note": "string",
  • "provider_id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Remove Model Provider

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
provider_id
required
integer (Provider Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Remove Model Providers Bulk

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
ids
required
Array of integers (Ids)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "deleted_count": 0
}

Read Provider Models

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
provider_id
required
integer (Provider Id)
query Parameters
Search (string) or Search (null) (Search)
Model Type (string) or Model Type (null) (Model Type)
sort_by
string (Sort By)
Default: "key_order"
Enum: "model_type" "model_name" "model_display_name" "context_length" "key_order"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Provider Model

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
provider_id
required
integer (Provider Id)
model_name
required
string (Model Name) [ 1 .. 128 ] characters
Model Display Name (string) or Model Display Name (null) (Model Display Name)
model_type
required
string (Model Type) [ 1 .. 128 ] characters
Context Length (integer) or Context Length (null) (Context Length)
is_default
boolean (Is Default)
Default: false
is_deprecated
boolean (Is Deprecated)
Default: false
is_not_supported
boolean (Is Not Supported)
Default: false
is_preview
boolean (Is Preview)
Default: false
is_reasoning
boolean (Is Reasoning)
Default: false
is_tool_calling
boolean (Is Tool Calling)
Default: false
is_search
boolean (Is Search)
Default: false
is_vl
boolean (Is Vl)
Default: false
is_active
boolean (Is Active)
Default: true
key_order
integer (Key Order)
Default: 0
Metadata (object) or Metadata (null) (Metadata)
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "provider_id": 0,
  • "model_name": "string",
  • "model_display_name": "string",
  • "model_type": "string",
  • "context_length": 0,
  • "is_default": false,
  • "is_deprecated": false,
  • "is_not_supported": false,
  • "is_preview": false,
  • "is_reasoning": false,
  • "is_tool_calling": false,
  • "is_search": false,
  • "is_vl": false,
  • "is_active": true,
  • "key_order": 0,
  • "metadata": { },
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "provider_id": 0,
  • "model_name": "string",
  • "model_display_name": "string",
  • "model_type": "string",
  • "context_length": 0,
  • "is_default": true,
  • "is_deprecated": true,
  • "is_not_supported": true,
  • "is_preview": true,
  • "is_reasoning": true,
  • "is_tool_calling": true,
  • "is_search": true,
  • "is_vl": true,
  • "is_active": true,
  • "key_order": 0,
  • "metadata": { },
  • "note": "string",
  • "id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Patch Provider Model

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
model_id
required
integer (Model Id)
Request Body schema: application/json
required
Model Name (string) or Model Name (null) (Model Name)
Model Display Name (string) or Model Display Name (null) (Model Display Name)
Model Type (string) or Model Type (null) (Model Type)
Context Length (integer) or Context Length (null) (Context Length)
Is Default (boolean) or Is Default (null) (Is Default)
Is Deprecated (boolean) or Is Deprecated (null) (Is Deprecated)
Is Not Supported (boolean) or Is Not Supported (null) (Is Not Supported)
Is Preview (boolean) or Is Preview (null) (Is Preview)
Is Reasoning (boolean) or Is Reasoning (null) (Is Reasoning)
Is Tool Calling (boolean) or Is Tool Calling (null) (Is Tool Calling)
Is Search (boolean) or Is Search (null) (Is Search)
Is Vl (boolean) or Is Vl (null) (Is Vl)
Is Active (boolean) or Is Active (null) (Is Active)
Key Order (integer) or Key Order (null) (Key Order)
Metadata (object) or Metadata (null) (Metadata)
Note (string) or Note (null) (Note)

Responses

Request samples

Content type
application/json
{
  • "model_name": "string",
  • "model_display_name": "string",
  • "model_type": "string",
  • "context_length": 0,
  • "is_default": true,
  • "is_deprecated": true,
  • "is_not_supported": true,
  • "is_preview": true,
  • "is_reasoning": true,
  • "is_tool_calling": true,
  • "is_search": true,
  • "is_vl": true,
  • "is_active": true,
  • "key_order": 0,
  • "metadata": { },
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "provider_id": 0,
  • "model_name": "string",
  • "model_display_name": "string",
  • "model_type": "string",
  • "context_length": 0,
  • "is_default": true,
  • "is_deprecated": true,
  • "is_not_supported": true,
  • "is_preview": true,
  • "is_reasoning": true,
  • "is_tool_calling": true,
  • "is_search": true,
  • "is_vl": true,
  • "is_active": true,
  • "key_order": 0,
  • "metadata": { },
  • "note": "string",
  • "id": 0,
  • "c_uid": 0,
  • "m_uid": 0,
  • "ctime": "2019-08-24T14:15:22Z",
  • "utime": "2019-08-24T14:15:22Z"
}

Remove Provider Model

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
model_id
required
integer (Model Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Remove Provider Models Bulk

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
ids
required
Array of integers (Ids)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "deleted_count": 0
}

Agentic

Execute Named Flow

Execute a named flow from the flows directory.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
flow_name
required
string (Flow Name)
Request Body schema: application/json
required
flow_id
required
string (Flow Id)
Component Id (string) or Component Id (null) (Component Id)
Field Name (string) or Field Name (null) (Field Name)
Input Value (string) or Input Value (null) (Input Value)
Max Retries (integer) or Max Retries (null) (Max Retries)
Model Name (string) or Model Name (null) (Model Name)
Provider (string) or Provider (null) (Provider)
Session Id (string) or Session Id (null) (Session Id)

Responses

Request samples

Content type
application/json
{
  • "flow_id": "string",
  • "component_id": "string",
  • "field_name": "string",
  • "input_value": "string",
  • "max_retries": 0,
  • "model_name": "string",
  • "provider": "string",
  • "session_id": "string"
}

Response samples

Content type
application/json
{ }

Check Assistant Config

Check if the SkillFlaw Assistant is properly configured.

Returns available providers with their configured status and available models.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
{ }

Assist

Chat with the SkillFlaw Assistant.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
flow_id
required
string (Flow Id)
Component Id (string) or Component Id (null) (Component Id)
Field Name (string) or Field Name (null) (Field Name)
Input Value (string) or Input Value (null) (Input Value)
Max Retries (integer) or Max Retries (null) (Max Retries)
Model Name (string) or Model Name (null) (Model Name)
Provider (string) or Provider (null) (Provider)
Session Id (string) or Session Id (null) (Session Id)

Responses

Request samples

Content type
application/json
{
  • "flow_id": "string",
  • "component_id": "string",
  • "field_name": "string",
  • "input_value": "string",
  • "max_retries": 0,
  • "model_name": "string",
  • "provider": "string",
  • "session_id": "string"
}

Response samples

Content type
application/json
{ }

Assist Stream

Chat with the SkillFlaw Assistant with streaming progress updates.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
flow_id
required
string (Flow Id)
Component Id (string) or Component Id (null) (Component Id)
Field Name (string) or Field Name (null) (Field Name)
Input Value (string) or Input Value (null) (Input Value)
Max Retries (integer) or Max Retries (null) (Max Retries)
Model Name (string) or Model Name (null) (Model Name)
Provider (string) or Provider (null) (Provider)
Session Id (string) or Session Id (null) (Session Id)

Responses

Request samples

Content type
application/json
{
  • "flow_id": "string",
  • "component_id": "string",
  • "field_name": "string",
  • "input_value": "string",
  • "max_retries": 0,
  • "model_name": "string",
  • "provider": "string",
  • "session_id": "string"
}

Response samples

Content type
application/json
null

Component

Get Component Groups

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Component Type (string) or Component Type (null) (Component Type)
Scope (integer) or Scope (null) (Scope)
Business Id (integer) or Business Id (null) (Business Id)
all_scopes
boolean (All Scopes)
Default: false
include_sub_businesses
boolean (Include Sub Businesses)
Default: false
Is Active (boolean) or Is Active (null) (Is Active)
Keyword (string) or Keyword (null) (Keyword)

Responses

Response samples

Content type
application/json
null

Add Component Group

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
group_name
required
string (Group Name)
group_en_name
required
string (Group En Name)
component_type
required
string (Component Type)
Enum: "component" "bundle"
Icon (string) or Icon (null) (Icon)
Array of Tags (strings) or Tags (null) (Tags)
order_num
integer (Order Num)
Default: 0
is_active
boolean (Is Active)
Default: true
Note (string) or Note (null) (Note)
scope
integer (Scope)
Default: 1
Business Id (integer) or Business Id (null) (Business Id)

Responses

Request samples

Content type
application/json
{
  • "group_name": "string",
  • "group_en_name": "string",
  • "component_type": "component",
  • "icon": "string",
  • "tags": [
    ],
  • "order_num": 0,
  • "is_active": true,
  • "note": "string",
  • "scope": 1,
  • "business_id": 0
}

Response samples

Content type
application/json
null

Patch Component Group

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
group_id
required
integer (Group Id)
query Parameters
scope
required
integer (Scope)
Business Id (integer) or Business Id (null) (Business Id)
Request Body schema: application/json
required
Group Name (string) or Group Name (null) (Group Name)
Group En Name (string) or Group En Name (null) (Group En Name)
Icon (string) or Icon (null) (Icon)
Array of Tags (strings) or Tags (null) (Tags)
Order Num (integer) or Order Num (null) (Order Num)
Is Active (boolean) or Is Active (null) (Is Active)
Note (string) or Note (null) (Note)
Scope (integer) or Scope (null) (Scope)
Business Id (integer) or Business Id (null) (Business Id)

Responses

Request samples

Content type
application/json
{
  • "group_name": "string",
  • "group_en_name": "string",
  • "icon": "string",
  • "tags": [
    ],
  • "order_num": 0,
  • "is_active": true,
  • "note": "string",
  • "scope": 0,
  • "business_id": 0
}

Response samples

Content type
application/json
null

Remove Component Group

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
group_id
required
integer (Group Id)
query Parameters
scope
required
integer (Scope)
Business Id (integer) or Business Id (null) (Business Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Get Components

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Component Type (string) or Component Type (null) (Component Type)
Component Group Id (integer) or Component Group Id (null) (Component Group Id)
Scope (integer) or Scope (null) (Scope)
Business Id (integer) or Business Id (null) (Business Id)
all_scopes
boolean (All Scopes)
Default: false
include_sub_businesses
boolean (Include Sub Businesses)
Default: false
Is Active (boolean) or Is Active (null) (Is Active)
Is Deprecated (boolean) or Is Deprecated (null) (Is Deprecated)
Is Legacy (boolean) or Is Legacy (null) (Is Legacy)
Keyword (string) or Keyword (null) (Keyword)
Tag (string) or Tag (null) (Tag)
deprecated_only
boolean (Deprecated Only)
Default: false
legacy_only
boolean (Legacy Only)
Default: false
Sort By (string) or Sort By (null) (Sort By)
Default: "ctime"
sort_order
string (Sort Order)
Default: "desc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
null

Add Component

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
component_group_id
required
integer (Component Group Id)
Component Name (string) or Component Name (null) (Component Name)
Display Name (string) or Display Name (null) (Display Name)
Icon (string) or Icon (null) (Icon)
Tag (string) or Tag (null) (Tag)
Default: ""
Code (string) or Code (null) (Code)
Component Skill (string) or Component Skill (null) (Component Skill)
Note (string) or Note (null) (Note)
Version Note (string) or Version Note (null) (Version Note)
is_active
boolean (Is Active)
Default: true
is_legacy
boolean (Is Legacy)
Default: false
is_deprecated
boolean (Is Deprecated)
Default: false
scope
integer (Scope)
Default: 1
Business Id (integer) or Business Id (null) (Business Id)

Responses

Request samples

Content type
application/json
{
  • "component_group_id": 0,
  • "component_name": "string",
  • "display_name": "string",
  • "icon": "string",
  • "tag": "",
  • "code": "string",
  • "component_skill": "string",
  • "note": "string",
  • "version_note": "string",
  • "is_active": true,
  • "is_legacy": false,
  • "is_deprecated": false,
  • "scope": 1,
  • "business_id": 0
}

Response samples

Content type
application/json
null

Get Component

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
component_id
required
string <uuid> (Component Id)
query Parameters
scope
required
integer (Scope)
Business Id (integer) or Business Id (null) (Business Id)

Responses

Response samples

Content type
application/json
null

Patch Component

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
component_id
required
string <uuid> (Component Id)
query Parameters
scope
required
integer (Scope)
Business Id (integer) or Business Id (null) (Business Id)
Request Body schema: application/json
required
Component Group Id (integer) or Component Group Id (null) (Component Group Id)
Component Name (string) or Component Name (null) (Component Name)
Display Name (string) or Display Name (null) (Display Name)
Icon (string) or Icon (null) (Icon)
Tag (string) or Tag (null) (Tag)
Code (string) or Code (null) (Code)
Component Skill (string) or Component Skill (null) (Component Skill)
Note (string) or Note (null) (Note)
Version Note (string) or Version Note (null) (Version Note)
Is Active (boolean) or Is Active (null) (Is Active)
Is Legacy (boolean) or Is Legacy (null) (Is Legacy)
Is Deprecated (boolean) or Is Deprecated (null) (Is Deprecated)
Scope (integer) or Scope (null) (Scope)
Business Id (integer) or Business Id (null) (Business Id)

Responses

Request samples

Content type
application/json
{
  • "component_group_id": 0,
  • "component_name": "string",
  • "display_name": "string",
  • "icon": "string",
  • "tag": "string",
  • "code": "string",
  • "component_skill": "string",
  • "note": "string",
  • "version_note": "string",
  • "is_active": true,
  • "is_legacy": true,
  • "is_deprecated": true,
  • "scope": 0,
  • "business_id": 0
}

Response samples

Content type
application/json
null

Remove Component

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
component_id
required
string <uuid> (Component Id)
query Parameters
scope
required
integer (Scope)
Business Id (integer) or Business Id (null) (Business Id)

Responses

Response samples

Content type
application/json
null

Get Component Versions

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
component_id
required
string <uuid> (Component Id)
query Parameters
scope
required
integer (Scope)
Business Id (integer) or Business Id (null) (Business Id)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

MCP

Get Servers

Get the list of available servers.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Action Count (boolean) or Action Count (null) (Action Count)
Mcp Scope (integer) or Mcp Scope (null) (Mcp Scope)
Business Id (integer) or Business Id (null) (Business Id)
all_scopes
boolean (All Scopes)
Default: false
include_sub_businesses
boolean (Include Sub Businesses)
Default: false
Mcp Type (string) or Mcp Type (null) (Mcp Type)
Is Active (boolean) or Is Active (null) (Is Active)
Keyword (string) or Keyword (null) (Keyword)
Sort By (string) or Sort By (null) (Sort By)
sort_order
string (Sort Order)
Default: "desc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
null

Update Server Endpoint By Query

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
server_id
required
integer (Server Id)
Request Body schema: application/json
required
Mcp Scope (integer) or Mcp Scope (null) (Mcp Scope)
Business Id (integer) or Business Id (null) (Business Id)
New Name (string) or New Name (null) (New Name)
Mcp Type (string) or Mcp Type (null) (Mcp Type)
Command (string) or Command (null) (Command)
Array of Args (strings) or Args (null) (Args)
Env (object) or Env (null) (Env)
Headers (object) or Headers (null) (Headers)
Url (string) or Url (null) (Url)
Logo (string) or Logo (null) (Logo)
Note (string) or Note (null) (Note)
Is Active (boolean) or Is Active (null) (Is Active)
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "mcp_scope": 0,
  • "business_id": 0,
  • "new_name": "string",
  • "mcp_type": "string",
  • "command": "string",
  • "args": [
    ],
  • "env": {
    },
  • "headers": {
    },
  • "url": "string",
  • "logo": "string",
  • "note": "string",
  • "is_active": true
}

Response samples

Content type
application/json
null

Get Server Endpoint

Get a specific server.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
server_name
required
string (Server Name)
query Parameters
Server Id (integer) or Server Id (null) (Server Id)
Mcp Scope (integer) or Mcp Scope (null) (Mcp Scope)
Business Id (integer) or Business Id (null) (Business Id)

Responses

Response samples

Content type
application/json
null

Add Server

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
server_name
required
string (Server Name)
Request Body schema: application/json
required
Mcp Scope (integer) or Mcp Scope (null) (Mcp Scope)
Business Id (integer) or Business Id (null) (Business Id)
New Name (string) or New Name (null) (New Name)
Mcp Type (string) or Mcp Type (null) (Mcp Type)
Command (string) or Command (null) (Command)
Array of Args (strings) or Args (null) (Args)
Env (object) or Env (null) (Env)
Headers (object) or Headers (null) (Headers)
Url (string) or Url (null) (Url)
Logo (string) or Logo (null) (Logo)
Note (string) or Note (null) (Note)
Is Active (boolean) or Is Active (null) (Is Active)
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "mcp_scope": 0,
  • "business_id": 0,
  • "new_name": "string",
  • "mcp_type": "string",
  • "command": "string",
  • "args": [
    ],
  • "env": {
    },
  • "headers": {
    },
  • "url": "string",
  • "logo": "string",
  • "note": "string",
  • "is_active": true
}

Response samples

Content type
application/json
null

Update Server Endpoint

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
server_name
required
string (Server Name)
query Parameters
Business Id (integer) or Business Id (null) (Business Id)
Request Body schema: application/json
required
Mcp Scope (integer) or Mcp Scope (null) (Mcp Scope)
Business Id (integer) or Business Id (null) (Business Id)
New Name (string) or New Name (null) (New Name)
Mcp Type (string) or Mcp Type (null) (Mcp Type)
Command (string) or Command (null) (Command)
Array of Args (strings) or Args (null) (Args)
Env (object) or Env (null) (Env)
Headers (object) or Headers (null) (Headers)
Url (string) or Url (null) (Url)
Logo (string) or Logo (null) (Logo)
Note (string) or Note (null) (Note)
Is Active (boolean) or Is Active (null) (Is Active)
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "mcp_scope": 0,
  • "business_id": 0,
  • "new_name": "string",
  • "mcp_type": "string",
  • "command": "string",
  • "args": [
    ],
  • "env": {
    },
  • "headers": {
    },
  • "url": "string",
  • "logo": "string",
  • "note": "string",
  • "is_active": true
}

Response samples

Content type
application/json
null

Delete Server

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
server_name
required
string (Server Name)
query Parameters
Mcp Scope (integer) or Mcp Scope (null) (Mcp Scope)
Business Id (integer) or Business Id (null) (Business Id)

Responses

Response samples

Content type
application/json
null

Test Server Connection

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
path Parameters
server_name
required
string (Server Name)
query Parameters
Mcp Scope (integer) or Mcp Scope (null) (Mcp Scope)
Business Id (integer) or Business Id (null) (Business Id)

Responses

Response samples

Content type
application/json
{
  • "property1": true,
  • "property2": true
}

Workflow

Execute Workflow

Execute a workflow with support for sync, stream, and background modes

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
background
boolean (Background)
Default: false
stream
boolean (Stream)
Default: false
flow_id
required
string (Flow Id)
Inputs (object) or Inputs (null) (Inputs)

Component-specific inputs in flat format: 'component_id.param_name': value

Responses

Request samples

Content type
application/json
{
  • "background": false,
  • "flow_id": "flow_67ccd2be17f0819081ff3bb2cf6508e60bb6a6b452d3795b",
  • "inputs": {
    },
  • "stream": false
}

Response samples

Content type
Example
{
  • "flow_id": "string",
  • "job_id": "string",
  • "object": "response",
  • "created_timestamp": "string",
  • "status": "queued",
  • "errors": [ ],
  • "inputs": { },
  • "outputs": { }
}

Get Workflow Status

Get status of workflow job by job ID

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
Job Id (string) or Job Id (integer) or Job Id (null) (Job Id)

Job ID to query

Responses

Response samples

Content type
{
  • "flow_id": "string",
  • "job_id": "string",
  • "object": "response",
  • "created_timestamp": "string",
  • "status": "queued",
  • "errors": [ ],
  • "inputs": { },
  • "outputs": { }
}

Stop Workflow

Stop a running workflow execution

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
Request Body schema: application/json
required
required
Job Id (string) or Job Id (integer) (Job Id)
Any of
string (Job Id)

Responses

Request samples

Content type
application/json
{
  • "job_id": "string"
}

Response samples

Content type
application/json
{
  • "job_id": "string",
  • "message": "string"
}

Health Check

Health

Responses

Response samples

Content type
application/json
null

Health Check

Responses

Response samples

Content type
application/json
{
  • "status": "nok",
  • "chat": "error check the server logs",
  • "db": "error check the server logs"
}

Log

Stream Logs

HTTP/2 Server-Sent-Event (SSE) endpoint for streaming logs.

Requires authentication to prevent exposure of sensitive log data. It establishes a long-lived connection to the server and receives log messages in real-time. The client should use the header "Accept: text/event-stream".

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header

Responses

Response samples

Content type
application/json
null

Logs

Retrieve application logs with authentication required.

SECURITY: Logs may contain sensitive information and require authentication.

Authorizations:
OAuth2PasswordBearerCookieAPI key queryAPI key header
query Parameters
lines_before
integer (Lines Before)
Default: 0

The number of logs before the timestamp or the last log

lines_after
integer (Lines After)
Default: 0

The number of logs after the timestamp

timestamp
integer (Timestamp)
Default: 0

The timestamp to start getting logs from

Responses

Response samples

Content type
application/json
null