Default

Get Collections

get

Get collections for the current user's workspace

Supports filtering by name and sorting by name, creation time, or update time. Returns basic collection information with agent_ids only (no full agent details).

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
pageinteger · min: 1Optional

Page number (starting from 1)

Default: 1
limitinteger · min: 1 · max: 100Optional

Number of items per page (1-100)

Default: 10
nameany ofOptional

Filter collections by name (partial match, case-insensitive)

stringOptional
or
nullOptional
order_byany ofOptional

Field to sort by (name, created_at, updated_at)

Default: created_at
string · enumOptional

Collection ordering field options

Possible values:
or
nullOptional
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/collections

Create Collection

post

Create a new collection

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
agent_idsstring[]OptionalDefault: []
Responses
200

Successful Response

application/json
post
/v1/collections

Get Collections Count

get

Get total count of collections for the current user's workspace

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
nameany ofOptional

Filter collections by name (partial match, case-insensitive)

stringOptional
or
nullOptional
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/collections/count

No content

Get Collection By Id

get

Get a single collection by ID with full agent details

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
collection_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/collections/{collection_id}

Delete Collection

delete

Delete a collection

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
collection_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
delete
/v1/collections/{collection_id}

No content

Update Collection

patch

Update an existing collection (partial update)

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
collection_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
nameany ofOptional
stringOptional
or
nullOptional
descriptionany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
patch
/v1/collections/{collection_id}

Add Agents To Collection

post

Add agents to a collection

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
collection_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Bodystring[]
string[]Optional
Responses
200

Successful Response

application/json
post
/v1/collections/{collection_id}/agents

Remove Agents From Collection

delete

Remove agents from a collection

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
collection_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Bodystring[]
string[]Optional
Responses
200

Successful Response

application/json
delete
/v1/collections/{collection_id}/agents

Get Block Detail

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/builder/context/{context_id}
get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/builder/context/cookie/{context_id}

No content

Get Node Data

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
context_idstring · uuidRequired
Query parameters
limitintegerOptionalDefault: 5
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/builder/context/{context_id}/data

Save Block Snapshot

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
Responses
200

Successful Response

application/json
Responseany
post
/v1/builder/context/{context_id}/metadata

No content

Get System Data

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
node_idstringRequired
context_idstring · uuidRequired
Query parameters
keyany ofOptional
stringOptional
or
nullOptional
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/builder/context/{context_id}/{node_id}/data

Start Chat Stream

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
querystringRequired
modelstringRequired
flow_funcstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/builder/chat/start

No content

Create Context V2

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
querystringRequired
modelstringRequired
flow_funcstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/builder/bot/v2

No content

Stream Bot

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
querystringRequired
modelstringRequired
flow_funcstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/builder/bot/start

No content

Blocks

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
page_numberintegerOptionalDefault: 1
page_sizeintegerOptionalDefault: 10
flow_funcany ofOptional
stringOptional
or
nullOptional
statusany ofOptional
stringOptional
or
nullOptional
categoryany ofOptional
stringOptional
or
nullOptional
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/builder

Reasoning Object

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
revise_task_idstringRequired
context_idstring · uuidRequired
Query parameters
modelstringOptional
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/builder/context/reasoning/{context_id}/{revise_task_id}

No content

Stream Context

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
ref_idstringRequired
context_idstring · uuidRequired
Query parameters
querystringRequired
modelstringOptional
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/builder/chat/stream/{context_id}/{ref_id}

No content

Create Node

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
actionany ofOptional

Actionable items: FOLLOW UP or SYSTEM tasks

or
nullOptional
orderintegerOptional

0 as root

Default: 0
depend_task_orderinteger[]Optional

list of dependant tasks int

Default: []
refany ofOptional

always empty string

Default: ""
stringOptional
or
nullOptional
usagesany ofOptional

ignore

Default: 0
integerOptional
or
nullOptional
task_configany ofOptional

ignore

Default: {}
or
nullOptional
tool_nameany ofOptional

is used for creating tool name.

