Shoalrun documentation framework
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
API reference

Create a note

Preview an API operation page built from a small, fictional OpenAPI file.

Updated
POST/notesView examples
Read as Markdown

Fictional API example. This page demonstrates documentation features; its operations do not describe a live service.

This page is a live example of an API reference generated by Shoalrun. The source OpenAPI file defines one fictional operation; this introduction is authored in MDX. The build combines them into the operation details below and the example panel on the right.

Example only: The Notes API is fictional. These requests are examples, not calls to a live service.

OpenAPI for this operation: Download JSON.

POST /notes

Create a note

Save a short note in this fictional API.

Servers

https://api.example.test

Request body

Required.

application/json

object

1 property

  • text string required ⓘ

    maxLength: 280

    The note to save.

Responses

201: Created

application/json

The saved note.

A saved note with its author, labels, and display metadata.

7 properties

  • id string always present ⓘ

    The generated note ID.

  • text string always present ⓘ

    maxLength: 280

    The saved text.

  • createdAt string always present ⓘ

    format: date-time

    When the note was created.

  • archivedAt string always present nullable ⓘ

    format: date-time

    When the note was archived, or null while active.

  • author object always present ⓘ

    The person who created the note.

    2 properties

    • id string always present ⓘ

      The author's user ID.

    • displayName string always present ⓘ

      The author's display name.

  • tags list of string may be absent ⓘ

    Labels used to organize the note.

    Array items:

    string

  • metadata object may be absent ⓘ

    Optional display information for a note.

    2 properties

    • source string may be absent ⓘ

      Where the note came from.

    • pinned boolean may be absent ⓘ

      Whether the note stays at the top.