Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.early-bird.space/llms.txt

Use this file to discover all available pages before exploring further.

Platform Reference

Early Bird currently exposes a small set of public read surfaces.

Dashboard

GET /api/dashboard Use this for:
  • overall counts
  • trend summaries
  • tag breakdowns
  • top organizations
  • top programs
Why use it first:
  • it is backed by a cached summary path
  • it is much cheaper than scanning row-level data
  • it answers many analytical questions in a single request

Projects

GET /api/projects?mode=page Supported concepts:
  • pagination
  • search query
  • sort
  • filters such as tag families, organization, organization category, location, and year
Use this when:
  • the dashboard is not specific enough
  • you need examples of actual projects
  • you need filtered project slices, not a full export

Programs

GET /api/programs?mode=page Use this when:
  • you want program-level ranking or browsing
  • you need to compare cohorts or program types
  • you need project references for a specific program

Organizations

GET /api/organizations?mode=page Use this when:
  • you want organization-level grouping
  • you need category or location exploration
  • you are comparing institutional coverage

Calendar

GET /api/calendar/events Use this when:
  • the question is time-sensitive
  • you need application windows, deadlines, or event timelines

API usage guidance

  • Prefer cached summary endpoints first.
  • Prefer paginated surfaces second.
  • Avoid unconstrained row scans.
  • Keep result sizes small unless the user explicitly needs exhaustive retrieval.

Public contract direction

The long-term plan is to add a dedicated /api/v1/agent/* layer for:
  • dataset catalog
  • schema description
  • conservative search tools
  • context-building helpers
Until then, the surfaces above are the supported read entrypoints for analysis workflows.