stringOptional
or
nullOptional
filtersany ofOptionalDefault: []
or
nullOptional
configany ofOptionalDefault: {}
or
nullOptional
Responses
200

Successful Response

application/json
post
/v1/builder/{context_id}/task

Highlight Node

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
node_idstringRequired
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
querystringRequired
context_idstringOptionalDefault: ""Pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
task_idstringOptionalDefault: ""
contextanyOptional
Responses
200

Successful Response

application/json
post
/v1/builder/context/{context_id}/{node_id}/highlight

Highlight Node

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
node_idstringRequired
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
querystringRequired
context_idstringOptionalDefault: ""Pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
task_idstringOptionalDefault: ""
contextanyOptional
Responses
200

Successful Response

application/json
post
/v1/builder/context/{context_id}/{node_id}/dislike

Update Content

put
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
data_node_idstringRequired
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
keystringRequired
valueanyRequired
Responses
200

Successful Response

application/json
put
/v1/builder/context/{context_id}/{data_node_id}/content

Delete Data Node

delete
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
data_node_idstringRequired
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
delete
/v1/builder/context/{context_id}/{data_node_id}/content

No content

Task Settings

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
task_idstringRequired
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
contentstringOptionalDefault: ""
goalstringOptionalDefault: ""
tool_nameany ofOptional
stringOptional
or
nullOptional
context_idstringOptionalDefault: ""Pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
task_idstringOptionalDefault: ""
Responses
200

Successful Response

application/json
Responseany
post
/v1/builder/context/{context_id}/{task_id}/settings

No content

Update Task

put
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
task_idstringRequired
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
context_idany ofOptionalDefault: ""
stringOptionalPattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
or
nullOptional
task_idany ofOptionalDefault: ""
stringOptional
or
nullOptional
task_configany ofOptional
or
nullOptional
depend_task_orderany ofOptional
integer[]Optional
or
nullOptional
actionany ofOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
put
/v1/builder/context/{context_id}/{task_id}

No content

Upload Knowledge

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
filestring · binaryRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/builder/context/{context_id}/knowledge

No content

Upload File Url To Directus

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
node_idstringRequired
context_idstring · uuidRequired
Query parameters
file_urlstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/builder/context/{context_id}/{node_id}/url

No content

Upload File To Directus

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
node_idstringRequired
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
filestring · binaryRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/builder/context/{context_id}/{node_id}/docs

No content

Upload File To Directus

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
node_idstringRequired
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
filestring · binaryRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/builder/context/{context_id}/{node_id}/upload

No content

Upload File To S3

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
filestring · binaryRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/upload/s3/docs

No content

Upload File To Directus

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
filestring · binaryRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/upload/directus/docs

No content

Api Run Task

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
context_idstringOptionalDefault: ""Pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
task_idstringOptionalDefault: ""
Responses
200

Successful Response

application/json
Responseany
post
/v1/builder/start_task

No content

Personalize Campaign

post
Body
campaign_idstringRequired
modelstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/private/ex/campaign

No content

Login

post
Body
emailstring · emailRequired
is_mobileany ofOptionalDefault: false
booleanOptional
or
nullOptional
redirect_urlany ofOptional
stringOptional
or
nullOptional
workspaceany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/login

No content

Logout

post
cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/logout

No content

Onboarding Aws

post
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
ws_idstring · min: 5 · max: 60RequiredPattern: ^[A-Za-z0-9]+(?:[._-]{1}[A-Za-z0-9]+)*$
ws_namestringRequired
emailstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/aws/users/onboarding

No content

Validate

get
Path parameters
tokenanyRequired
Responses
200

Successful Response

application/json
Responseany
get
/v1/validate/{token}

No content

Authenticate Workspace

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
workspace_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/authenticate/workspace/{workspace_id}

No content

Login Via Google

get
Responses
200

Successful Response

application/json
Responseany
get
/oauth/v1/login/google
200

Successful Response

No content

Auth Via Google

get
Responses
200

Successful Response

application/json
Responseany
get
/oauth/v1/auth/google
200

Successful Response

No content

Login Via Github

get
Responses
200

Successful Response

