Back to Autogpt

System Library Operations

docs/integrations/block-integrations/system/library_operations.md

0.6.443.1 KB
Original Source

System Library Operations

<!-- MANUAL: file_description -->

Blocks for managing agents in your personal AutoGPT library.

<!-- END MANUAL -->

Add To Library From Store

What it is

Add an agent from the store to your personal library

How it works

<!-- MANUAL: how_it_works -->

This block copies an agent from the public store into your personal library using its store_listing_version_id. Optionally provide a custom agent_name to rename it in your library.

The block returns the library entry ID and agent graph ID, which can be used to execute the agent or manage your library.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
store_listing_version_idThe ID of the store listing version to add to librarystrYes
agent_nameOptional custom name for the agent in your librarystrNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
successWhether the agent was successfully added to librarybool
library_agent_idThe ID of the library agent entrystr
agent_idThe ID of the agent graphstr
agent_versionThe version number of the agent graphint
agent_nameThe name of the agentstr
messageSuccess or error messagestr

Possible use case

<!-- MANUAL: use_case -->

Agent Provisioning: Automatically add recommended agents to a user's library.

Onboarding Flows: Set up a user's library with starter agents during onboarding.

Dynamic Agent Access: Add agents on-demand when users request specific capabilities.

<!-- END MANUAL -->

List Library Agents

What it is

List all agents in your personal library

How it works

<!-- MANUAL: how_it_works -->

This block retrieves all agents stored in your personal library. Use search_query to filter by name, and limit/page for pagination through large libraries.

Results include each agent's metadata and are output both as a complete list and individually for iteration.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
search_queryOptional search query to filter agentsstrNo
limitMaximum number of agents to returnintNo
pagePage number for paginationintNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
agentsList of agents in the libraryList[LibraryAgent]
agentIndividual library agent (yielded for each agent)LibraryAgent
total_countTotal number of agents in libraryint
pageCurrent page numberint
total_pagesTotal number of pagesint

Possible use case

<!-- MANUAL: use_case -->

Agent Selection: Display available agents for users to choose from in a workflow.

Library Management: Build interfaces for users to manage and organize their agent library.

Agent Inventory: Check what agents are available before deciding which to execute.

<!-- END MANUAL -->