OKF example

API Endpoint OKF Example

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

Copy-ready Markdown

Developers looking for OKF API examples.

---
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.

Related OKF tools and guides

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

FAQ

Is this example valid OKF?

Yes. The generated Markdown includes the required type frontmatter and supporting metadata.

Can I use this in production?

Use it as a starting point, then edit the domain-specific facts before publishing.

What should I do next?

Validate the file, add ownership/source metadata, and link it from a bundle index or documentation hub.