API reference
Skill
The document an agent host reads before it calls anything else. Served as markdown, with no key, because an agent that cannot read its instructions until it holds a key cannot follow them.
GET /v1/skill
The skill text
Returns the customer skill as markdown: how to authenticate, what each capability does, and the rules an agent is expected to follow. No key is needed, because an agent that cannot read its instructions until it holds a key cannot follow them.
Parameters
None.
Request body
None.
Example request
curl
curl -sS -X GET "https://api.afaprotocol.com/v1/skill"Python
import requests
API = "https://api.afaprotocol.com"
r = requests.get(f"{API}/v1/skill", timeout=30)
r.raise_for_status()
print(r.json())Example response
HTTP 200
"# AFA Protocol skill for agent hosts\\n\\nAn agent acted at 03:12. ..."Errors
| Status | Code | Meaning |
|---|---|---|
| 503 | skill_text_unavailable | The skill text is not present in this deployment. Nothing is generated in its place. |
What would show this is false
Fetch it with no key and with one, and compare. Only the title line and the first heading differ, and they carry your organisation's name when a key is sent. The same bytes are served at /docs/skill.md.