application/json
Responseany
get
/oauth/v1/login/github
200

Successful Response

No content

Auth Via Github

get
Responses
200

Successful Response

application/json
Responseany
get
/oauth/v1/auth/github
200

Successful Response

No content

Get My Profile

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/me

No content

Update My Profile

put
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
nameany ofOptional
stringOptional
or
nullOptional
avatar_urlany ofOptional
stringOptional
or
nullOptional
titleany ofOptional
stringOptional
or
nullOptional
descriptionany ofOptional
stringOptional
or
nullOptional
genderany ofOptional
string · enumOptionalPossible values:
or
nullOptional
interested_inany ofOptional
string[]Optional
or
nullOptional
social_linksany ofOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
put
/v1/me

No content

Check Studio Access

get

Check if the current user has Studio app permissions

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/me/studio-access

No content

Switch App

post

Switch app by returning HTTP redirect to target app's auth endpoint

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body

Request model for switching between applications

target_appstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/switch-app

No content

Get User Avatar

get
Path parameters
user_idanyRequired
Responses
200

Successful Response

application/json
Responseany
get
/v1/profile/avatar/{user_id}.jpeg

No content

Upload User Avatar

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
filestring · binaryRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/profile/avatar/upload

No content

Upload Templates Image

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
filestring · binaryRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/templates/upload_img

No content

Get My Workspaces

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/workspaces

No content

Create Workspace

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
idstring · min: 5 · max: 60RequiredPattern: ^[A-Za-z0-9]+(?:[._-]{1}[A-Za-z0-9]+)*$
namestringRequired
invitation_codeany ofOptionalDefault: ""
stringOptional
or
nullOptional
org_namestringRequired
team_sizestringRequired
occupationstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/workspaces

No content

Update Workspace

put
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
idstring · min: 5 · max: 60RequiredPattern: ^[A-Za-z0-9]+(?:[._-]{1}[A-Za-z0-9]+)*$
namestringRequired
invitation_codeany ofOptionalDefault: ""
stringOptional
or
nullOptional
org_namestringRequired
team_sizestringRequired
occupationstringRequired
Responses
200

Successful Response

application/json
Responseany
put
/v1/workspaces

No content

Get Workspace Server Keys

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/workspaces/server-keys

No content

Create Workspace Server Key

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
descriptionany ofOptional
stringOptional
or
nullOptional
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/workspaces/server-keys

No content

Revoke Workspace Server Key

put
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
put
/v1/workspaces/server-keys

No content

Generate Token By Server Keys

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
emailstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/workspaces/server-keys/generate-token

No content

Get Line Chart Data

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
windowstringRequired
group_by_modelany ofOptionalDefault: false
booleanOptional
or
nullOptional
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/workspaces/credits

Invite

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
emailsstring · email[]Required
workspace_idstringRequired
is_mobileany ofOptionalDefault: false
booleanOptional
or
nullOptional
roleany ofRequired
stringOptional
or
nullOptional
app_permissionsany ofOptional
string[]Optional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/workspaces/invite

No content

Invite Link

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/workspaces/invite-link

No content

Join

get
Path parameters
tokenstringRequired
Responses
200

Successful Response

application/json
Responseany
get
/v1/workspaces/join/{token}

No content

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
codestringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/workspaces/join-link/{code}

No content

Delete Workspace Member

delete
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
member_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
delete
/v1/workspaces/members/{member_id}

No content

Get Workspace Members

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
qany ofOptional
stringOptional
or
nullOptional
pageintegerOptionalDefault: 1
limitintegerOptionalDefault: 10
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/workspaces/members

No content

Update Workspace Member

put
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
idstringRequired
rolestringRequired
statusstringRequired
mobile_accessbooleanRequired
Responses
200

Successful Response

application/json
Responseany
put
/v1/workspaces/members

No content

Transfer Workspace Owner

put
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
user_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
put
/v1/workspaces/members/transfer-owner/{user_id}

No content

Get Workspace Packages

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
filterstring · enumOptionalDefault: my_packagePossible values:
page_sizeintegerOptionalDefault: 10
pageintegerOptionalDefault: 0
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/workspaces/packages

