skills - Omni Docs

Defines a set of instructions for the Omni Agent that users can trigger with a button click. Skills can be defined at the topic level (in topic files) or at the model level (in model files). When triggered, the AI follows those instructions — querying data, summarizing results, interacting with the user, or walking through a multi-step process — all without the user needing to write a prompt. Each defined skill will display as a button in the Omni Agent. See the Agent Skills guide for more information about this feature, including use cases and best practices.

Syntax

skills:
  <skill_id>:
    label: <string>
    input: |
      <string>
    description: |
      <string>
    required_access_grants: [ <access_grant_name> ]

Properties

skills

object

required

A map of skills, each defined with a unique skill_id.

Hide skill properties

skill_id

string

required

A unique name for the skill. Use underscores for spaces.

Hide skill_id properties

label

string

required

The display name shown on the skill button. Keep this short — aim for 2-4 words that clearly describe the task.

input

string

An opening message that sets the initial interaction. This is sent to the AI before the description and is useful for:

Greeting the user and explaining what the skill does
Asking the user for input before proceeding (e.g., an account name or date range)

When input is set, the AI will typically respond to the input first, then use the description as its instructions for the rest of the conversation.

description

string

required

The instructions sent to the AI when the skill is triggered. This can range from a single sentence to a detailed, multi-step prompt with specific output formats, decision logic, and references to topics.Write this as if you’re instructing an analyst: be specific about which data to query, how to structure the output, and what steps to follow.

required_access_grants

string[]

Controls skill visibility based on user access grants. Skills with this parameter will only appear to users who hold the required access grants.Values must match access_grants defined in the model file. Supports conditional grant expressions using | for OR and & for AND conditions.Note: This controls visibility only. Actual data access at execution time is still enforced by access grants on the underlying topics, fields, and views the skill touches.

Examples

See the Agent Skills guide for additional examples.

Topic-level skill

skills:
  top_customers_in_region:
    label: Top Customers
    description: >
      Find the top 20 customers by total lifetime revenue in this region.
      Include customer name, total revenue, order count,
      and date of most recent order. Sort by revenue descending.

Skill with required access grants

skills:
  finance_summary:
    label: Finance Summary
    description: >
      Generate a financial summary including revenue, costs, and margins.
    required_access_grants: [ finance ]

Skill with conditional access grants

skills:
  regional_analysis:
    label: Regional Analysis
    description: >
      Analyze performance metrics for the user's assigned region.
    required_access_grants: [ northwest_region|southwest_region ]

Documentation Index

​Syntax

​Properties

​Examples

Syntax

Properties

Examples