OKF examples

OKF Examples

Copy practical Open Knowledge Format examples for APIs, datasets, metrics, runbooks, and product documentation.

Developers looking for OKF API examples.

API Endpoint OKF Example

A single endpoint reference page for agent-readable API documentation.

---
type: api_reference
id: api-endpoint
title: "API Endpoint OKF Example"
description: "A single endpoint reference page for agent-readable API documentation."
tags: [api, openapi, reference]
---

# Create Customer Endpoint

Creates a customer record and returns the canonical customer ID.

## Request

POST /v1/customers

Required JSON fields:

- email: customer email address
- name: display name

## Response

Returns 201 with id, email, name, and created_at.

Open dedicated page

Data teams documenting catalogs for agents.

Dataset OKF Example

A dataset entry with ownership, schema notes, and update cadence.

---
type: dataset
id: dataset
title: "Dataset OKF Example"
description: "A dataset entry with ownership, schema notes, and update cadence."
tags: [dataset, catalog, analytics]
---

# Revenue Events Dataset

Revenue Events stores normalized billing events used by finance dashboards and forecasting jobs.

## Owner

Data Platform team.

## Freshness

Updated hourly from the billing warehouse.

## Fields

- event_id: stable event identifier
- account_id: customer account identifier
- amount_usd: normalized revenue amount
- occurred_at: event timestamp

Open dedicated page

Analytics teams standardizing AI-readable metric definitions.

Metric OKF Example

A metric definition with formula, caveats, and business usage.

---
type: metric
id: metric
title: "Metric OKF Example"
description: "A metric definition with formula, caveats, and business usage."
tags: [metric, analytics, semantic-layer]
---

# Net Revenue Retention

Net Revenue Retention measures expansion and contraction in existing customer revenue.

## Formula

(Starting MRR + Expansion MRR - Contraction MRR - Churned MRR) / Starting MRR

## Usage

Use NRR for cohort-level retention analysis and investor reporting.

## Caveats

Exclude trial accounts and one-time services revenue.

Open dedicated page

DevOps teams turning operational knowledge into OKF.

Runbook OKF Example

A production incident runbook formatted for agent workflows.

---
type: runbook
id: runbook
title: "Runbook OKF Example"
description: "A production incident runbook formatted for agent workflows."
tags: [runbook, incident, devops]
---

# API Latency Incident Runbook

Use this runbook when p95 API latency exceeds 900ms for more than five minutes.

## Triage

1. Check current deploy status.
2. Inspect database connection saturation.
3. Compare cache hit rate with the previous hour.

## Rollback

Rollback the latest deploy if latency rose within 15 minutes of release.

## Escalation

Page the platform owner when error rate exceeds 2%.

Open dedicated page

SaaS teams publishing agent-readable product docs.

Product Docs OKF Example

A product capability page with concise scope and workflow guidance.

---
type: product_doc
id: product-docs
title: "Product Docs OKF Example"
description: "A product capability page with concise scope and workflow guidance."
tags: [product-docs, saas, support]
---

# Workspace Invitations

Workspace Invitations let administrators invite teammates by email and assign default roles.

## Availability

Available on Team and Enterprise plans.

## Workflow

1. Open Settings.
2. Select Members.
3. Enter email addresses.
4. Choose a role.
5. Send invitations.

## Permissions

Only owners and administrators can invite new members.

Open dedicated page

Related OKF tools and guides

OKF Validator Website to OKF Generator OpenAPI to OKF Converter OKF vs JSON-LD OKF vs OpenAPI

FAQ

What are okf examples for?

They give developers a copy-ready starting point for publishing typed, agent-readable Markdown files.

Can I edit the frontmatter?

Yes. Keep type non-empty, then add fields such as title, description, id, tags, source_url, and owner as needed.

How should I validate a copied file?

Paste it into the OKF Validator before publishing or committing it to a knowledge bundle.