No content

List Workspace Invoices

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
page_sizeintegerOptionalDefault: 10
pageintegerOptionalDefault: 0
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/workspaces/invoices

No content

Get Workspace Invoice

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
invoice_idanyRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/workspaces/invoices/{invoice_id}

No content

Get Workspace

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
workspace_idanyRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/workspaces/{workspace_id}

No content

Switch Workspace

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
workspace_idanyRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/workspaces/{workspace_id}/switch

No content

Get Author

get
Path parameters
author_idstring · uuidRequired
Responses
200

Successful Response

application/json
Responseany
get
/v1/authors/{author_id}

No content

List Authors

get
Responses
200

Successful Response

application/json
Responseany
get
/v1/authors
200

Successful Response

No content

Follow Author

post
Path parameters
author_idanyRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/authors/{author_id}/follow

No content

get
Query parameters
qstringRequired
Responses
200

Successful Response

application/json
Responseany
get
/v1/marketplace/search

No content

List Marketplace Categories

get
Responses
200

Successful Response

application/json
Responseany
get
/v1/marketplace/categories
200

Successful Response

No content

Get Marketplace Package

get
Path parameters
package_idanyRequired
Responses
200

Successful Response

application/json
Responseany
get
/v1/marketplace/packages/{package_id}

No content

List Marketplace Packages

get
Query parameters
categoryany ofOptional
stringOptional
or
nullOptional
sortstring · enumOptionalDefault: allPossible values:
page_sizeintegerOptionalDefault: 10
pageintegerOptionalDefault: 0
Responses
200

Successful Response

application/json
Responseany
get
/v1/marketplace/packages

No content

Get Package Comments

get
Query parameters
package_idstringRequired
parent_idany ofOptional
stringOptional
or
nullOptional
page_sizeintegerOptionalDefault: 10
pageintegerOptionalDefault: 0
Responses
200

Successful Response

application/json
Responseany
get
/v1/marketplace/comments

No content

Create Package Comment

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
package_idstringRequired
parent_idany ofOptional
stringOptional
or
nullOptional
textstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/marketplace/comments

No content

Read Item Templates

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
qany ofOptional
stringOptional
or
nullOptional
categoryany ofOptional
stringOptional
or
nullOptional
pageintegerOptionalDefault: 1
limitintegerOptionalDefault: 10
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/items/templates

No content

Read Item Templates

get
Path parameters
template_idstringRequired
Responses
200

Successful Response

application/json
Responseany
get
/v1/items/templates/{template_id}

No content

Read Tools

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/items/tools

No content

Get Llm Models

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/items/llm-models

No content

Create Llm Models

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
idany ofOptional
integerOptional
or
nullOptional
labelstringRequired
valuestringRequired
iconstringRequired
pricenumberRequired
smartnumberRequired
speednumberRequired
isHighSpeedbooleanRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/items/llm-models

No content

Update Llm Models

put
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
idintegerRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
idany ofOptional
integerOptional
or
nullOptional
labelstringRequired
valuestringRequired
iconstringRequired
pricenumberRequired
smartnumberRequired
speednumberRequired
isHighSpeedbooleanRequired
Responses
200

Successful Response

application/json
Responseany
put
/v1/items/llm-models/{id}

No content

Get Llm Settings By Id

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
idintegerRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/items/llm-settings/{id}

No content

Update Llm Settings

put
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
idintegerRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
idany ofRequired
integerOptional
or
nullOptional
categorystringRequired
languagestringRequired
output_formatstringRequired
created_bystringRequired
ws_idstringRequired
Responses
200

Successful Response

application/json
Responseany
put
/v1/items/llm-settings/{id}

No content

Get Llm Settings

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
categoryany ofOptional
stringOptional
or
nullOptional
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/items/llm-settings

No content

Add Llm Setting

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
idany ofRequired
integerOptional
or
nullOptional
categorystringRequired
languagestringRequired
output_formatstringRequired
created_bystringRequired
ws_idstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/items/llm-settings

No content

