Create a workspace skill
Create a workspace skill with the FLORA API: POST /workspaces/{workspaceId}/skills.
Creates a new skill in the workspace named in the path. Mutating public API requests support an optional Idempotency-Key header for client retries; duplicate keys within two hours return idempotency_duplicate.
POST https://app.flora.ai/api/v1/workspaces/{workspaceId}/skillsAuth: API key as a bearer token,
Authorization: Bearer $FLORA_API_KEY. See Authentication.TypeScript SDK:
client.workspaces.skills.create().Idempotency: optional
Idempotency-Keyheader. See Idempotency.Operation ID:
createWorkspaceSkill.
Example
curl -X POST 'https://app.flora.ai/api/v1/workspaces/ws_abc123/skills' \
-H "Authorization: Bearer $FLORA_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"name": "Brand Voice",
"description": "Writes in our brand voice.",
"body": "# Brand Voice\nWrite warmly and plainly."
}'import { FloraClient } from '@flora-ai/flora';
const client = new FloraClient({ apiKey: process.env['FLORA_API_KEY'] });
const skill = await client.workspaces.skills.create({
workspaceId: 'ws_abc123',
name: 'Brand Voice',
description: 'Writes in our brand voice.',
body: '# Brand Voice\nWrite warmly and plainly.',
});
console.log(skill);Path parameters
workspaceId
string
Yes
Workspace identifier. Pattern: ^ws_\S+$. Example: ws_abc123.
Request body
Required.
name
string
Yes
Skill name. 1 to 80 characters. Example: Brand Voice.
description
string
Yes
Skill description. At most 240 characters. Example: Writes in our brand voice..
body
string
Yes
Skill body. 1 to 8000 characters. Example: # Brand Voice Write warmly and plainly..
thumbnail_video_url
string
No
Skill thumbnail video URL
thumbnail_image_url
string
No
Skill thumbnail image URL
Responses
201: Skill created.
skill_id
string
Yes
Skill identifier. Pattern: ^skill_\S+$. Example: skill_abc123.
workspace_id
string
Yes
Workspace identifier. Pattern: ^ws_\S+$. Example: ws_abc123.
slug
string
Yes
Skill URL slug. Example: brand-voice.
name
string
Yes
Skill name. Example: Brand Voice.
description
string
Yes
Skill description. Example: Writes in our brand voice..
thumbnail_video_url
string
No
Skill thumbnail video URL
thumbnail_image_url
string
No
Skill thumbnail image URL
Errors
Every error has the same body: error.code, error.message, and error.fields on validation errors. See Errors for how to recover from each code.
400
invalid_json, input_validation_error
The body isn't valid JSON, or an input failed validation (fields lists each one).
401
unauthorized, invalid_api_key
The API key is missing, invalid or revoked.
402
insufficient_credits
The workspace balance is too low for this request.
403
forbidden, paid_plan_required
The key can't do this, or the workspace plan doesn't include it.
404
not_found
The resource doesn't exist or isn't visible to this key.
409
idempotency_duplicate, revision_conflict
Duplicate Idempotency-Key or a stale base_revision.
429
rate_limited
Too many requests. Back off and retry.
500
unknown_error, internal_error
Something failed on FLORA's side. Retry with backoff.
503
temporarily_unavailable
Authorization is temporarily unavailable. Retry later.
Last updated
Was this helpful?