Skip to content

Validate SKILL.md content

POST
/v1/skills/validate
curl --request POST \
--url https://app.everruns.com/api/v1/skills/validate \
--header 'Content-Type: application/json' \
--data '{ "skill_md": "---\nname: refund-policy\ndescription: Issue refunds inside the policy window.\n---\n\nUse this when a customer asks for a refund within 30 days of purchase." }'
Media type application/json

Request to validate a SKILL.md

object
skill_md
required

Full SKILL.md content to validate, including the YAML frontmatter and the markdown body.

string
Example
---
name: refund-policy
description: Issue refunds inside the policy window.
---
Use this when a customer asks for a refund within 30 days of purchase.

Validation result

Media type application/json

Validation result for SKILL.md

object
description

Parsed skill description. None when not present in the input or unparseable.

string | null
errors

Hard validation errors. Non-empty if and only if valid is false.

Array<string>
name

Parsed skill slug from the front matter. None when the input could not be parsed enough to extract a name.

string | null
valid
required

true when the candidate SKILL.md parsed and passes all hard checks; false if any error was found.

boolean
warnings

Non-fatal warnings (style, deprecated patterns, optional fields missing). Emitted alongside a valid result.

Array<string>
Example generated
{
"description": "example",
"errors": [
"example"
],
"name": "example",
"valid": true,
"warnings": [
"example"
]
}