Stripe Webhook

post
Responses
200

Successful Response

application/json
Responseany
post
/v1/webhook
200

Successful Response

No content

Get Quota

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/wallet/quotas

No content

List Connectors

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/connectors

Create Connector

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
namestringRequired
sourcestring · enumRequiredPossible values:
input_typestring · enumRequiredPossible values:
refresh_freqany ofRequired
integerOptional
or
nullOptional
disabledbooleanRequired
Responses
200

Successful Response

application/json
post
/v1/connectors

Connector Run Once

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
connector_idintegerRequired
credential_idsany ofRequired
integer[]Optional
or
nullOptional
from_beginningbooleanOptionalDefault: false
Responses
200

Successful Response

application/json
Responseany
post
/v1/connectors/run-once

No content

Document Ingestion

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
connector_idany ofOptional
integerOptional
or
nullOptional
connector_nameany ofOptional
stringOptional
or
nullOptional
credential_idany ofOptional
integerOptional
or
nullOptional
create_connectorbooleanOptionalDefault: false
public_docbooleanOptionalDefault: true
Responses
200

Successful Response

application/json
post
/v1/connectors/doc-ingestion

Get Connector Indexing Status

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
secondary_indexbooleanOptionalDefault: false
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/connectors/indexing-status

Get Connector Cc Pair Detail

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
cc_pair_idintegerRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/connectors/cc_pair/{cc_pair_id}

Gmail Auth

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
credential_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/connectors/gmail/authorize/{credential_id}

Gmail Callback

get
Query parameters
statestringRequired
codestringRequired
Responses
200

Successful Response

application/json
Responseany
get
/v1/connectors/gmail/auth/callback

No content

Check Google App Google Credentials Exist

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/connectors/google/app-credential

No content

Google Drive Auth

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
credential_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/connectors/google-drive/authorize/{credential_id}

Google Drive Callback

get
Query parameters
statestringRequired
codestringRequired
Responses
200

Successful Response

application/json
get
/v1/connectors/google-drive/auth/callback

Google Calendar Auth

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
bot_idstringRequired
task_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/connectors/google-calendar/authorize/{bot_id}/{task_id}

Google Calendar Auth

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
bot_idstringRequired
task_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/connectors/gmail/authorize/{bot_id}/{task_id}

Google Calendar Callback

get
Query parameters
statestringRequired
codestringRequired
Responses
200

Successful Response

application/json
get
/v1/bot/gmail/auth/callback

Google Calendar Callback

get
Query parameters
statestringRequired
codestringRequired
Responses
200

Successful Response

application/json
get
/v1/connectors/google-calendar/auth/callback

Create Credential From Model

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
admin_publicbooleanRequired
Responses
200

Successful Response

application/json
post
/v1/credentials

Associate Credential To Connector

put
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
connector_idintegerRequired
credential_idintegerRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
nameany ofRequired
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
put
/v1/connectors/{connector_id}/credentials/{credential_id}

No content

Create Template

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
namestring · min: 5 · max: 255Required
descriptionstring · min: 5 · max: 255Required
categorystring · min: 5 · max: 255Required
statusany ofOptionalDefault: PUBLISHED_WS
string · enumOptionalPossible values:
or
nullOptional
preview_imageany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/templates/create/{context_id}

No content

Clone Template

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
template_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/templates/{template_id}/clone

No content

Search

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
qany ofOptional
stringOptional
or
nullOptional
collectionany ofOptional
stringOptional
or
nullOptional
categoryany ofOptional
stringOptional
or
nullOptional
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/searching

No content

Zalo Receive Event

post
Responses
200

Successful Response

application/json
Responseany
post
/v1/webhook/zalo
200

Successful Response

No content

Update Tool

put
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
tool_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
namestringRequired
sourcestringRequired
Responses
200

Successful Response

application/json
Responseany
put
/v1/items/tools/{tool_id}

No content

Delete Tool

delete

Delete a tool

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
tool_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
delete
/v1/items/tools/{tool_id}

No content

Create Workspace App Permission

post

