Skip to content

Get a workspace skill

GET
/workspaces/{workspaceId}/skills/{skillId}
import { FloraClient } from '@flora-ai/flora';
const client = new FloraClient({ apiKey: process.env['FLORA_API_KEY'] });
const skill = await client.workspaces.skills.retrieve({
workspaceId: '<workspaceId>',
skillId: '<skillId>',
});
console.log(skill);

Returns a single workspace skill with its body when it is accessible to the authenticated public API key. Missing and inaccessible skills both return 404.

Error responses use the standard error body.

workspaceId
required

Workspace identifier

string
/^ws_\S+$/

Workspace identifier

skillId
required

Skill identifier

string
/^skill_\S+$/

Skill identifier

Skill returned.

Media type application/json
object
skill_id
required

Skill identifier

string
/^skill_\S+$/
workspace_id
required

Workspace identifier

string
/^ws_\S+$/
slug
required

Skill URL slug

string
name
required

Skill name

string
description
required

Skill description

string
thumbnail_video_url

Skill thumbnail video URL

string
thumbnail_image_url

Skill thumbnail image URL

string
body
required

Skill body

string
>= 1 characters
Example
{
"skill_id": "skill_abc123",
"workspace_id": "ws_abc123",
"slug": "brand-voice",
"name": "Brand Voice",
"description": "Writes in our brand voice.",
"body": "# Brand Voice\nWrite warmly and plainly."
}