Skip to main content

Projects

A project is the top-level container in BasePeak.AI. It groups together an agent, its knowledge, tasks, and conversation history into a single workspace that users interact with.

Project and agent relationship​

Every project is backed by exactly one agent. The agent holds the instructions, tools, capabilities, and model configuration. The project wraps that agent and controls who can access it, how it is shared, and which conversations (threads) belong to it.

When an administrator creates an agent, BasePeak.AI automatically creates a corresponding project. Users open the project to start chatting; they interact through the agent's configuration without needing to know or change the agent directly.

What a project contains​

ComponentDescription
AgentThe AI configuration powering the project (instructions, tools, capabilities)
ThreadsEach conversation a user has with the agent (see Threads)
TasksScheduled or event-triggered workflows defined on the agent (see Tasks)
KnowledgeDocuments and sources the agent can query
Workspace filesFiles the agent and users can share and edit interactively

Sharing and access​

Projects have a share status that controls visibility:

  • Private — accessible only to users who have been explicitly granted access
  • Public — accessible to any authenticated user in the platform
  • Featured — accessible to any authenticated user and highlighted in the project catalog

Administrators can manage share status from the Projects admin view. A project can also have members: users who have been granted access to a private project.

Spawned projects​

When a user forks a project (for example, to customize an agent for their own use), BasePeak.AI creates a spawned project with a parentID pointing to the original. Spawned projects are collapsed in the admin project list by default; enable the "Show derived projects" toggle to expand them — they then render nested under their parent, whose name is carried in its own column. A project that is being deleted stays visible regardless of that toggle's state. This is useful for auditing user customizations.

API access​

Projects created through the OpenAI-compatible /v1 API endpoints have no parent project — the API key carries an agent scope directly. Threads from these API calls appear in the admin chat-threads list labeled API in the project column.