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

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

get

/tools/custom

HTTPcURLJavaScriptPython

GET /tools/custom HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

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 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

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

namestringRequired

iconany ofRequired

stringOptional

or

nullOptional

api_schemastringRequired

dereferenced_schemaanyRequired

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/tools/custom

HTTPcURLJavaScriptPython

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 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

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

provider_idstringRequired

Body

application/json

namestringRequired

iconany ofRequired

stringOptional

or

nullOptional

api_schemastringRequired

dereferenced_schemaanyRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

put

/tools/custom/{provider_id}

HTTPcURLJavaScriptPython

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 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

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

provider_idstringRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/tools/custom/{provider_id}

HTTPcURLJavaScriptPython

DELETE /tools/custom/{provider_id} HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Get Stackai Tools

get

Responses

200

Successful Response

application/json

get

/tools/stackai

HTTPcURLJavaScriptPython

GET /tools/stackai HTTP/1.1
Host: api.stack-ai.com
Accept: */*

200

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 Stackai Actions

get

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

Responses

200

Successful Response

application/json

get

/tools/stackai/actions

HTTPcURLJavaScriptPython

GET /tools/stackai/actions HTTP/1.1
Host: api.stack-ai.com
Accept: */*

200

Successful Response

[
  {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
]

Get Stackai Triggers

get

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

Responses

200

Successful Response

application/json

get

/tools/stackai/triggers

HTTPcURLJavaScriptPython

GET /tools/stackai/triggers HTTP/1.1
Host: api.stack-ai.com
Accept: */*

200

Successful Response

[
  {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
]

Get Stackai Providers

get

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

Query parameters

minimalbooleanOptionalDefault: false

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/tools/stackai/providers

HTTPcURLJavaScriptPython

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"
      }
    ]
  }
]

Get Stackai Provider

get

Path parameters

provider_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/tools/stackai/providers/{provider_id}

HTTPcURLJavaScriptPython

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 Integrations

get

Get all integration IDs available, with trigger and action IDs.

Used to generate integrations documentation without fetching all the data, which is very heavy.

Responses

200

Successful Response

application/json

get

/tools/stackai/integrations

HTTPcURLJavaScriptPython

GET /tools/stackai/integrations HTTP/1.1
Host: api.stack-ai.com
Accept: */*

200

Successful Response

[
  {
    "provider_id": "text",
    "triggers": [
      "text"
    ],
    "actions": [
      "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

422

Validation Error

application/json

get

/tools/stackai/providers/{provider_id}/actions/{action_id}

HTTPcURLJavaScriptPython

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 Trigger By Provider And Id

get

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

Path parameters

provider_idstringRequired

trigger_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/tools/stackai/providers/{provider_id}/triggers/{trigger_id}

HTTPcURLJavaScriptPython

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 Action

post

Run an action.

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

provider_idstringRequired

action_idstringRequired

Body

application/json

project_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/tools/stackai/providers/{provider_id}/actions/{action_id}/run

HTTPcURLJavaScriptPython

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 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

422

Validation Error

application/json

get

/tools/stackai/providers/{provider_id}/actions/{action_id}/inputs

HTTPcURLJavaScriptPython

GET /tools/stackai/providers/{provider_id}/actions/{action_id}/inputs HTTP/1.1
Host: api.stack-ai.com
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

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

422

Validation Error

application/json

get

/tools/stackai/providers/{provider_id}/actions/{action_id}/outputs

HTTPcURLJavaScriptPython

GET /tools/stackai/providers/{provider_id}/actions/{action_id}/outputs HTTP/1.1
Host: api.stack-ai.com
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get Provider Icon

get

Get the icon for a specific provider.

Path parameters

provider_idstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/tools/stackai/providers/{provider_id}/icon

HTTPcURLJavaScriptPython

GET /tools/stackai/providers/{provider_id}/icon HTTP/1.1
Host: api.stack-ai.com
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

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

config_namestringRequired

parametersany ofOptional

or

nullOptional

connection_idany ofOptional

stringOptional

or

nullOptional

provider_idstringRequired

action_idany ofOptional

stringOptional

or

nullOptional

trigger_idany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/tools/options

HTTPcURLJavaScriptPython

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"
  }
]