Skip to content

Latest commit

 

History

History

README.md

Umbraco.AI.Prompt

A prompt template management add-on for Umbraco.AI that provides storage, organization, and management of AI prompt templates with full backoffice integration.

Features

  • Prompt Management - Store and manage AI prompt templates with full CRUD operations
  • Profile Integration - Link prompts to Umbraco.AI profiles for consistent configuration
  • Tag Organization - Organize prompts using tags for easy categorization
  • Backoffice UI - Full management interface integrated into Umbraco
  • Management API - RESTful API for prompt CRUD operations
  • Alias Support - Access prompts by GUID or URL-safe alias

Monorepo Context

This package is part of the Umbraco.AI monorepo. For local development, see the monorepo setup instructions in the root README.

Installation

dotnet add package Umbraco.AI.Prompt

This meta-package includes all required components. For more control, install individual packages:

Package Description
Umbraco.AI.Prompt.Core Domain models and service interfaces
Umbraco.AI.Prompt.Web Management API controllers
Umbraco.AI.Prompt.Web.StaticAssets Backoffice UI components
Umbraco.AI.Prompt.Persistence EF Core persistence
Umbraco.AI.Prompt.Persistence.SqlServer SQL Server migrations
Umbraco.AI.Prompt.Persistence.Sqlite SQLite migrations

Requirements

  • Umbraco CMS 17.0.0+
  • Umbraco.AI 1.0.0+
  • .NET 10.0

Prompt Model

A Prompt represents a stored prompt template:

Property Description
Id Unique identifier (GUID)
Alias URL-safe unique identifier
Name Display name
Description Optional description
Content The prompt template text
ProfileId Optional link to Umbraco.AI profile
Tags Categorization tags
IsActive Whether the prompt is available for use

Management API

All endpoints are under /umbraco/ai/management/api/v1/prompts/:

Method Endpoint Description
GET / List all prompts (paged)
GET /{idOrAlias} Get prompt by ID or alias
GET /profile/{profileId} Get prompts by profile
POST / Create prompt
PUT /{idOrAlias} Update prompt
DELETE /{idOrAlias} Delete prompt

The {idOrAlias} parameter accepts either a GUID or a string alias.

Documentation

License

This project is licensed under the MIT License. See LICENSE.md for details.