PromptFloe Developer Docs
API reference

Skills

The /v1/skills resource — invoke critique skills and augmenters. The endpoints unify both kinds; the response shape differs by kind.

#List built-in skills

GET/v1/skills

Returns every built-in skill grouped by pack. For workspace-scoped custom skills, see Custom skills.

#Run a skill

POST/v1/skills/run

Streaming endpoint. Use the SDK's skills.run for one-shot collection or skills.runStream for live streaming.

FieldTypeDescription
aliasrequiredstringSkill alias without prefix. /roast → "roast".
appIdstringRun against an app you own.
chatIdstringRun within an existing chat. Result appears as a chat message.
urlstringRun against a public URL.
textstringRun against raw text.
argsstringFree-form additional arguments.
dryRunbooleanAugmenters only: run without writing files.
forcebooleanAugmenters only: ignore idempotency markers.

#Run an augmenter

POST/v1/augmenters/run

Sugar over /v1/skills/run that asserts the alias is an augmenter (returns 400 otherwise). Same request/response shape; recommended for client code that's specifically applying patches so the type signature is narrower.

curl https://api.promptfloe.com/v1/augmenters/run \
  -H "Authorization: Bearer $PROMPTFLOE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"alias":"seo","appId":"app_abc"}'

#Get a run

GET/v1/runs/:id

Returns the persisted record of a completed (or in-flight) run.

#Cancel a run

POST/v1/runs/:id/cancel

See Cancellation for the full guide including quota refund policy.

#Rollback an augmenter

POST/v1/runs/:id/rollback

Reverts an applied augmenter — restores the file states from before the run. Available for 24 hours after the run.

#Where to go next

PromptFloe developer docs