Skip to content

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

Get a note

Updated 2026-10-19

GET/notes/{id}View examples

Read as Markdown

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

This reference is generated from the OpenAPI description. It shows the operation contract; follow any related guides below for task steps and context.

OpenAPI for this operation: Download JSON.

GET /notes/{id}

Get a note

Read a saved note from this fictional API.

Servers

https://api.example.test

Parameters

`id` (path)

Required

string

Known note ID: "note_123"

Responses

200: OK

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.

404: Not Found

application/json

No note has that ID.

object

2 properties

code string always present ⓘ
message string always present ⓘ

Prepare a note request — Prepare a fictional note payload and follow its linked operation contracts.

API data

Type placeholders show the JSON structure. Required and optional fields are described in the reference.

Response 200 · application/json

{
  "id": "string",
  "text": "string",
  "createdAt": "string (date-time)",
  "archivedAt": "string | null (date-time)",
  "author": {
    "id": "string",
    "displayName": "string"
  },
  "tags": [
    "string"
  ],
  "metadata": {
    "source": "string",
    "pinned": "boolean"
  }
}

Response 404 · application/json

{
  "code": "string",
  "message": "string"
}

Examples from OpenAPI. Generated samples have not been executed.

Example request

Language

curl --request GET \
  --url 'https://api.example.test/notes/YOUR_ID'

const response = await fetch("https://api.example.test/notes/YOUR_ID", {
  method: "GET"
});

const data = await response.json();
console.log(data);

// Node.js 18 or newer provides a global fetch.
const response = await fetch("https://api.example.test/notes/YOUR_ID", {
  method: "GET"
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.example.test/notes/YOUR_ID"

response = requests.get(url)
print(response.json())

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.example.test/notes/YOUR_ID", nil)
	if err != nil {
		panic(err)
	}
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.example.test/notes/YOUR_ID"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

<?php

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.example.test/notes/YOUR_ID',
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true
]);

$response = curl_exec($ch);
curl_close($ch);
echo $response;

require 'net/http'
require 'uri'

uri = URI('https://api.example.test/notes/YOUR_ID')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)

response = http.request(request)
puts response.body

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.example.test/notes/YOUR_ID");
        var response = await client.SendAsync(request);
        Console.WriteLine(await response.Content.ReadAsStringAsync());
    }
}

Response 200 · application/json

Available examples: Retrieved release note

Retrieved release notesaved

200 · application/json

Authored in OpenAPI

{
  "id": "note_123",
  "text": "Review the release candidate.",
  "createdAt": "2026-10-18T09:30:00Z",
  "archivedAt": null,
  "author": {
    "id": "usr_42",
    "displayName": "Morgan Lee"
  },
  "tags": [
    "release",
    "review"
  ],
  "metadata": {
    "source": "release-checklist",
    "pinned": true
  }
}

Link to this example