Agent Guides
Connectivity
Actions
18 min
configure actions to enable the ai assistant to perform specific tasks or integrate with external apis by defining each actionβs properties, behaviors, and authentication, you ensure seamless interaction between the assistant and any external services overview in the actions section, you can manually create new actions by specifying names, targets, properties, and behaviors import openapi schemas to automatically generate actions from an existing api specification edit, remove, or secure existing actions with built in authentication options actions summary 1\ importing an openapi schema import openapi click on import openapi schema select your schema format (e g , yaml , json ) paste your openapi schema into the editor click convert schema to parse and auto generate actions β οΈ ensure your openapi document is valid and servers information is accessible through the internet 2\ creating or editing an action 2 1 basic information basic information action name unique identifier (e g , get doctors by specialization ) target type choose between api (external endpoint) or agent (local function) http method get, post, put, etc target uri api endpoint url description brief explanation of the action rules (optional) constraints for execution (e g , "do not set time of day unless explicitly stated") response prompt instructions for how to phrase returned results loading text message shown while action is being executed additional properties toggle on to send custom params send metadata toggle on to include session context 2 2 authentication choose an authentication method required by the external api 2 2 1 basic auth basic authentication username api user credential password api password 2 2 2 bearer token bearer authentication key access token string (e g , eyjhbgcioijiuz ) 2 2 3 custom header custom authentication header name (e g , x api key ) key secret value for the header π‘ choose authentication that matches your external system's requirement always handle secrets securely 2 3 action properties action properties each action may include multiple input properties that define how users will provide required parameters property name (e g , specialization ) property type string, number, boolean, etc location body, query, header, etc required parameter toggle on to enforce input enum (optional) set of allowed values description context for what the parameter represents use update action to save your changes 3\ managing actions save all changes applies updates to the action configuration delete action use the red trash icon to remove an unused action (irreversible) re import openapi refresh or generate actions from new schemas β οΈ ensure you save all changes to make all the configurations updated into the system best practices β
use clear and descriptive names for actions and properties π secure tokens and secrets when using authentication π use enums to guide user input and prevent api failures π document rules and usage for easier collaboration π§ͺ test actions regularly for validity and uptime next steps after defining actions review agent dialog settings to control how and when actions are triggered use agent behavior to link user prompts to specific actions monitor performance and update configurations as your system evolves