Tools

Get Custom Tools

get

Get all custom tool providers for the user's organization.

Args: user_org: Current authenticated user service: Custom tool service instance

Returns: List of custom tool providers

Responses
200

Successful Response

application/json
Responseany[]
get
GET /tools/custom HTTP/1.1
Host: 
Accept: */*
200

Successful Response

[]

Create Custom Tool

post

Create a new custom tool provider.

Args: data: Provider creation data service: Custom tool service instance user_org: Current user's organization user: Current user profile

Returns: Created custom tool provider

Body
anyOptional
Responses
201

Successful Response

application/json
Responseany
post
POST /tools/custom HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*

No content

Update Custom Tool

put

Update an existing custom tool provider.

Args: provider_id: Provider ID to update data: Provider update data service: Custom tool service instance user_org: Current user's organization user: Current user profile

Returns: Updated custom tool provider

Path parameters
provider_idstringRequired
Body
anyOptional
Responses
200

Successful Response

application/json
Responseany
put
PUT /tools/custom/{provider_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*

No content

Delete Custom Tool

delete

Delete a custom tool provider.

Args: provider_id: Provider ID to delete user_org: Current user's organization service: Custom tool service instance

Returns: None

Path parameters
provider_idstringRequired
Responses
204

Successful Response

No content

delete
DELETE /tools/custom/{provider_id} HTTP/1.1
Host: 
Accept: */*

No content

Get Stackai Tools

get

Get all providers with tools created by StackAI's team.

Responses
200

Successful Response

application/json
Responseany[]
get
GET /tools/stackai HTTP/1.1
Host: 
Accept: */*
200

Successful Response

[]

Get Stackai Providers

get

Get all providers with tools created by StackAI's team.

Responses
200

Successful Response

application/json
get
GET /tools/stackai/actions HTTP/1.1
Host: 
Accept: */*
200

Successful Response

[
  {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
]

Get Action By Provider And Id

get

Get the data for a specific native action available and implemented by StackAI.

Path parameters
provider_idstringRequired
action_idstringRequired
Responses
200

Successful Response

application/json
Responseany
get
GET /tools/stackai/providers/{provider_id}/actions/{action_id} HTTP/1.1
Host: 
Accept: */*

No content

Get Action Inputs

get

Get the input parameters for an action as a JSON schema.

Path parameters
provider_idstringRequired
action_idstringRequired
Responses
200

Successful Response

application/json
Responseobject · ResponseGetActionInputsToolsStackaiProvidersProviderIdActionsActionIdInputsGet
get
GET /tools/stackai/providers/{provider_id}/actions/{action_id}/inputs HTTP/1.1
Host: 
Accept: */*
{}

Get Action Outputs

get

Get the output parameters for an action as a JSON schema.

Path parameters
provider_idstringRequired
action_idstringRequired
Responses
200

Successful Response

application/json
Responseobject · ResponseGetActionOutputsToolsStackaiProvidersProviderIdActionsActionIdOutputsGet
get
GET /tools/stackai/providers/{provider_id}/actions/{action_id}/outputs HTTP/1.1
Host: 
Accept: */*
{}

Get Provider Icon

get

Get the icon for a specific provider.

Path parameters
provider_idstringRequired
Responses
200

Successful Response

application/json
Responseany
get
GET /tools/stackai/{provider_id}/icon HTTP/1.1
Host: 
Accept: */*

No content

Get Action Options

post

Get action options for a specific action and provider.

Args: options_request: Action and provider identifiers user_organization: The user organization

Returns: List of schema strings for the action

Body
anyOptional
Responses
200

Successful Response

application/json
Responseany[]
post
POST /tools/options HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
[]

Was this helpful?