Skip to content
Navigation

Get a skill by key

Get a single skill (preset or owned) by its key. 404 if not found.

When the user owns a skill with the same key as a preset, the user's skill wins; within each tier an app-scoped row wins over a global one (standard override semantics).

GET
https://truememory-api.mvstg.com/skills/by-key/{key}
View as Markdown

Authorization

  • HTTPBearerHTTPrequired

Path parameters

  • keystringrequired

Query parameters

  • app_idoptional

    App scope: prefer this app's row over a global one.

    One of the following:

    • string
    • null

Header parameters

  • X-On-Behalf-Ofoptional

    One of the following:

    • string
    • null
  • X-External-User-Idoptional

    One of the following:

    • string
    • null
  • X-App-Idoptional

    One of the following:

    • string
    • null

Returns

200

Successful Response

JSON
  • idstringrequired
  • user_idrequired

    Owner user_id, NULL for presets.

    One of the following:

    • string
    • null
  • app_idsrequired

    Apps this skill is assigned to. NULL means all apps (global/unscoped).

    One of the following:

    • array<string>
    • null
  • keystringrequired
  • namestringrequired
  • descriptionrequired

    One of the following:

    • string
    • null
  • promptstringrequired
  • categoryrequired

    Freeform grouping label (legacy string). Distinct from categories.

    One of the following:

    • string
    • null
  • iconrequired

    One of the following:

    • string
    • null
  • argument_hintrequired

    One of the following:

    • string
    • null
  • allowed_toolsarray ofstringrequired
  • metadataobjectrequired
  • is_presetbooleanrequired
  • is_activebooleanrequired
  • sort_orderintegerrequired
  • forked_from_skill_idrequired

    One of the following:

    • string
    • null
  • usage_countintegerrequired

    Global invocation count, bumped via POST /skills/{id}/usage.

  • last_used_atrequired

    When the skill was last invoked, NULL if never.

    One of the following:

    • string
    • null
  • parent_synced_atrequired

    For forks: the preset updated_at this fork is synced to. The fork is stale when its preset's updated_at is newer. NULL for non-forks.

    One of the following:

    • string
    • null
  • created_atstringrequired
    format: date-time
  • updated_atstringrequired
    format: date-time
  • app_idrequired

    DEPRECATED, read app_ids instead. Legacy single-app scalar derived from app_ids for pre-multi-app consumers: the first app id, or null for all apps. Lossy for multi-app skills.

    One of the following:

    • string
    • null
  • categoriesoptionalarray ofobject

    Category entities assigned via the registry. Returned by the list endpoints, the single-skill reads (user and admin) and PUT /admin/skills/{skill_id}/categories; omitted by writes.

    • idstringrequired
    • namestringrequired
  • use_caseoptional

    When this skill applies, in natural language. Read by skill selection.

    One of the following:

    • string
    • null
  • detection_patternsoptional

    Example utterances that should invoke this skill.

    One of the following:

    • array<string>
    • null
  • licenseoptional

    SKILL.md license: a license name, or the file in the skill that holds it.

    One of the following:

    • string
    • null
  • compatibilityoptional

    SKILL.md compatibility: what the skill needs to run (product, packages, network).

    One of the following:

    • string
    • null

422

Validation Error
JSON
  • detailoptionalarray ofobject
    • locarray ofrequired

      One of the following:

      • string
      • integer
    • msgstringrequired
    • typestringrequired
    • inputoptionalunknown
    • ctxoptionalobject

Type to search…

↑↓ navigate↵ selectEsc close