Get a skill

client.promptly.skills.retrieve(, ?): Skill { id, content, name, 11 more }

GET/api/promptly/skills/{skillId}

Get a skill

ParametersExpand Collapse

skillID: string

formatuuid

ReturnsExpand Collapse

Skill { id, content, name, 11 more }

id: string

formatuuid

content: string

Markdown instructions that guide task execution

name: string

category?: string

createdAt?: string

formatdate-time

description?: string

frontmatter?: Frontmatter { author, requiredSources, tags }

Skill metadata

author?: string

requiredSources?: Array<string>

Source slugs this skill depends on

tags?: Array<string>

iconUrl?: string

formaturi

isPublic?: boolean

Whether the skill is shared publicly

isUserInvocable?: boolean

Whether users can manually attach this skill

organizationId?: string

formatuuid

slug?: string

URL-friendly identifier

updatedAt?: string

formatdate-time

version?: number

Get a skill

import _0ct from '0ct';

const client = new _0ct({
  apiKey: process.env['0CT_API_KEY'], // This is the default and can be omitted
});

const skill = await client.promptly.skills.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(skill.id);

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "content": "content",
  "name": "name",
  "category": "category",
  "createdAt": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "frontmatter": {
    "author": "author",
    "requiredSources": [
      "string"
    ],
    "tags": [
      "string"
    ]
  },
  "iconUrl": "https://example.com",
  "isPublic": true,
  "isUserInvocable": true,
  "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "slug": "slug",
  "updatedAt": "2019-12-27T18:11:19.117Z",
  "version": 0
}

Returns Examples

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "content": "content",
  "name": "name",
  "category": "category",
  "createdAt": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "frontmatter": {
    "author": "author",
    "requiredSources": [
      "string"
    ],
    "tags": [
      "string"
    ]
  },
  "iconUrl": "https://example.com",
  "isPublic": true,
  "isUserInvocable": true,
  "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "slug": "slug",
  "updatedAt": "2019-12-27T18:11:19.117Z",
  "version": 0
}