Skip to main content

Create an Action

Creating an action in TaskingAI is a straightforward process, whether you prefer using the user interface (UI) or a client SDK. Here's a guide to help you through both methods:

Bulk Create on Console​

  1. Navigate to the Project page then go to the Tools tab.
  2. Select the action subpage and click the new action button.
  3. Enter the OpenAPI Json schema to describe the API. If you are not familiar with OpenAPI Json schema, you can visit OpenAPI Json Schema reference for more information.
  4. Choose the appropriate Authentication type for the API and set up credentials if necessary.
  5. Click the confirm button.

create-an-action

note

For the schema with multiple paths and methods, multiple actions will be created, each containing only one path and method. The operationId and description fields in each endpoint method are required as they are used as the name and description of the tool.

Here are some important schema considerations when creating an action:

  • Adherence to OpenAPI Specifications: Ensure your schema follows these standards.
  • Server URL: Include one server URL per action.
  • Method Description: This will be used as the action's description.
  • Action Name: Defined by the operationId in the schema.
  • Completeness: Ensure operationId and description are fully detailed.
  • Handling Multiple Paths/Methods: TaskingAI creates separate actions for each path/method.

Authentication​

Now we support NONE, BASIC, BEARER or CUSTOM authentication types. Please configure your authentication type and credentials accordingly.