Skills

REST endpoints for skills. Bearer-auth required.

GET /api/skill-resources

List skill resources

Filter by skill_id and/or path. Pass both to look up a single resource by path (returns a 0/1-element array). When skill_id is omitted, only system admins can list (returns the full set across workspaces).

Query parameters

  • skill_id (optional): Filter to resources of this skill (id or name).
  • path (optional): Filter to a resource with this path. Combine with skill_id for a by-path lookup.

Response

JSON
{
  "data": [
    {
      "id": "<...>",
      "skillId": "<...>",
      "path": "<...>",
      "content?": "<...>"
    }
  ]
}

GET /api/skill-resources/{id}

Retrieve a single skill resource by ID.

Path parameters

  • id (required): Skill resource's prefixed ID (sklres_…).

Response

JSON
{
  "id": "string",
  "skillId": "string",
  "path": "string",
  "content?": "string"
}

GET /api/skills

List skills with pagination and optional filtering.

Query parameters

  • limit (optional): Page size (1–100, default 100).
  • after (optional): Keyset cursor — return the page after this row (next page).
  • before (optional): Keyset cursor — return the page before this row (prev page).
  • ids (optional): Comma-separated list of IDs. Narrows results to these IDs within the caller's accessible scope (does not bypass access checks).
  • filter (optional): Nested filter expression (<Entity>Filter): AND/OR/NOT + per-field comparison operators + relation traversal. JSON-encoded on the query string.
  • orderBy (optional): Multi-key sort (<Entity>OrderBy[]): array of { field: direction } applied in order. Directions: asc/desc plus the four explicit nulls variants. JSON-encoded on the query string.
  • workspace_id (optional): Filter to skills in this workspace. When omitted, returns skills across every workspace the caller is a member of (admins see all). System skills are always included.
  • source (optional): Narrow by source. workspace = this workspace's skills plus those visible via installed integrations; system = only global system skills; integration = only skills made visible by installed integrations; omit = union.
  • agent_id (optional): Filter to skills assigned to this agent (via the agent_skill join).
  • include_deleted (optional): Soft-deleted skill visibility. false (default) — active rows only. true — active plus soft-deleted. only — soft-deleted only.
  • name (optional): Case-insensitive substring match on name.
  • kind (optional): Shorthand: filter where kind equals this value.
  • target (optional): Shorthand: filter where target equals this value.
  • system (optional): Shorthand: filter where system equals this value.
  • created_by (optional): Shorthand: filter where createdBy equals this value.
  • retention_tier (optional): Shorthand: filter where retentionTier equals this value.

Response

JSON
{
  "data": [
    {
      "id": "<...>",
      "workspaceId": "<...>",
      "name": "<...>",
      "description": "<...>",
      "kind": "<...>",
      "target": "<...>",
      "body": "<...>",
      "system": "<...>",
      "resources?": "<...>",
      "createdBy": "<...>",
      "deletedAt": "<...>",
      "retentionTier": "<...>",
      "createdAt": "<...>",
      "updatedAt": "<...>"
    }
  ],
  "pageInfo": {
    "total": "number",
    "hasNextPage": "boolean",
    "hasPreviousPage": "boolean",
    "startCursor": "string",
    "endCursor": "string"
  }
}

POST /api/skills

Create skill

Request body

JSON
{
  "workspaceId": "string",
  "name": "string",
  "description?": "string",
  "kind": "concept | procedure",
  "target": "assistant | mcp | cli",
  "body": "string",
  "resources?": [
    {
      "path": "<...>",
      "content": "<...>"
    }
  ]
}

Response

JSON
{
  "id": "string",
  "workspaceId": "string",
  "name": "string",
  "description": "string",
  "kind": "concept | procedure",
  "target": "assistant | mcp | cli",
  "body": "string",
  "system": "boolean",
  "resources?": ["<...>"],
  "createdBy": "string",
  "deletedAt": "string",
  "retentionTier": "any",
  "createdAt": "string",
  "updatedAt": "string"
}

GET /api/skills/{id}

Get a single skill by ID.

Path parameters

  • id (required): Skill ID (skl_...) or name

Response

JSON
{
  "id": "string",
  "workspaceId": "string",
  "name": "string",
  "description": "string",
  "kind": "concept | procedure",
  "target": "assistant | mcp | cli",
  "body": "string",
  "system": "boolean",
  "resources?": ["<...>"],
  "createdBy": "string",
  "deletedAt": "string",
  "retentionTier": "any",
  "createdAt": "string",
  "updatedAt": "string"
}

PATCH /api/skills/{id}

Update skill

Path parameters

  • id (required): The skill's prefixed ID (e.g. skl_...).

Request body

JSON
{
  "name?": "string",
  "description?": "string",
  "kind?": "concept | procedure",
  "target?": "assistant | mcp | cli",
  "body?": "string",
  "resources?": [
    {
      "path": "<...>",
      "content": "<...>"
    }
  ]
}

Response

JSON
{
  "id": "string",
  "workspaceId": "string",
  "name": "string",
  "description": "string",
  "kind": "concept | procedure",
  "target": "assistant | mcp | cli",
  "body": "string",
  "system": "boolean",
  "resources?": ["<...>"],
  "createdBy": "string",
  "deletedAt": "string",
  "retentionTier": "any",
  "createdAt": "string",
  "updatedAt": "string"
}

DELETE /api/skills/{id}

Soft-delete a skill.

Path parameters

  • id (required): Skill to soft-delete.

Response

JSON
{
  "success": "boolean"
}

DELETE /api/skills/{id}/purge

Permanently delete a soft-deleted skill.

Path parameters

  • id (required): Soft-deleted skill to permanently delete.

Response

JSON
{
  "success": "boolean"
}

POST /api/skills/{id}/restore

Restore a soft-deleted skill.

Path parameters

  • id (required): Soft-deleted skill to restore.

Response

JSON
{
  "id": "string",
  "workspaceId": "string",
  "name": "string",
  "description": "string",
  "kind": "concept | procedure",
  "target": "assistant | mcp | cli",
  "body": "string",
  "system": "boolean",
  "resources?": ["<...>"],
  "createdBy": "string",
  "deletedAt": "string",
  "retentionTier": "any",
  "createdAt": "string",
  "updatedAt": "string"
}