enonic-api-reference

Resolve Enonic XP library function signatures, parameters, return types, and examples.

1|Updated Mar 28, 2026
One-click install
npx skills add https://github.com/webmaxru/enonic-agent-skills --skill enonic-api-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: enonic-api-reference
Source: https://github.com/webmaxru/enonic-agent-skills/tree/main/skills/enonic-api-reference
Command: npx skills add https://github.com/webmaxru/enonic-agent-skills --skill enonic-api-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

This skill provides a definitive source of truth for Enonic XP server-side API references across lib-auth, lib-content, lib-node, lib-portal, lib-context, lib-event, lib-task, lib-io, lib-mail, lib-repo, and lib-schema. It documents function signatures, parameters, return types, and usage examples to accelerate development and reduce lookup friction.

Core Features & Use Cases

  • Reference extraction for Enonic XP libs with accurate function signatures, import blocks, and types.
  • Usage examples demonstrating common patterns across libraries and recommended import blocks.
  • Cross-library assistance for end-to-end tasks like content creation, authentication, and content querying, with guidance on version compatibility.

Quick Start

Analyze a target function from an XP library and return its signature, parameters, return type, and a minimal working example.

Frequently Asked Questions about enonic-api-reference

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find the function signature and parameters for Enonic XP lib-portal?

To find the Enonic XP lib-portal function signature and parameters, query the API reference to extract exact import blocks, parameter tables, return types, and minimal working examples directly from official reference files.

What is the correct import block and return type for lib-content functions in Enonic XP?

The correct import block and return type for lib-content functions in Enonic XP are documented in the API reference, which provides structured details including function signatures, parameter types, and usage examples for content operations.

Does the Enonic XP API reference cover lib-auth, lib-node, and lib-task libraries?

Yes, the Enonic XP API reference covers lib-auth, lib-node, lib-task, lib-content, lib-portal, lib-context, lib-event, lib-io, lib-mail, lib-repo, and lib-schema, providing accurate function signatures and usage examples across all these server-side libraries.

How do I get usage examples for lib-context in Enonic XP server-side development?

To get usage examples for lib-context in Enonic XP server-side development, request the API reference details to receive a minimal working example alongside the function signature, parameter table, and return type extracted from the official documentation.

Can I use the Enonic XP API reference to check version compatibility for lib-io functions?

Yes, you can use the Enonic XP API reference to check version compatibility for lib-io functions, as it notes specific XP version requirements from the official docs when extracting function signatures, parameters, and return types.

Are there limitations when querying cross-library tasks like content creation and authentication in Enonic XP?

Cross-library tasks like content creation and authentication in Enonic XP have no documented limitations in the reference; it provides end-to-end guidance across libraries with accurate function signatures, import blocks, and version compatibility notes.