Skip to content

CatchTheTornado/open-agents-builder-docs

Repository files navigation

Open Agents Builder Documentation

Welcome to the Open Agents Builder documentation repository. This repository contains comprehensive guides and API documentation to help you understand and utilize the Open Agents Builder platform effectively.

Table of Contents

Introduction

Open Agents Builder is a platform designed to help you create, manage, and deploy intelligent agents. This documentation provides all the necessary information to get started and make the most out of the platform.

Guides

Creating Your First Agent

Learn how to create your first agent using the Open Agents Builder platform. This guide will walk you through the process step-by-step. Read more

Custom Entities and API Endpoints

This guide explains how to add new entities and API endpoints to manage them within your Next.js + Drizzle + TypeScript setup. Read more

New Tool Integration

A step-by-step guide on how to extend Open Agents Builder by adding new custom AI tools. Read more

API Documentation

Agent Management API

Comprehensive REST API documentation for managing agents, including creating, updating, and deleting agents. Read more

Attachments Management API

Detailed documentation on how to manage attachments, including creating, updating, and retrieving binary files. Read more

Order Management API

REST API documentation for managing orders in your e-commerce schema, including creating, updating, and deleting orders. Read more

Product Management API

Documentation for managing products through the API, including creating, updating, and deleting products. Read more

Audit Log API

API documentation for managing audit logs, including creating and retrieving logs. Read more

Stats API

Documentation for tracking usage metrics such as prompt/completion tokens and aggregated monthly stats. Read more

Executing Flow via API

A guide on how to execute a Flow-type agent via the API, including details of the FlowChunkType and FlowChunkEvent interfaces. Read more

Extensibility

Adding New Entity and API Endpoint

Learn how to add new entities and API endpoints to manage them within your application. Read more

Adding New Tool Integration

A guide on how to add new custom AI tools to let the AI integrate with third-party systems. Read more

Contributing

We welcome contributions to improve the documentation and the platform!

License

This project is licensed under the MIT License.

About

Docs for Open Agents Builder

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published