Meow Meow Scratch® developer documentation

export MEOW_API="https://meowmeowscratch.com/api"
export MEOW_APP_API_KEY="YOUR_APP_API_KEY"
export MEOW_USERNAME="YOUR_USERNAME"

GET /api/v1/{username}/{app}/{endpoint}/
GET /api/v1/{username}/{app}/{endpoint}/{record_uuid}/
GET /api/v2/dashboards/{share_token}/


# Public reads omit the header; replace these slugs with a public app and endpoint
curl "$MEOW_API/v1/$MEOW_USERNAME/YOUR_PUBLIC_APP/YOUR_PUBLIC_ENDPOINT/"


# Supply a token for a private consumer endpoint
curl "$MEOW_API/v1/$MEOW_USERNAME/weather-station/readings/" \
  -H "Authorization: Bearer $MEOW_APP_API_KEY"

{
  "count": 1,
  "limit": 100,
  "offset": 0,
  "fields": [
    {"name": "temperature", "label": "Temperature", "field_type": "number"}
  ],
  "records": [
    {"uuid": "…", "data": {"temperature": 22.5}, "created_at": "…"}
  ]
}

export RECORD_UUID="UUID_FROM_THE_POST_RESPONSE"


curl -i -X PATCH "$MEOW_API/apps/weather-station/endpoints/readings/records/$RECORD_UUID/"   -H "Authorization: Bearer $MEOW_APP_API_KEY"   -H "Content-Type: application/json"   -d '{"data":{"temperature":23.0}}'


curl -i -X DELETE "$MEOW_API/apps/weather-station/endpoints/readings/records/$RECORD_UUID/"   -H "Authorization: Bearer $MEOW_APP_API_KEY"

curl -X POST "$MEOW_API/apps/weather-station/endpoints/readings/records/batch/" \
  -H "Authorization: Bearer $MEOW_APP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"records":[
    {"data":{"temperature":21.8}},
    {"data":{"temperature":21.9}}
  ]}'

{
  "data": {
    "camera": {
      "thresholds": {"confidence": 0.65}
    }
  },
  "updated_at": "2026-07-25T10:00:00Z"
}

pip install meow-sdk


export MEOW_PLATFORM_API_KEY="YOUR_PLATFORM_TOKEN"
export MEOW_APP_API_KEY="YOUR_APP_API_KEY"
export MEOW_USERNAME="YOUR_USERNAME"
# Optional for a self-hosted or local backend:
export MEOW_URL="https://meowmeowscratch.com"

from meow_sdk import Meow
import os


api = Meow(api_key=os.environ["MEOW_PLATFORM_API_KEY"])


api.create_app("Weather Station", "weather-station", is_public=True)
api.create_endpoint(
    "weather-station",
    "Readings",
    "readings",
    endpoint_type="collection",
    is_public=True,
)
api.create_field(
    "weather-station",
    "readings",
    "temperature",
    "Temperature",
    "number",
    required=True,
    options={"min": -50, "max": 80, "step": 0.1},
)


created = api.send(
    "weather-station",
    "readings",
    {"temperature": 22.5},
)
api.send_many(
    "weather-station",
    "readings",
    [{"temperature": 22.6}, {"temperature": 22.7}],
)


page = api.records("weather-station", "readings", limit=25)
api.update(
    "weather-station",
    "readings",
    created["uuid"],
    {"temperature": 23.0},
)
print(page["results"])

api.create_endpoint(
    "weather-station", "Device Settings", "settings", endpoint_type="static"
)
api.set_payload("weather-station", "settings", {
    "camera": {"thresholds": {"confidence": 0.65}}
})
settings = api.get_payload("weather-station", "settings")


api.create_dashboard("Camera Controls", "camera-controls")
widget = api.create_dashboard_widget(
    "camera-controls",
    "weather-station",
    "settings",
    "camera.thresholds.confidence",
    "slider",
    "Tracking confidence",
    config={"min": 0, "max": 1, "step": 0.05},
)
api.set_dashboard_widget_value("camera-controls", widget["uuid"], 0.7)

from meow_sdk import Meow


public = Meow(username="YOUR_USERNAME")


readings = public.get(
    "weather-station",
    "readings",
    temperature__gte=20,
    limit=25,
)
stats = public.aggregate(
    "weather-station",
    "readings",
    ["avg", "max"],
    field="temperature",
)
csv_text = public.export_csv("weather-station", "readings")

from meow_sdk.exceptions import (
    AuthError,
    MeowError,
    NotFoundError,
    RateLimitError,
    ValidationError,
)


try:
    api.send("weather-station", "readings", {"temperature": "hot"})
except ValidationError as exc:  # HTTP 400
    print(exc.code, exc.field, exc.hint)
except AuthError:               # HTTP 401 or 403
    print("Check the token and resource access")
except NotFoundError:           # HTTP 404
    print("Check the app and endpoint slugs")
except RateLimitError:          # HTTP 429
    print("Retry with backoff")
except MeowError as exc:
    print(f"Request failed: {exc}")

meow apps
meow endpoints weather-station
meow fields weather-station readings
meow limits
meow send weather-station readings temperature=22.5
meow send-batch weather-station readings @records.json
meow records weather-station readings --limit 25
meow get weather-station readings temperature__gte=20
meow payload-get weather-station status
meow payload-get weather-station status --metadata
meow logs weather-station readings
meow webhooks weather-station readings
meow dashboards
meow widget-create camera-controls weather-station settings \
  camera.thresholds.confidence slider "Tracking confidence" \
  --config '{"min":0,"max":1,"step":0.05}'
meow widget-set camera-controls WIDGET_UUID 0.7
meow --help

export MEOW_PLATFORM_API_KEY="YOUR_PLATFORM_TOKEN"

codex mcp add meow \
  --url https://meowmeowscratch.com/mcp/ \
  --bearer-token-env-var MEOW_PLATFORM_API_KEY


codex mcp list

{
  "mcpServers": {
    "meow": {
      "type": "http",
      "url": "https://meowmeowscratch.com/mcp/",
      "headers": {
        "Authorization": "Bearer ${MEOW_PLATFORM_API_KEY}"
      }
    }
  }
}