Tools
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
Successful Response
GET /tools/custom HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Successful Response
[
{
"provider_id": "text",
"provider_version": "text",
"provider_group": [
"LLM"
],
"name": "text",
"description": "text",
"icon": "text",
"tags": [
"text"
],
"color": "#A3A3A3",
"triggers": [
{
"trigger_id": "text",
"provider_id": "text",
"name": "text",
"description": "text",
"instructions": "text",
"input_params": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"output_params": [
{
"label": "text",
"type": "text",
"llm_description": "text",
"human_description": "text",
"name": "text"
}
],
"api_tool_info": {
"id": "text",
"server_url_with_path": "text",
"method": "text",
"path": "text",
"description": "text",
"parameters": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
}
],
"actions": [
{
"action_id": "text",
"provider_id": "text",
"name": "text",
"description": {
"human": "text",
"llm": "text"
},
"tags": [
"text"
],
"input_params": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"output_params": [
{
"label": "text",
"type": "text",
"llm_description": "text",
"human_description": "text",
"name": "text"
}
],
"api_tool_info": {
"id": "text",
"server_url_with_path": "text",
"method": "text",
"path": "text",
"description": "text",
"parameters": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
}
],
"connections": [
{
"connection_type_id": "text",
"provider_id": "text",
"name": "text",
"description": "text",
"labels": [
"text"
],
"params": [
{
"label": "text",
"type": "string",
"placeholder": "text",
"default": 1,
"help": "text",
"url": "text",
"required": true,
"name": "text"
}
],
"minimum_plan": "text",
"color": "#A3A3A3",
"is_marketing_stunt": false,
"connection_type": "credentials"
}
],
"deprecation_info": {
"date_will_be_removed": "text",
"instructions": "text"
},
"openapi_schema": "text",
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
]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
Successful Response
Validation Error
POST /tools/custom HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 224
{
"name": "text",
"icon": "text",
"api_schema": "text",
"apis": [
{
"server_url": "text",
"name": "text",
"description": "text",
"method": "text",
"path": "text"
}
],
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
],
"dereferenced_schema": null
}{
"provider_id": "text",
"provider_version": "text",
"provider_group": [
"LLM"
],
"name": "text",
"description": "text",
"icon": "text",
"tags": [
"text"
],
"color": "#A3A3A3",
"triggers": [
{
"trigger_id": "text",
"provider_id": "text",
"name": "text",
"description": "text",
"instructions": "text",
"input_params": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"output_params": [
{
"label": "text",
"type": "text",
"llm_description": "text",
"human_description": "text",
"name": "text"
}
],
"api_tool_info": {
"id": "text",
"server_url_with_path": "text",
"method": "text",
"path": "text",
"description": "text",
"parameters": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
}
],
"actions": [
{
"action_id": "text",
"provider_id": "text",
"name": "text",
"description": {
"human": "text",
"llm": "text"
},
"tags": [
"text"
],
"input_params": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"output_params": [
{
"label": "text",
"type": "text",
"llm_description": "text",
"human_description": "text",
"name": "text"
}
],
"api_tool_info": {
"id": "text",
"server_url_with_path": "text",
"method": "text",
"path": "text",
"description": "text",
"parameters": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
}
],
"connections": [
{
"connection_type_id": "text",
"provider_id": "text",
"name": "text",
"description": "text",
"labels": [
"text"
],
"params": [
{
"label": "text",
"type": "string",
"placeholder": "text",
"default": 1,
"help": "text",
"url": "text",
"required": true,
"name": "text"
}
],
"minimum_plan": "text",
"color": "#A3A3A3",
"is_marketing_stunt": false,
"connection_type": "credentials"
}
],
"deprecation_info": {
"date_will_be_removed": "text",
"instructions": "text"
},
"openapi_schema": "text",
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}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
Successful Response
Validation Error
PUT /tools/custom/{provider_id} HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 224
{
"name": "text",
"icon": "text",
"api_schema": "text",
"apis": [
{
"server_url": "text",
"name": "text",
"description": "text",
"method": "text",
"path": "text"
}
],
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
],
"dereferenced_schema": null
}{
"provider_id": "text",
"provider_version": "text",
"provider_group": [
"LLM"
],
"name": "text",
"description": "text",
"icon": "text",
"tags": [
"text"
],
"color": "#A3A3A3",
"triggers": [
{
"trigger_id": "text",
"provider_id": "text",
"name": "text",
"description": "text",
"instructions": "text",
"input_params": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"output_params": [
{
"label": "text",
"type": "text",
"llm_description": "text",
"human_description": "text",
"name": "text"
}
],
"api_tool_info": {
"id": "text",
"server_url_with_path": "text",
"method": "text",
"path": "text",
"description": "text",
"parameters": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
}
],
"actions": [
{
"action_id": "text",
"provider_id": "text",
"name": "text",
"description": {
"human": "text",
"llm": "text"
},
"tags": [
"text"
],
"input_params": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"output_params": [
{
"label": "text",
"type": "text",
"llm_description": "text",
"human_description": "text",
"name": "text"
}
],
"api_tool_info": {
"id": "text",
"server_url_with_path": "text",
"method": "text",
"path": "text",
"description": "text",
"parameters": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
}
],
"connections": [
{
"connection_type_id": "text",
"provider_id": "text",
"name": "text",
"description": "text",
"labels": [
"text"
],
"params": [
{
"label": "text",
"type": "string",
"placeholder": "text",
"default": 1,
"help": "text",
"url": "text",
"required": true,
"name": "text"
}
],
"minimum_plan": "text",
"color": "#A3A3A3",
"is_marketing_stunt": false,
"connection_type": "credentials"
}
],
"deprecation_info": {
"date_will_be_removed": "text",
"instructions": "text"
},
"openapi_schema": "text",
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}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
Successful Response
Validation Error
DELETE /tools/custom/{provider_id} HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Successful Response
GET /tools/stackai HTTP/1.1
Host: api.stack-ai.com
Accept: */*
Successful Response
[
{
"provider_id": "text",
"provider_version": "text",
"provider_group": [
"LLM"
],
"name": "text",
"description": "text",
"icon": "text",
"tags": [
"text"
],
"color": "#A3A3A3",
"triggers": [
{
"trigger_id": "text",
"provider_id": "text",
"name": "text",
"description": "text",
"instructions": "text",
"input_params": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"output_params": [
{
"label": "text",
"type": "text",
"llm_description": "text",
"human_description": "text",
"name": "text"
}
],
"api_tool_info": {
"id": "text",
"server_url_with_path": "text",
"method": "text",
"path": "text",
"description": "text",
"parameters": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
}
],
"actions": [
{
"action_id": "text",
"provider_id": "text",
"name": "text",
"description": {
"human": "text",
"llm": "text"
},
"tags": [
"text"
],
"input_params": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"output_params": [
{
"label": "text",
"type": "text",
"llm_description": "text",
"human_description": "text",
"name": "text"
}
],
"api_tool_info": {
"id": "text",
"server_url_with_path": "text",
"method": "text",
"path": "text",
"description": "text",
"parameters": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
}
],
"connections": [
{
"connection_type_id": "text",
"provider_id": "text",
"name": "text",
"description": "text",
"labels": [
"text"
],
"params": [
{
"label": "text",
"type": "string",
"placeholder": "text",
"default": 1,
"help": "text",
"url": "text",
"required": true,
"name": "text"
}
],
"minimum_plan": "text",
"color": "#A3A3A3",
"is_marketing_stunt": false,
"connection_type": "credentials"
}
],
"deprecation_info": {
"date_will_be_removed": "text",
"instructions": "text"
},
"openapi_schema": "text",
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
]Get all providers with tools created by StackAI's team.
Args: minimal: Whether to return minimal schema or not
Returns: List of providers with tools created by StackAI's team
falseSuccessful Response
Validation Error
GET /tools/stackai/providers HTTP/1.1
Host: api.stack-ai.com
Accept: */*
[
{
"provider_id": "text",
"provider_version": "text",
"provider_group": [
"LLM"
],
"name": "text",
"description": "text",
"icon": "text",
"tags": [
"text"
],
"labels": [
"text"
],
"color": "#A3A3A3",
"triggers": 1,
"actions": 1,
"deprecation_info": {
"date_will_be_removed": "text",
"instructions": "text"
},
"openapi_schema": "text",
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
]Successful Response
Validation Error
GET /tools/stackai/providers/{provider_id} HTTP/1.1
Host: api.stack-ai.com
Accept: */*
{
"provider_id": "text",
"provider_version": "text",
"provider_group": [
"LLM"
],
"name": "text",
"description": "text",
"icon": "text",
"tags": [
"text"
],
"color": "#A3A3A3",
"triggers": [
{
"trigger_id": "text",
"provider_id": "text",
"name": "text",
"description": "text",
"instructions": "text",
"input_params": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"output_params": [
{
"label": "text",
"type": "text",
"llm_description": "text",
"human_description": "text",
"name": "text"
}
],
"api_tool_info": {
"id": "text",
"server_url_with_path": "text",
"method": "text",
"path": "text",
"description": "text",
"parameters": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
}
],
"actions": [
{
"action_id": "text",
"provider_id": "text",
"name": "text",
"description": {
"human": "text",
"llm": "text"
},
"tags": [
"text"
],
"input_params": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"output_params": [
{
"label": "text",
"type": "text",
"llm_description": "text",
"human_description": "text",
"name": "text"
}
],
"api_tool_info": {
"id": "text",
"server_url_with_path": "text",
"method": "text",
"path": "text",
"description": "text",
"parameters": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
}
],
"connections": [
{
"connection_type_id": "text",
"provider_id": "text",
"name": "text",
"description": "text",
"labels": [
"text"
],
"params": [
{
"label": "text",
"type": "string",
"placeholder": "text",
"default": 1,
"help": "text",
"url": "text",
"required": true,
"name": "text"
}
],
"minimum_plan": "text",
"color": "#A3A3A3",
"is_marketing_stunt": false,
"connection_type": "credentials"
}
],
"deprecation_info": {
"date_will_be_removed": "text",
"instructions": "text"
},
"openapi_schema": "text",
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}Get all integration IDs available, with trigger and action IDs.
Used to generate integrations documentation without fetching all the data, which is very heavy.
Successful Response
GET /tools/stackai/integrations HTTP/1.1
Host: api.stack-ai.com
Accept: */*
Successful Response
[
{
"provider_id": "text",
"triggers": [
"text"
],
"actions": [
"text"
]
}
]Get the data for a specific native action available and implemented by StackAI.
Successful Response
Validation Error
GET /tools/stackai/providers/{provider_id}/actions/{action_id} HTTP/1.1
Host: api.stack-ai.com
Accept: */*
{
"action_id": "text",
"provider_id": "text",
"name": "text",
"description": {
"human": "text",
"llm": "text"
},
"tags": [
"text"
],
"input_params": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"output_params": [
{
"label": "text",
"type": "text",
"llm_description": "text",
"human_description": "text",
"name": "text"
}
],
"api_tool_info": {
"id": "text",
"server_url_with_path": "text",
"method": "text",
"path": "text",
"description": "text",
"parameters": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
}Get the data for a specific native trigger available and implemented by StackAI.
Successful Response
Validation Error
GET /tools/stackai/providers/{provider_id}/triggers/{trigger_id} HTTP/1.1
Host: api.stack-ai.com
Accept: */*
{
"trigger_id": "text",
"provider_id": "text",
"name": "text",
"description": "text",
"instructions": "text",
"input_params": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"output_params": [
{
"label": "text",
"type": "text",
"llm_description": "text",
"human_description": "text",
"name": "text"
}
],
"api_tool_info": {
"id": "text",
"server_url_with_path": "text",
"method": "text",
"path": "text",
"description": "text",
"parameters": [
{
"label": "text",
"type": "text",
"form": "text",
"required": true,
"llm_description": "text",
"human_description": "text",
"name": "text",
"placeholder": "text",
"min": 1,
"max": 1,
"options": [],
"default": null,
"has_dynamic_options": false,
"depends_on": [
"text"
]
}
],
"headers": [
{
"order": 1,
"key": "text",
"value": "text"
}
]
}
}Run an action.
Successful Response
Validation Error
POST /tools/stackai/providers/{provider_id}/actions/{action_id}/run HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69
{
"project_id": "text",
"inputs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}Get the input parameters for an action as a JSON schema.
Successful Response
Validation Error
GET /tools/stackai/providers/{provider_id}/actions/{action_id}/inputs HTTP/1.1
Host: api.stack-ai.com
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}Get the output parameters for an action as a JSON schema.
Successful Response
Validation Error
GET /tools/stackai/providers/{provider_id}/actions/{action_id}/outputs HTTP/1.1
Host: api.stack-ai.com
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}Get the icon for a specific provider.
Successful Response
Validation Error
GET /tools/stackai/providers/{provider_id}/icon HTTP/1.1
Host: api.stack-ai.com
Accept: */*
No content
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
Successful Response
Validation Error
POST /tools/options HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 157
{
"config_name": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"connection_id": "text",
"provider_id": "text",
"action_id": "text",
"trigger_id": "text"
}[
{
"value": "text",
"label": "text"
}
]Last updated
Was this helpful?

