Platform Features & Actions Reference

This guide explains how to accomplish tasks in Forjinn using the platform UI and user-level features.

---

Authentication

• Generate/manage your API keys by navigating to Settings → API Keys.
• Login via SSO, username/password, or workspace invite as allowed for your organization.

---

Dashboard Navigation

The tile-based dashboard provides quick access to all major features:

• Chat Builder Tile - Create conversational AI agents quickly
• Visual Canvas Tile - Build complex drag-and-drop workflows
• API Gateway Tile - Manage API endpoints and configurations
• Agents Tile - View and manage all agents across frameworks
• Triggers Tile - Configure webhook, schedule, and event triggers
• Datasets Tile - Manage knowledge bases and document stores
• Marketplace Tile - Browse and install extensions and templates
• Settings Tile - Access platform configuration

---

Chat Builder

Forjinn's Chat Builder provides a streamlined interface for creating conversational AI agents:

• Create a New Agent: Click the Chat Builder tile, then "New Agent"
• Select Framework: Choose from Google ADK, CrewAI, AutoGen, or Standard (LangChain)
• Configure LLM: Select your model provider and specific model
• Add Tools: Attach pre-built tools (search, Gmail, APIs, etc.)
• Set System Prompt: Define your agent's behavior and personality
• Configure Memory: Enable conversation history and context retention
• Test: Use the integrated chat preview to test your agent
• Deploy: Publish your agent for use via chat interface or API Gateway

---

Managing Chatflows (Visual Canvas)

• Create a Chatflow: Go to Chatflows. Click "New Chatflow". Fill in the flow's details and save.
• Edit or Export: Select a chatflow from your list to view, edit, export, or duplicate.
• Import: In the Chatflows panel, click "Import" and upload your file (CSV/JSON supported).
• Run: Click "Run" on your flow to execute it and review the results in the dashboard.

---

Managing Agents

• View/Create/Edit Agents: Go to Agents from the dashboard tiles or left sidebar. Use the "New Agent" button or click any agent to update configuration and options.
• Select Framework: Choose between Google ADK, CrewAI, AutoGen, or Standard (LangChain) when creating or editing agents.
• Assign Agents to Chatflows: In a chatflow or workflow, drag your chosen agent into the canvas and connect it to the desired sequence of actions.
• Multi-Agent Teams: With CrewAI, define roles for each agent and coordinate task distribution.

---

API Gateway

The API Gateway centralizes management of REST endpoints for your flows and agents:

• Access: Navigate to the API Gateway tile on your dashboard
• Create Endpoints: Define new API endpoints that proxy to your flows or agents
• Authentication: Configure API keys, JWT tokens, or other auth methods per endpoint
• Rate Limiting: Set request limits to protect against abuse
• Transformations: Configure request/response transformations
• Monitoring: View traffic metrics, error rates, and latency per endpoint
• Documentation: Access auto-generated API docs for each endpoint

---

Predictions & Agent Runs

• Run a Workflow/Agent: Trigger by clicking "Run" in the UI. Enter your question or prompt and view live results.
• View Past Predictions: See history, outputs, and traces in the dashboard or under agent/chatflow details.
• Streaming: Enable streaming responses for real-time token output in Chat Builder sessions.

---

Triggers

Forjinn's Trigger system enables event-driven automation:

• Webhook Triggers: Send HTTP POST to external URLs on platform events
• Schedule Triggers: Run workflows on cron expressions or fixed intervals
• Event Triggers: Start flows based on platform events (completions, messages, errors)
• Dashboard Access: Navigate to the Triggers tile to create and manage triggers
• Event Filtering: Configure triggers for specific workspaces, users, or agent types
• Testing: Use built-in test functionality to verify trigger delivery

---

Data & Datasets

• Import or Create Dataset: Go to Datasets in the sidebar. Click "New Dataset" or "Import". Map columns and assign metadata.
• Attach to Models/Flows: In chatflow/agent setup, pick a dataset as knowledge source or for evaluation.

---

Credentials & Settings

• Manage platform credentials in Settings → Credentials.
• Add/update API or integration keys under Settings → API Keys.
• Adjust platform preferences and feature toggles via Settings → General Settings.

---

Logs & Audit Trails

• View system activity, user actions, and agent/workflow runs in Settings → Login Activity or Dashboard → Recent Activities.
• API Gateway logs include per-endpoint request/response tracking.

---

Roles, Users, & Workspaces

• Invite Users: Go to Admin → Manage Users or your workspace panel. Enter emails and assign roles.
• Manage Workspaces: Create, rename, or archive workspaces in the workspace control panel.
• Roles: Set/update user and workspace-level roles/permissions for collaboration and governance.

---

Webhooks & Notifications

• Set up webhooks at Settings → API/Webhooks. Use UI fields to add destination, select events, and enable/disable.
• Or use the Triggers tile for the modern trigger management interface.
• Review request logs, sent events, and delivery status in the webhook panel.

---

Streaming & Real-Time Features

• For streaming model outputs and real-time agent responses, use the UI options available under Prediction/Chatflow run panels.
• Chat Builder supports streaming responses for improved user experience.
• For notification integrations (Slack, email, custom endpoints), configure via Settings or Triggers.

---

Troubleshooting & Error Handling

• Errors, limits, and permissions are managed automatically by the platform. Contact support via the help link for issues.
• For usage limits, billing, or permissions, visit respective Settings panels.
• API Gateway errors include detailed status codes and upstream flow information.

---

For custom integrations or unique workflow needs, contact support or dev advocacy. All standard platform features are accessible from the UI; no manual API endpoint setup is required for typical workflows.