API-Intents
User Guide: Getting Started with API Bot
API Bot simplifies your API lifecycle by enabling seamless testing, exploration, and workflow creation. Follow this guide to make the most of its features.
❗ Important
Using a Swagger Document to Access Features
To access all features, attach a valid Swagger document.
A valid Swagger file should contain a maximum of 12–14 APIs.
URL is mandatory in the
serverssection for executing mock APIs.Without a server URL, you can still:
Analyze APIs
Create workflows
No Swagger File? No Problem! 👍
Our API Builder offers an AI-powered solution for generating Swagger files effortlessly. Simply provide descriptions of your APIs, and the Builder will generate:
A downloadable Swagger JSON
API definitions with relevant examples
The API Builder also includes a mock API hosting option, ensuring a seamless development and testing experience. For more details, refer to the API Builder Guide.
🔍 Analyze APIs
Attach the Swagger file, and use the term Analyze in the input field, followed by your request to evaluate specific APIs or analyze all APIs in the document.
Example Prompt:
Video Demonstration
Refer to the video below for a walkthrough of API analysis:
The video highlights key aspects, including:
Rating: Assessing API reliability and performance.
Justification: Providing reasoning for the assigned ratings.
Recommendations: Suggesting improvements for API functionality.
Personas for Testing: Identifying user types and scenarios to test each API in your Swagger document.
📝 API Workflows
To generate recommended workflows, include the term workflow in the input field, followed by your any specific request. These workflows deliver exceptional precision and reliability, streamlining your execution strategy.
Example Prompt:
Video Demonstration
Watch the video below for a detailed walkthrough of recommended API workflows:
The video highlights key aspects, including:
Workflow Name: Descriptive titles for each workflow.
Sequence of API Calls: The order in which APIs are invoked.
Purpose: The goal of each workflow.
Expected Output: Anticipated results from the workflow execution.
Visual Representation: Includes Mermaid diagrams for a clear understanding of the workflow.
📝 Note
The analysis and workflows are strictly limited to the APIs present in the attached Swagger file.
New APIs outside of the file cannot be analyzed, nor can workflows be recommended for them.
Only one workflow can be executed at a time.
🎭 Execute APIs
To execute APIs, include the term Execute in your input request, clearly specifying the desired API or workflow. The API Bot will guide you by prompting for any missing information, ensuring the request is fully prepared before execution.
To execute APIs, you have two powerful options:
Custom API Execution Define the specific sequence of APIs you wish to execute. The API Bot ensures seamless execution by prompting for any missing details, guaranteeing accuracy and completeness.
Automated Workflow Execution Utilize the API Bot’s intelligently generated workflows, crafted to optimize complex operations by integrating multiple APIs into a cohesive process
❗ Important Ensure to provide body parameters for POST calls and query parameters for GET calls when required.
📚 Examples
Example Prompt 1 : Custom API Execution
The APIs used for this example are shown below:
Video Demonstration
Watch the video below for a detailed execution of the above example prompt:
Test Validations
The Test Reasoning includes the following validations:
Example Prompt 2: Automated Workflow Execution
The APIs used for this example are shown below:
These are the generated recommended workflows from API Bot:
Video Demonstration
Watch the video below for a detailed execution of the above example prompt:
📝 Note
Does not create new APIs—only works with the existing APIs.
Executes only one workflow at a time.
Ensure consistent and accurate values for proper functioning of the API, including attention to case sensitivity
Return to API Bot Documentation.
Last updated