Create new workspace app permissions

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
workspace_idstringRequired
member_idstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/workspaces/app-permissions

No content

Delete Workspace App Permission

delete

Delete a workspace app permission

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
workspace_idstringRequired

Workspace ID

member_idstringRequired

Member ID

app_namestringRequired

Application name

Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
delete
/v1/workspaces/app-permissions

No content

Update Block Design

patch

Update design fields for a context

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body

Model for updating block design fields

audit_rulesany ofOptional

Audit rules configuration

or
nullOptional
files_catalogany ofOptional

Files catalog configuration

or
nullOptional
functionsany ofOptional

Functions configuration

or
nullOptional
datalogany ofOptional

Datalog configuration

or
nullOptional
global_parametersany ofOptional

Global parameters configuration

Default: []
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
patch
/v1/builder/context/{context_id}/design

No content

Get Datalog Tables

get

List all production tables (catalog tables with status 'PROD') accessible to the user in their workspace. Returns a list of {"combined_name": <project_name>_<table_name>, "table_id": <table_id>}.

TODO: Add pagination if data is too large

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/builder/datalog-tables

No content

Get Data From Trigger

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
Other propertiesanyOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/items/flows/triggers/data/{id}

No content

Register User With Invitation Code

post

Register a new user or add existing user to workspace using invitation code.

This endpoint allows users to self-register and join a workspace using a valid invitation/promotion code. The code must be active, not expired, and not previously used.

Request Body: email (str): User's email address (validated as standard email) name (str): User's full name workspace_id (str): Target workspace ID promotion_code (str): Workspace invitation code role (str, optional): User role (default: "member") avatar_url (str, optional): Profile avatar URL mobile_access (bool, optional): Mobile access enabled (default: true)

Returns: UserRegistrationResponse: User details and workspace membership info

Raises: 400: Invalid request data 404: Workspace or invitation code not found 403: Invitation code invalid/expired/used 409: User already in workspace 500: Internal server error

Body
Other propertiesanyOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/auth/register

No content

Get Triggers

get
cookie
authstringOptionalDefault: ""
Path parameters
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/bots/configs/triggers/{context_id}

Add Bot Trigger

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
nameany ofOptional
stringOptional
or
nullOptional
descriptionany ofOptional
stringOptional
or
nullOptional
scheduleany ofOptional
stringOptional
or
nullOptional
start_promptany ofOptional
stringOptional
or
nullOptional
statusany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/bots/configs/triggers/{context_id}

No content

Delete Triggers

delete
cookie
authstringOptionalDefault: ""
Path parameters
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Bodystring[]
string[]Optional
Responses
200

Successful Response

application/json
Responseany
delete
/v1/bots/configs/triggers/{context_id}

No content

Get Trigger

get
cookie
authstringOptionalDefault: ""
Path parameters
trigger_idstring · uuidRequired
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/bots/configs/triggers/{context_id}/{trigger_id}

Update Bot Trigger

put
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
trigger_idstring · uuidRequired
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
nameany ofOptional
stringOptional
or
nullOptional
descriptionany ofOptional
stringOptional
or
nullOptional
scheduleany ofOptional
stringOptional
or
nullOptional
start_promptany ofOptional
stringOptional
or
nullOptional
statusany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
put
/v1/bots/configs/triggers/{context_id}/{trigger_id}

No content

Update Config

put
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
keyany ofOptional
stringOptional
or
nullOptional
configany ofOptional
anyOptional
or
nullOptional
nameany ofOptional
stringOptional
or
nullOptional
labelany ofOptional
string[]Optional
or
nullOptional
aliasany ofOptional
stringOptional
or
nullOptional
statusany ofOptional
stringOptional
or
nullOptional
key_configsany ofOptional
or
nullOptional
categoryany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
put
/v1/bots/configs/{context_id}

No content

Delete Bot

delete
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
context_idstring · uuidRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
delete
/v1/bots/{context_id}

No content

Create Chat Session

post

Render the default templates.

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
bot_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/chat/{bot_id}

No content

