User Management

Project Member and user related APIs

Get Agents

get
/webapi/v2/agents
Authorizations
API-KEYstringRequired

Your API key for authentication

Query parameters
offsetintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
emailany ofOptional
stringOptional
or
nullOptional
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
chevron-right
200

OK

application/json
get
/webapi/v2/agents
200

OK

Get Agent Detail

get
/webapi/v2/agents/{agent_id}
Authorizations
API-KEYstringRequired

Your API key for authentication

Path parameters
agent_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
chevron-right
200

OK

application/json
idstringRequired
lastNamestringRequired
firstNamestringRequired
emailstringRequired
get
/webapi/v2/agents/{agent_id}
200

OK

Perform Bulk User Actions

post
/webapi/v2/users/bulk
Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
actionstring · enumRequiredPossible values:
Responses
chevron-right
200

OK

application/json
post
/webapi/v2/users/bulk
200

OK

Get User

get
/webapi/v2/user/{own_user_id}
Authorizations
API-KEYstringRequired

Your API key for authentication

Path parameters
own_user_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
chevron-right
200

OK

application/json
get
/webapi/v2/user/{own_user_id}
200

OK

Bulk Invite Members

post
/webapi/v2/members/bulk/invite

Bulk invite members to project.

This endpoint:

  1. Creates agents for emails that don't exist

  2. Adds agents as project members if not already

  3. Creates users for works projects

  4. Assigns permission groups (creates if needed)

Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

Request for bulk inviting members.

Responses
chevron-right
200

OK

application/json

Response for bulk member operations.

post
/webapi/v2/members/bulk/invite
200

OK

Bulk Update Member Permission Groups

post
/webapi/v2/members/bulk/update_permission_groups

Bulk update member permission groups.

This endpoint updates permission groups for existing members only.

Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

Request for bulk updating member permission groups.

Responses
chevron-right
200

OK

application/json

Response for bulk member operations.

post
/webapi/v2/members/bulk/update_permission_groups
200

OK

Bulk Remove Members

post
/webapi/v2/members/bulk/remove

Bulk remove members from project.

This endpoint removes existing members from the project.

Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

Request for bulk removing members.

Responses
chevron-right
200

OK

application/json

Response for bulk member operations.

post
/webapi/v2/members/bulk/remove
200

OK

Get Permission Groups

get
/webapi/v2/permission_groups
Authorizations
API-KEYstringRequired

Your API key for authentication

Query parameters
search_termany ofOptional
stringOptional
or
nullOptional
limitintegerOptionalDefault: 100
offsetintegerOptionalDefault: 0
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
chevron-right
200

OK

application/json
get
/webapi/v2/permission_groups
200

OK

Get Permission Group

get
/webapi/v2/permission_groups/{permission_group_id}
Authorizations
API-KEYstringRequired

Your API key for authentication

Path parameters
permission_group_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
chevron-right
200

OK

application/json
idstringRequired
namestringRequired
isAdminbooleanRequired
isDefaultbooleanRequired
orderany ofRequired
integerOptional
or
nullOptional
permissionsstring[]Required
get
/webapi/v2/permission_groups/{permission_group_id}
200

OK

Delete Permission Group

delete
/webapi/v2/permission_groups/{permission_group_id}
Authorizations
API-KEYstringRequired

Your API key for authentication

Path parameters
permission_group_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
chevron-right
200

OK

No content

delete
/webapi/v2/permission_groups/{permission_group_id}
200

OK

No content

Get Permission Group Agents

get
/webapi/v2/permission_groups/{permission_group_id}/agents
Authorizations
API-KEYstringRequired

Your API key for authentication

Path parameters
permission_group_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
chevron-right
200

OK

application/json
idstringRequired
lastNamestringRequired
firstNamestringRequired
emailstringRequired
get
/webapi/v2/permission_groups/{permission_group_id}/agents
200

OK

Update Permission Group Name

put
/webapi/v2/permission_groups/{permission_group_id}/name
Authorizations
API-KEYstringRequired

