OKF templates

Copy-ready Open Knowledge Format templates.

Start with practical OKF files for APIs, runbooks, and support knowledge. Each template includes required type metadata, useful tags, and agent-readable sections.

API Endpoint OKF Template

Use this template to document one API endpoint with auth, inputs, outputs, examples, and failure cases.

---
type: api-endpoint
title: Create Customer
description: Creates a customer record and returns the created customer ID.
resource: https://api.example.com/docs/customers#create
tags:
  - api
  - customers
timestamp: 2026-06-27
---

# Create Customer

## Purpose
Use this endpoint when an agent needs to create a new customer after collecting required profile fields.

## Request
- Method: POST
- Path: /v1/customers
- Required fields: name, email

## Response
Returns the created customer ID, status, and timestamps.

## Failure Cases
- 400 when required fields are missing.
- 409 when the email already exists.

Incident Runbook OKF Template

Structure operational runbooks so agents can retrieve symptoms, checks, escalation paths, and recovery steps.

---
type: runbook
title: API Latency Spike Runbook
description: Steps for diagnosing and responding to elevated API latency.
tags:
  - runbook
  - api
  - latency
timestamp: 2026-06-27
---

# API Latency Spike Runbook

## Symptoms
- P95 latency above target for 10 minutes.
- Customer reports mention slow saves or timeout errors.

## First Checks
1. Check current deploy status.
2. Review database saturation.
3. Compare error rate with traffic volume.

## Recovery
Rollback recent deploys if latency started after release. Escalate to database owner if saturation remains high.

Support Knowledge Base OKF Template

Package support answers with symptoms, decision points, customer-safe wording, and escalation guidance.

---
type: support-article
title: Reset a Locked Account
description: Customer-safe steps for account lockout recovery.
tags:
  - support
  - account
  - login
timestamp: 2026-06-27
---

# Reset a Locked Account

## When To Use
Use when the customer cannot log in because the account is locked after failed attempts.

## Steps
1. Confirm the customer owns the email address on the account.
2. Send the password reset link.
3. Ask the customer to wait five minutes before retrying.

## Escalate
Escalate when the reset email does not arrive or the account remains locked after reset.