Get Chat Sessions

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
bot_idstringRequired
Query parameters
pageintegerOptionalDefault: 1
page_sizeintegerOptionalDefault: 10
is_response_first_messagesany ofOptionalDefault: false
booleanOptional
or
nullOptional
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/chat/sessions/{bot_id}

No content

Get Bot By Users

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Query parameters
queryany ofOptional
stringOptional
or
nullOptional
pageintegerOptionalDefault: 1
page_sizeintegerOptionalDefault: 10
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/chat/bots

No content

Sessions

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
bot_idstringRequired
session_idstringRequired
Query parameters
idxintegerOptionalDefault: 0
filterstringOptional
pageintegerOptionalDefault: 1
page_sizeintegerOptionalDefault: 10
scrollintegerOptionalDefault: 0
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/chat/sessions/{bot_id}/{session_id}

No content

Delete Session By Session Id

delete
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
bot_idstringRequired
session_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
delete
/v1/chat/sessions/{bot_id}/{session_id}

No content

Sessions Vector

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
bot_idstringRequired
session_idstringRequired
Query parameters
querystringRequired
pageintegerOptionalDefault: 1
page_sizeintegerOptionalDefault: 10
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/chat/sessions/{bot_id}/{session_id}/response

No content

Chat Sse Get

get
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
session_idstringRequired
Query parameters
promptstring · min: 2Required
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
get
/v1/prompt/{session_id}

No content

Chat Post

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
session_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
promptstringRequired
contextstringOptionalDefault: {}
Responses
200

Successful Response

application/json
post
/v1/prompt/{session_id}

Webrtc Prompt

post
Path parameters
bot_idstringRequired
session_idstringRequired
user_idstringRequired
Body
promptstringRequired
Responses
200

Successful Response

application/json
post
/v1/webrtc/{bot_id}/{session_id}/{user_id}

Upload Bot Session

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
session_idstringRequired
Query parameters
promptany ofOptional
stringOptional
or
nullOptional
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
filestring · binaryRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/prompt/file/{session_id}

No content

Upload Bot Session

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
session_idstringRequired
Query parameters
urlstringRequired
promptany ofOptional
stringOptional
or
nullOptional
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/prompt/url/{session_id}

No content

Get W Prompt

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
workflow_idstringRequired
session_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
promptstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/w_prompt/{workflow_id}/{session_id}

No content

Post Flow Prompt

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
session_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
promptstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/flow_prompt/{session_id}

No content

Run Flow Index

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
flow_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
Responses
200

Successful Response

application/json
Responseany
post
/v1/task/reindex/{flow_id}

No content

Upload Workflow Session

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
session_idstringRequired
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Body
promptany ofOptional
stringOptional
or
nullOptional
filestring · binary[]Required
Responses
200

Successful Response

application/json
Responseany
post
/v1/w_file/{session_id}

No content

Upload Url Workflow Session

post
Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie
authstringOptionalDefault: ""
Path parameters
session_idstringRequired
Query parameters
urlstringRequired
promptany ofOptional
stringOptional
or
nullOptional
Header parameters
authorizationany ofOptionalDefault: ""
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
post
/v1/w_url/{session_id}

No content

Listen Webhooks

get
Path parameters
platformstringRequired
Responses
200

Successful Response

application/json
Responseany
get
/v1/listen/{platform}

No content

Listen Webhook

post
Path parameters
platformstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/listen/{platform}

No content

Handle Webhook Message

post

Handle incoming webhook messages from Telegram

Args: agent_id: Agent's workflow ID request: Incoming webhook request session: Database session

Path parameters
agent_idstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/v1/telegram/webhook/{agent_id}

No content

Enable Telegram For Agent

post

Enable Telegram integration for an agent

Args: agent_id: Agent UUID request: Telegram configuration user: Current authenticated user session: Database session

Authorizations
AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

Path parameters
agent_idstring · uuidRequired
Body

Request model for enabling Telegram for an agent

telegram_tokenstringRequired

Telegram bot token

Responses
200

Successful Response

application/json
Responseany
post
/v1/telegram/enable/{agent_id}

No content

Last updated

Was this helpful?