Logo

First steps

  • Getting Started with Sphinx
  • Getting Started with MkDocs
  • Importing Your Documentation
  • Read the Docs features
  • Choosing Between Our Two Sites

Getting started

  • Configuration File
  • Incoming Webhooks and Automation
  • Custom Domains and White Labeling
  • Versioned Documentation
  • Downloadable Documentation
  • Documentation Hosting Features
  • Server Side Search
  • Analytics
  • Preview Documentation from Pull Requests
  • Connecting Your VCS Account
  • Build Process
  • Badges
  • Site Support
  • Frequently Asked Questions

Step-by-step Guides

  • Sphinx & MkDocs Guides
  • Read the Docs Guides
  • Read the Docs for Business Guides

Advanced features

  • Subprojects
  • Single Version Documentation
  • Localization of Documentation
  • User-defined Redirects
  • Automatic Redirects
  • Automation Rules
  • Public API
    • API v3
    • API v2

About Read the Docs

  • Contributing to Read the Docs
  • Developer documentation
  • Roadmap
  • Google Summer of Code
  • Code of Conduct
  • Security
  • DMCA Takedown Policy
  • Policy for Abandoned Projects
  • Changelog
  • About Read the Docs
  • Read the Docs Team
  • Read the Docs Open Source Philosophy
  • The Story of Read the Docs
  • Advertising
  • Sponsors of Read the Docs
  • Read the Docs for Business
  • Legal documents
Read the Docs
  • »
  • Public API
  • Edit on GitHub

Public APIΒΆ

This section of the documentation details the public API usable to get details of projects, builds, versions and other details from Read the Docs.

  • API v3
    • Authentication and authorization
      • Token
      • Session
    • Resources
      • Projects
      • Versions
      • Builds
      • Subprojects
      • Translations
      • Redirects
      • Environment Variables
      • Organizations
      • Remote Organizations
      • Remote Repositories
    • Additional APIs
  • API v2
    • Authentication and authorization
    • Resources
      • Projects
      • Versions
      • Builds
      • Embed
      • Undocumented resources and endpoints
Next Previous

© Copyright 2010-2021, Read the Docs, Inc & contributors. Revision 1c5078be.

Built with Sphinx using a theme provided by Read the Docs.