Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.aui.io/llms.txt

Use this file to discover all available pages before exploring further.

Upcoming Mid April 2026
The Agent Builder API lets you programmatically create and configure AI agents that combine LLM reasoning with rule-based control. Define what your agent knows, what it can do, and exactly how it should behave — all through a REST API.

Environments & Base URLs

EnvironmentOuter Bridge APIAgent SettingsKBM (RAG)API Workflow
Staginghttps://api-staging.internal-aui.io/api/outer-bridgehttps://api-staging.internal-aui.io/v3-1/agent-settingshttps://api-staging.internal-aui.io/knowledge-base-manager/v1https://api-staging.internal-aui.io/api/api-workflow
ProductionSame as stagingSame as stagingSame as stagingSame as staging

URL Structure & Routing

The API is organized across four services, each with its own base URL and routing conventions:
ServiceURL PrefixRoute PatternDescription
Outer Bridge/api/outer-bridge/identity/*, /network/v1/*Authentication, organizations, accounts, networks, API keys. All entity management routes are under /network/v1/.
Agent Settings V2/v3-1/agent-settings/v1/agent-tools/*, /v1/parameters/*, /v1/integrations/*, /v1/scope-entities/*Agent configuration CRUD. All routes are versioned under /v1/.
Knowledge Base Manager/knowledge-base-manager/v1/knowledge-bases, /bulk/*RAG operations. Single resources under /knowledge-bases, batch operations under /bulk/.
API Workflow/api/api-workflow/v1/api-integration/*Integration generation.

Best Practices — URLs & Routing

  • Always use the full base URL — Each service has a distinct base path. Don’t assume all endpoints share the same prefix. For example, /identity/user/login goes through Outer Bridge while /v1/agent-tools goes through Agent Settings.
  • Note the version in the URL — Agent Settings uses /v3-1/agent-settings/v1/ (service version v3-1, API version v1). Don’t confuse the two. The outer v3-1 is the service deployment version; the inner v1 is the API contract version.
  • Route naming conventions — Outer Bridge uses kebab-case for paths (/api-key, /check-availability). Agent Settings uses kebab-case (/agent-tools, /general-settings). Knowledge Base Manager uses kebab-case (/knowledge-bases). Stay consistent with these conventions when constructing URLs.
  • Path parameters use IDs, not names — Routes like /network/v1/network/{networkId} and /v1/agent-tools/{toolName} look similar but use different identifiers. Networks use MongoDB ObjectIds; tools and parameters use their code/name string. Check the endpoint docs for which identifier to use.
  • Query parameters carry scope — Agent Settings endpoints require network_id, account_id, organization_id, and network_category_id as query parameters, not path segments. Always include all four to avoid scope resolution errors.
  • Use staging URLs for development — Both staging and production currently point to the same infrastructure, but this will change. Build your integration against the staging URL and switch to production only for release.
  • /bulk/* routes are for batch operations — Knowledge Base Manager separates single-resource routes (/knowledge-bases) from batch routes (/bulk/files, /bulk/websites, /bulk/export, /bulk/import). Use bulk routes for multi-file operations.

API Sections

Authentication

Authentication headers for all API services.

Identity & Auth

Email check, OTP login, logout.

Organizations

List and retrieve organizations.

Accounts

List, create, and retrieve accounts.

Networks (Agents)

List, create, and retrieve agents. Manage API keys.

Agent Settings — Read

Fetch general settings, parameters, entities, integrations, tools, and rules.

Agent Settings — Write

Create, update, and delete agent configuration.

Knowledge Bases (RAG)

Manage knowledge bases, upload files, scrape websites, export/import.

API Workflow

Generate integrations from cURL commands.

Local Serve API

Routes exposed by aui serve for local development.