Moss

Moss Control Plane API

REST control plane that powers all index lifecycle operations for Moss. Every action is multiplexed through a single authenticated POST /v1/manage endpoint (initUpload, startBuild, getJobStatus, getIndex, listIndexes, deleteIndex, getIndexUrl, addDocs, deleteDocs, getDocs), authenticated with an x-project-key header and x-service-version: v1.

GitHub

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/moss/refs/heads/main/authentication/moss-authentication.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/moss/refs/heads/main/conventions/moss-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/moss/refs/heads/main/errors/moss-error-codes.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/moss/refs/heads/main/data-model/moss-data-model.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/moss/refs/heads/main/lifecycle/moss-lifecycle.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/moss/refs/heads/main/apis.yml

API entry from apis.yml

apis.yml Raw ↑ 
name: Moss Control Plane API
description: 'REST control plane that powers all index lifecycle operations for Moss. Every action is
  multiplexed through a single authenticated POST /v1/manage endpoint (initUpload, startBuild, getJobStatus,
  getIndex, listIndexes, deleteIndex, getIndexUrl, addDocs, deleteDocs, getDocs), authenticated with an
  x-project-key header and x-service-version: v1.'
humanURL: https://docs.moss.dev/docs/api-reference/v1/getting-started/introduction
baseURL: https://service.usemoss.dev/v1
properties:
- type: Authentication
  url: authentication/moss-authentication.yml
- type: Conventions
  url: conventions/moss-conventions.yml
- type: ErrorCatalog
  url: errors/moss-error-codes.yml
- type: DataModel
  url: data-model/moss-data-model.yml
- type: Lifecycle
  url: lifecycle/moss-lifecycle.yml