> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.
# Get a skill
>
This endpoint is currently in development and may change.
Retrieve a skill by its UUID.
## OpenAPI
````yaml /api/openapi.yaml get /v1/skills/{skillId}
openapi: 3.1.0
info:
title: Omni API
description: >
The Omni REST API provides programmatic access to your Omni instance for
managing users, documents, queries, schedules, and more.
version: 1.0.0
contact:
name: Omni Support
url: https://docs.omni.co
servers:
- url: https://{instance}.omniapp.co/api
description: Production
variables:
instance:
default: blobsrus
description: Your production Omni instance subdomain
- url: https://{instance}.playground.exploreomni.dev/api
description: Playground
variables:
instance:
default: blobsrus
description: Your playground Omni instance subdomain
security:
- bearerAuth: []
- orgApiKey: []
tags:
- name: Who Am I
description: Inspect your own user permissions
- name: AI
description: AI-powered query generation
- name: AI Credit Controls
description: Manage organization-level AI credit usage
- name: AI Credit Usage
description: Monitor AI credit usage
- name: AI Evals
description: >-
Manage prompt sets and runs used to score AI quality against curated
prompt suites.
- name: AI Model Suggestions
description: Manage AI-generated suggestions for shared models
- name: AI Routines
description: >-
Manage Routines, which are scheduled, recurring AI-powered tasks that run
automatically on your data
- name: Apps
description: Draft and publish app documents.
- name: Documents v2
description: >
A draft-based workflow for creating and editing documents: create a
document, patch a draft, then publish.
- name: Documents
description: Create, retrieve, and manage documents
- name: API Tokens
description: >-
Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
grants)
- name: Connections
description: Manage database connections
- name: Connection environments
description: Manage connection environments database connections
- name: Content
description: Unified content retrieval (documents and folders)
- name: Content migration
description: Export and import dashboards
- name: Content validator
description: Validate content against models and perform find/replace operations
- name: Dashboard downloads
description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
- name: Dashboard filters and controls
description: Read and update dashboard filter and control default values
- name: dbt
description: Manage dbt configuration for connections
- name: Document favorites
description: Favorite and unfavorite documents
- name: Document labels
description: Apply and manage labels on documents
- name: Document permissions
description: Manage document-level access
- name: Labels
description: |
Manage labels in the organization
- name: Folders
description: Create and organize content folders
- name: Folder labels
description: Apply and manage labels on folders
- name: Folder permissions
description: Manage folder-level access
- name: Jobs
description: Check status of asynchronous jobs
- name: Models
description: Create and manage data models
- name: Model branches
description: Manage model branches and merge changes
- name: Model git configuration
description: Manage git configuration for shared models
- name: Queries
description: Execute workbook queries
- name: Schedules
description: Create and manage scheduled tasks
- name: Schedule recipients
description: Manage schedule recipients
- name: Schema refresh schedules
description: Manage automated schema refresh schedules for connections
- name: Skills
description: >-
Manage skills, the saved slash-command instructions the Omni AI assistant
runs
- name: Topics
description: Retrieve topic information from models
- name: Uploads
description: Manage file uploads
- name: Users
description: Manage users
- name: User attributes
description: Manage user attribute definitions
- name: User groups
description: Manage user groups
- name: User model roles
description: Manage model and connection role assignments for users
- name: User group model roles
description: Manage model and connection role assignments for user groups
- name: Uploads
description: Manage CSV and spreadsheet uploads
paths:
/v1/skills/{skillId}:
get:
tags:
- Skills
summary: Get a skill
description: |
This endpoint is currently in development and may change.
Retrieve a skill by its UUID.
operationId: skillsGet
parameters:
- name: skillId
schema:
type: string
format: uuid
example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
required: true
description: Skill UUID
in: path
- name: userId
schema:
type: string
format: uuid
required: false
description: >
**Requires an Organization API key.** The membership ID of the user
to attribute the action to.
in: query
responses:
'200':
description: The requested skill
content:
application/json:
schema:
$ref: '#/components/schemas/Skill'
example:
id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
identifier: quarterly-report
name: Quarterly report
description: Summarizes the quarter and flags anything off trend.
body: Pull revenue by month for the last four quarters, then...
creator:
id: b2c3d4e5-f6a7-8901-bcde-f12345678901
name: Blob Ross
createdAt: '2026-01-15T10:00:00.000Z'
updatedAt: '2026-02-01T09:30:00.000Z'
'400':
description: Malformed `skillId` (must be a UUID)
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError400'
'403':
description: >
Skills are not enabled for the caller, or the skill belongs to
someone else and the caller is not an Organization Admin.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError403'
'404':
description: No skill with this ID in the organization.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError404'
security:
- bearerAuth: []
components:
schemas:
Skill:
type: object
properties:
createdAt:
$ref: '#/components/schemas/SkillCreatedAt'
creator:
$ref: '#/components/schemas/SkillCreator'
description:
$ref: '#/components/schemas/SkillDescription'
id:
$ref: '#/components/schemas/SkillId'
identifier:
$ref: '#/components/schemas/SkillIdentifier'
name:
$ref: '#/components/schemas/SkillName'
updatedAt:
$ref: '#/components/schemas/SkillUpdatedAt'
body:
$ref: '#/components/schemas/SkillBody'
required:
- createdAt
- creator
- description
- id
- identifier
- name
- updatedAt
- body
ApiError400:
type: object
properties:
detail:
type: string
description: Human-readable error message describing what went wrong.
status:
type: integer
description: HTTP status code of the error.
example: 400
required:
- detail
- status
ApiError403:
type: object
properties:
detail:
type: string
description: Human-readable error message describing what went wrong.
status:
type: integer
description: HTTP status code of the error.
example: 403
required:
- detail
- status
ApiError404:
type: object
properties:
detail:
type: string
description: Human-readable error message describing what went wrong.
status:
type: integer
description: HTTP status code of the error.
example: 404
required:
- detail
- status
SkillCreatedAt:
type: string
format: date-time
description: ISO 8601 timestamp of when the skill was created
example: '2026-01-15T10:00:00.000Z'
SkillCreator:
type: object
description: Details about the user that created the skill.
properties:
id:
type: string
nullable: true
format: uuid
description: >
Membership ID of the user that created the skill. Null when the
creator has no membership or pending invitation in the organization.
example: b2c3d4e5-f6a7-8901-bcde-f12345678901
name:
type: string
description: Display name of the user that created the skill.
example: Blob Ross
required:
- id
- name
SkillDescription:
type: string
minLength: 1
maxLength: 1024
description: >-
What the skill is for. Shown in the skills list, and given to the agent
when it chooses between skills.
example: Summarizes the quarter and flags anything off trend.
SkillId:
type: string
format: uuid
description: Unique identifier for the skill
example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
SkillIdentifier:
type: string
minLength: 1
maxLength: 48
pattern: ^[a-z0-9][a-z0-9-]*$
description: >-
Slash-command handle, stored without the slash. Lowercase letters,
numbers and hyphens, starting with a letter or number.
example: quarterly-report
SkillName:
type: string
minLength: 1
maxLength: 256
description: A human-readable name for the skill.
example: Quarterly report
SkillUpdatedAt:
type: string
format: date-time
description: ISO 8601 timestamp of the last time the skill was updated.
example: '2026-02-01T09:30:00.000Z'
SkillBody:
type: string
minLength: 1
maxLength: 20000
description: The instructions injected into the agent's context when the skill runs.
example: Pull revenue by month for the last four quarters, then...
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >
Can be either an [Organization API
Key](/api/authentication#organization-api-keys) or [Personal Access
Token (PAT)](/api/authentication#token-types).
Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
orgApiKey:
type: http
scheme: bearer
bearerFormat: JWT
description: >
Requires an [Organization API
Key](/api/authentication#organization-api-keys). Personal Access Tokens
(PATs) are not supported for this endpoint.
Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`
````