Getting Started Guide
Ready to see the magic happen? Here’s your step-by-step guide to turning documentation into code in minutes.
Enter Documentation URL
In the Execution Channel, enter the main URL for the API documentation you want to process.
https://docs.example.com/api/introductionDiscover Endpoints
Click the "Discover Endpoints" button. The tool will find all available endpoints and recommend a set to start with in the endpoint selection dialog.
Analyze & Generate
Select the endpoints you want to process and click "Analyze & Generate Artifacts". The AI will begin processing, and you'll see the Schema Canvas update in real-time.
Review & Refine
Once complete, inspect the generated schema and functions. Use the "Show/Edit Code" dialog to make manual tweaks or use the "Improve with AI" feature to refine the relationships.
Iterate
To process more endpoints, open the endpoint selection dialog again. Previously processed endpoints will be marked. Select new ones and click the "Analyze & Generate" button to add them to your existing schema and function list.
Configuration
Fine-tuning your experience is simple. Here’s how you can configure API Forge to work just the way you like it.
API Key Management
The application requires a Google AI API key to function. This key must be set in an environment variable named GOOGLE_API_KEY. You can create a `.env.local` file in the root of the project to store this key securely.
Securing Your API Key
Admin Mode
Toggling "Admin Mode" in the header reveals a "History" button and an Activity Log panel at the bottom of the Schema Canvas. This powerful feature provides a detailed log of all system actions, which is invaluable for debugging. For a complete guide, please see the dedicated Interaction History section.