Skip to main content
The Yertle API is a REST API that follows standard conventions:
  • Base URL (production): https://api.yertle.com
  • Base URL (development): https://api-dev.yertle.com
  • Authentication: JWT bearer tokens (see Authentication)
  • Content type: application/json

How to read this reference

The reference pages in this section are auto-generated from the OpenAPI spec at openapi.json. For each endpoint you’ll see:
  • HTTP method and path
  • Path and query parameters
  • Request body schema with examples
  • Response schemas for each status code
  • An interactive playground (if you provide a token)

Endpoint groups

Endpoints are organized by resource:
GroupDescription
AuthenticationLogin, signup, token refresh
OrganizationsList, create, inspect orgs; manage members and invites
NodesCreate, read, update, delete nodes; push state
BranchesCreate branches, switch between branches, list branch heads
Pull RequestsOpen, review, merge, close PRs
DirectoriesManage directory structure within an org
SearchFull-text and tag-based search across nodes
Node HistoryView commit history for a node
GraphCross-node relationship queries
NotificationsUser notification feed

Conventions

  • All IDs are UUIDs
  • All timestamps are ISO 8601 in UTC
  • Pagination uses limit and offset query parameters
  • Errors follow RFC 7807 Problem Details format

Reference implementations

The Yertle CLI and Yertle MCP server are both open source and demonstrate real-world usage of every major endpoint group. Read their source code as living examples.