Your API key for authentication

Path parameters
permission_group_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
namestringRequired
Responses
chevron-right
200

OK

application/json
idstringRequired
namestringRequired
isAdminbooleanRequired
isDefaultbooleanRequired
orderany ofRequired
integerOptional
or
nullOptional
permissionsstring[]Required
put
/webapi/v2/permission_groups/{permission_group_id}/name
200

OK

Update Permission Group Permissions

put
/webapi/v2/permission_groups/{permission_group_id}/permissions
Authorizations
API-KEYstringRequired

Your API key for authentication

Path parameters
permission_group_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
Responses
chevron-right
200

OK

application/json
idstringRequired
namestringRequired
isAdminbooleanRequired
isDefaultbooleanRequired
orderany ofRequired
integerOptional
or
nullOptional
permissionsstring[]Required
put
/webapi/v2/permission_groups/{permission_group_id}/permissions
200

OK

Retrieve all single action app tools for the project

get
/webapi/agent_builder/single_action_app_tools
Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
chevron-right
200

Successfully retrieved single action app tools

application/json
get
/webapi/agent_builder/single_action_app_tools
200

Successfully retrieved single action app tools

Retrieve a specific single action app tool by its name

get
/webapi/agent_builder/single_action_app_tool/{tool_name}
Authorizations
API-KEYstringRequired

Your API key for authentication

Path parameters
tool_namestringRequired

Name of the tool to retrieve

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
chevron-right
200

Successfully retrieved the single action app tool

application/json
successbooleanOptional

Indicates if the operation was successful

get
/webapi/agent_builder/single_action_app_tool/{tool_name}

Retrieve all agent tools for the project

get
/webapi/agent_builder/agent_tools
Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
chevron-right
200

Successfully retrieved agent tools

application/json
get
/webapi/agent_builder/agent_tools
200

Successfully retrieved agent tools

Retrieve a specific agent tool by its name

get
/webapi/agent_builder/agent_tool/{tool_name}
Authorizations
API-KEYstringRequired

Your API key for authentication

Path parameters
tool_namestringRequired

Name of the agent tool to retrieve

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
chevron-right
200

Successfully retrieved the agent tool

application/json
successbooleanOptional

Indicates if the operation was successful

toolobjectOptional

The agent tool data

get
/webapi/agent_builder/agent_tool/{tool_name}

Retrieve OAuth2 information by state

post
/webapi/agent_builder/oauth2_information

Get OAuth2 configuration information for an AI agent using the OAuth state parameter

Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
statestringRequired

OAuth2 state parameter to identify the OAuth configuration

Responses
chevron-right
200

Successfully retrieved OAuth2 information

application/json
successbooleanOptional

Indicates if the operation was successful

post
/webapi/agent_builder/oauth2_information

Update OAuth2 token information

post
/webapi/agent_builder/oauth2_information/update

Update OAuth2 token information (tokenInfo and tokenGenerated) for an existing OAuth configuration

Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
statestringRequired

OAuth2 state parameter to identify the OAuth configuration

tokenInfoobjectOptional

Updated token information

tokenGeneratednumberOptional

Timestamp when the token was generated

Responses
chevron-right
200

Successfully updated OAuth2 information

application/json
successbooleanOptional

Indicates if the operation was successful

post
/webapi/agent_builder/oauth2_information/update

Agent Management

post
/webapi/agent_management

Used to create and delete agents from the project

Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
emailstringOptional

The email of the agent you want to create or delete

deleteFlagbooleanOptional

True if you want to delete an agent, False if you want to create

passwordstringOptional

Required when creating a new agent. Password must be valid (contain 3 out 4 following characters - lowercase, uppercase, numeric, non-alphanumeric)

localestringOptional

The language setting of the account being created. Use a two-letter ISO 639-1 code

permission_group_idstringOptional

ID of the permission group to assign to the agent

permission_group_namestringOptional

Name of the permission group to assign to the agent

Responses
chevron-right
200

Agent edited successfully

application/json
post
/webapi/agent_management

Last updated