API v3 (original) (raw)

The Read the Docs API uses REST. JSON is returned by all API responses including errors and HTTP response status codes are to designate success and failure.

Table of contents

Authentication and authorization

Requests to the Read the Docs public API are for public and private information. Endpoints that return public information do not require authentication.

Token

The Authorization HTTP header can be specified with Token <your-access-token>to authenticate as a user and have the same permissions that the user itself.

Session

Session authentication is allowed, so the API can be used by our dashboard and other internal services.

Rate limiting

The API limits unauthenticated requests to 5 per minute and authenticated requests to 60 per minute.

Resources

This section shows all the resources that are currently available in APIv3. There are some URL attributes that applies to all of these resources:

?fields=:

Specify which fields are going to be returned in the response.

?omit=:

Specify which fields are going to be omitted from the response.

?expand=:

Some resources allow to expand/add extra fields on their responses (see Project details for example).

Projects

Projects list

GET /api/v3/projects/

Retrieve a list of all the projects for the current logged in user.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/projects/

Example response:

{ "count": 25, "next": "/api/v3/projects/?limit=10&offset=10", "previous": null, "results": [{ "id": 12345, "name": "Pip", "slug": "pip", "created": "2010-10-23T18:12:31+00:00", "modified": "2018-12-11T07:21:11+00:00", "language": { "code": "en", "name": "English" }, "programming_language": { "code": "py", "name": "Python" }, "repository": { "url": "https://github.com/pypa/pip", "type": "git" }, "default_version": "stable", "default_branch": "master", "subproject_of": null, "translation_of": null, "urls": { "documentation": "http://pip.pypa.io/en/stable/", "home": "https://pip.pypa.io/" }, "tags": [ "distutils", "easy_install", "egg", "setuptools", "virtualenv" ], "users": [ { "username": "dstufft" } ], "active_versions": { "stable": "{VERSION}", "latest": "{VERSION}", "19.0.2": "{VERSION}" }, "_links": { "_self": "/api/v3/projects/pip/", "versions": "/api/v3/projects/pip/versions/", "builds": "/api/v3/projects/pip/builds/", "subprojects": "/api/v3/projects/pip/subprojects/", "superproject": "/api/v3/projects/pip/superproject/", "redirects": "/api/v3/projects/pip/redirects/", "translations": "/api/v3/projects/pip/translations/" } }] }

Query Parameters:

The results in response is an array of project data, which is same as GET /api/v3/projects/(string:project_slug)/.

Note

Read the Docs for Business, also accepts

Query Parameters:

Project details

GET /api/v3/projects/(string: project_slug)/

Retrieve details of a single project.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/

Example response:

{ "id": 12345, "name": "Pip", "slug": "pip", "created": "2010-10-23T18:12:31+00:00", "modified": "2018-12-11T07:21:11+00:00", "language": { "code": "en", "name": "English" }, "programming_language": { "code": "py", "name": "Python" }, "repository": { "url": "https://github.com/pypa/pip", "type": "git" }, "default_version": "stable", "default_branch": "master", "subproject_of": null, "translation_of": null, "urls": { "documentation": "http://pip.pypa.io/en/stable/", "home": "https://readthedocs.org/projects/pip/", "downloads": null, "builds": "https://readthedocs.org/projects/pip/builds/", "versions": "https://readthedocs.org/projects/pip/versions/", }, "tags": [ "distutils", "easy_install", "egg", "setuptools", "virtualenv" ], "users": [ { "username": "dstufft" } ], "active_versions": { "stable": "{VERSION}", "latest": "{VERSION}", "19.0.2": "{VERSION}" }, "privacy_level": "public", "external_builds_privacy_level": "public", "versioning_scheme": "multiple_versions_with_translations", "_links": { "_self": "/api/v3/projects/pip/", "versions": "/api/v3/projects/pip/versions/", "builds": "/api/v3/projects/pip/builds/", "subprojects": "/api/v3/projects/pip/subprojects/", "superproject": "/api/v3/projects/pip/superproject/", "redirects": "/api/v3/projects/pip/redirects/", "translations": "/api/v3/projects/pip/translations/" } }

Query Parameters:

Note

versioning_scheme can be one of the following values:

Note

Read the Docs for Business, also accepts

Query Parameters:

Note

The single_version attribute is deprecated, use versioning_scheme instead.

Note

Previously, translation_of and subproject_of returned a full project object, due to privacy concerns, now they return only the slug of the project. If you need to get the full project object, you can use the project endpoint with the slug.

Project create

POST /api/v3/projects/

Import a project under authenticated user.

Example request:

$ curl
-X POST
-H "Authorization: Token " https://readthedocs.org/api/v3/projects/
-H "Content-Type: application/json"
-d @body.json

The content of body.json is like,

{ "name": "Test Project", "repository": { "url": "https://github.com/readthedocs/template", "type": "git" }, "homepage": "http://template.readthedocs.io/", "programming_language": "py", "language": "es", "privacy_level": "public", "external_builds_privacy_level": "public", "tags": [ "automation", "sphinx" ] }

Example response:

See Project details

Note

Read the Docs for Business, also accepts

Request JSON Object:

Project update

PATCH /api/v3/projects/(string: project_slug)/

Update an existing project.

Example request:

$ curl
-X PATCH
-H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/
-H "Content-Type: application/json"
-d @body.json

The content of body.json is like,

{ "name": "New name for the project", "repository": { "url": "https://github.com/readthedocs/readthedocs.org", "type": "git" }, "language": "ja", "programming_language": "py", "homepage": "https://readthedocs.org/", "tags" : [ "extension", "mkdocs" ] "default_version": "v0.27.0", "default_branch": "develop", "analytics_code": "UA000000", "analytics_disabled": false, "versioning_scheme": "multiple_versions_with_translations", "external_builds_enabled": true, "privacy_level": "public", "external_builds_privacy_level": "public" }

Note

Adding tags will replace existing tags with the new list, and if omitted won’t change the tags.

Status Codes:

Project versions sync

POST /api/v3/projects/(string: project_slug)/sync-versions/

Trigger a background task to sync the versions of the project.

Example request:

$ curl
-X POST
-H "Authorization: Token "
https://readthedocs.org/api/v3/projects/pip/sync-versions/

Status Codes:

Versions

Versions are different versions of the same project documentation.

The versions for a given project can be viewed in a project’s version page. For example, here is the Pip project’s version page. See Versions for more information.

Versions listing

GET /api/v3/projects/(string: project_slug)/versions/

Retrieve a list of all versions for a project.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/versions/

Example response:

{ "count": 25, "next": "/api/v3/projects/pip/versions/?limit=10&offset=10", "previous": null, "results": ["VERSION"] }

Query Parameters:

Version detail

GET /api/v3/projects/(string: project_slug)/versions/(string: version_slug)/

Retrieve details of a single version.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/versions/stable/

Example response:

{ "id": 71652437, "slug": "stable", "verbose_name": "stable", "identifier": "3a6b3995c141c0888af6591a59240ba5db7d9914", "ref": "19.0.2", "built": true, "active": true, "aliases": ["VERSION"], "hidden": false, "type": "tag", "privacy_level": "public", "downloads": { "pdf": "https://pip.readthedocs.io/_/downloads/pdf/pip/stable/", "htmlzip": "https://pip.readthedocs.io/_/downloads/htmlzip/pip/stable/", "epub": "https://pip.readthedocs.io/_/downloads/epub/pip/stable/" }, "urls": { "dashboard": { "edit": "https://readthedocs.org/dashboard/pip/version/stable/edit/" }, "documentation": "https://pip.pypa.io/en/stable/", "vcs": "https://github.com/pypa/pip/tree/19.0.2" }, "_links": { "_self": "/api/v3/projects/pip/versions/stable/", "builds": "/api/v3/projects/pip/versions/stable/builds/", "project": "/api/v3/projects/pip/" } }

Response JSON Object:

Version update

PATCH /api/v3/projects/(string: project_slug)/versions/(string: version_slug)/

Update a version.

When a version is deactivated, its documentation is removed, and when it’s activated, a new build is triggered.

Updates to a version also invalidates its CDN cache.

Example request:

$ curl
-X PATCH
-H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/versions/0.23/
-H "Content-Type: application/json"
-d @body.json

The content of body.json is like,

{ "active": true, "hidden": false, "privacy_level": "public" }

Status Codes:

Builds

Builds are created by Read the Docs whenever a Project has its documentation built. Frequently this happens automatically via a web hook but can be triggered manually.

Builds can be viewed in the build page for a project. For example, here is Pip’s build page. See Build process overview for more information.

Build details

GET /api/v3/projects/(str: project_slug)/builds/(int: build_id)/

Retrieve details of a single build for a project.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/builds/8592686/?expand=config

Example response:

{ "id": 8592686, "version": "latest", "project": "pip", "created": "2018-06-19T15:15:59+00:00", "finished": "2018-06-19T15:16:58+00:00", "duration": 59, "state": { "code": "finished", "name": "Finished" }, "success": true, "error": null, "commit": "6f808d743fd6f6907ad3e2e969c88a549e76db30", "config": { "version": "1", "formats": [ "htmlzip", "epub", "pdf" ], "python": { "version": 3, "install": [ { "requirements": ".../stable/tools/docs-requirements.txt" } ], }, "conda": null, "build": { "image": "readthedocs/build:latest" }, "doctype": "sphinx_htmldir", "sphinx": { "builder": "sphinx_htmldir", "configuration": ".../stable/docs/html/conf.py", "fail_on_warning": false }, "mkdocs": { "configuration": null, "fail_on_warning": false }, "submodules": { "include": "all", "exclude": [], "recursive": true } }, "_links": { "_self": "/api/v3/projects/pip/builds/8592686/", "project": "/api/v3/projects/pip/", "version": "/api/v3/projects/pip/versions/latest/" } }

Response JSON Object:

Query Parameters:

Builds listing

GET /api/v3/projects/(str: project_slug)/builds/

Retrieve list of all the builds on this project.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/builds/

Example response:

{ "count": 15, "next": "/api/v3/projects/pip/builds?limit=10&offset=10", "previous": null, "results": ["BUILD"] }

Query Parameters:

Build triggering

POST /api/v3/projects/(string: project_slug)/versions/(string: version_slug)/builds/

Trigger a new build for the version_slug version of this project.

Example request:

$ curl
-X POST
-H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/versions/latest/builds/

Example response:

{ "build": "{BUILD}", "project": "{PROJECT}", "version": "{VERSION}" }

Status Codes:

Subprojects

Projects can be configured in a nested manner, by configuring a project as a subproject of another project. This allows for documentation projects to share a search index and a namespace or custom domain, but still be maintained independently. See Subprojects for more information.

Subproject details

GET /api/v3/projects/(str: project_slug)/subprojects/(str: alias_slug)/

Retrieve details of a subproject relationship.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/subprojects/subproject-alias/

Example response:

{ "alias": "subproject-alias", "child": ["PROJECT"], "_links": { "parent": "/api/v3/projects/pip/" } }

Subprojects listing

GET /api/v3/projects/(str: project_slug)/subprojects/

Retrieve a list of all sub-projects for a project.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/subprojects/

Example response:

{ "count": 25, "next": "/api/v3/projects/pip/subprojects/?limit=10&offset=10", "previous": null, "results": ["SUBPROJECT RELATIONSHIP"] }

Subproject create

POST /api/v3/projects/(str: project_slug)/subprojects/

Create a subproject relationship between two projects.

Example request:

$ curl
-X POST
-H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/subprojects/
-H "Content-Type: application/json"
-d @body.json

The content of body.json is like,

{ "child": "subproject-child-slug", "alias": "subproject-alias" }

Note

child must be a project that you have access to. Or if you are using Business hosting, additionally the project must be under the same organization as the parent project.

Example response:

See Subproject details

Response JSON Object:

Status Codes:

Subproject delete

DELETE /api/v3/projects/(str: project_slug)/subprojects/(str: alias_slug)/

Delete a subproject relationship.

Example request:

$ curl
-X DELETE
-H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/subprojects/subproject-alias/

Status Codes:

Translations

Translations are the same version of a Project in a different language. See Localization and Internationalization for more information.

Translations listing

GET /api/v3/projects/(str: project_slug)/translations/

Retrieve a list of all translations for a project.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/translations/

Example response:

{ "count": 25, "next": "/api/v3/projects/pip/translations/?limit=10&offset=10", "previous": null, "results": [{ "id": 12345, "name": "Pip", "slug": "pip", "created": "2010-10-23T18:12:31+00:00", "modified": "2018-12-11T07:21:11+00:00", "language": { "code": "en", "name": "English" }, "programming_language": { "code": "py", "name": "Python" }, "repository": { "url": "https://github.com/pypa/pip", "type": "git" }, "default_version": "stable", "default_branch": "master", "subproject_of": null, "translation_of": null, "urls": { "documentation": "http://pip.pypa.io/en/stable/", "home": "https://pip.pypa.io/" }, "tags": [ "distutils", "easy_install", "egg", "setuptools", "virtualenv" ], "users": [ { "username": "dstufft" } ], "active_versions": { "stable": "{VERSION}", "latest": "{VERSION}", "19.0.2": "{VERSION}" }, "_links": { "_self": "/api/v3/projects/pip/", "versions": "/api/v3/projects/pip/versions/", "builds": "/api/v3/projects/pip/builds/", "subprojects": "/api/v3/projects/pip/subprojects/", "superproject": "/api/v3/projects/pip/superproject/", "redirects": "/api/v3/projects/pip/redirects/", "translations": "/api/v3/projects/pip/translations/" } }] }

The results in response is an array of project data, which is same as GET /api/v3/projects/(string:project_slug)/.

Redirects

Redirects allow the author to redirect an old URL of the documentation to a new one. This is useful when pages are moved around in the structure of the documentation set. See Redirects for more information.

Redirect details

GET /api/v3/projects/(str: project_slug)/redirects/(int: redirect_id)/

Retrieve details of a single redirect for a project.

Example request

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/redirects/1/

Example response

{ "pk": 1, "created": "2019-04-29T10:00:00Z", "modified": "2019-04-29T12:00:00Z", "project": "pip", "from_url": "/docs/", "to_url": "/documentation/", "type": "page", "http_status": 302, "description": "", "enabled": true, "force": false, "position": 0, "_links": { "_self": "/api/v3/projects/pip/redirects/1/", "project": "/api/v3/projects/pip/" } }

Redirects listing

GET /api/v3/projects/(str: project_slug)/redirects/

Retrieve list of all the redirects for this project.

Example request

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/redirects/

Example response

{ "count": 25, "next": "/api/v3/projects/pip/redirects/?limit=10&offset=10", "previous": null, "results": ["REDIRECT"] }

Redirect create

POST /api/v3/projects/(str: project_slug)/redirects/

Create a redirect for this project.

Example request:

$ curl
-X POST
-H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/redirects/
-H "Content-Type: application/json"
-d @body.json

The content of body.json is like,

{ "from_url": "/docs/", "to_url": "/documentation/", "type": "page", "position": 0, }

Note

Example response:

See Redirect details

Status Codes:

Redirect update

PUT /api/v3/projects/(str: project_slug)/redirects/(int: redirect_id)/

Update a redirect for this project.

Example request:

$ curl
-X PUT
-H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/redirects/1/
-H "Content-Type: application/json"
-d @body.json

The content of body.json is like,

{ "from_url": "/docs/", "to_url": "/documentation.html", "type": "page" }

Note

If the position of the redirect is changed, it will be inserted in the new position and the other redirects will be reordered.

Example response:

See Redirect details

Redirect delete

DELETE /api/v3/projects/(str: project_slug)/redirects/(int: redirect_id)/

Delete a redirect for this project.

Example request:

$ curl
-X DELETE
-H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/redirects/1/

Status Codes:

Environment variables

Environment variables are variables that you can define for your project. These variables are used in the build process when building your documentation. They are for example useful to define secrets in a safe way that can be used by your documentation to build properly. Environment variables can also be made public, allowing for them to be used in PR builds. See Environment variable overview.

Environment variable details

GET /api/v3/projects/(str: project_slug)/environmentvariables/(int: environmentvariable_id)/

Retrieve details of a single environment variable for a project.

Example request

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/environmentvariables/1/

Example response

{ "_links": { "_self": "https://readthedocs.org/api/v3/projects/project/environmentvariables/1/", "project": "https://readthedocs.org/api/v3/projects/project/" }, "created": "2019-04-29T10:00:00Z", "modified": "2019-04-29T12:00:00Z", "pk": 1, "project": "project", "public": false, "name": "ENVVAR" }

Environment variables listing

GET /api/v3/projects/(str: project_slug)/environmentvariables/

Retrieve list of all the environment variables for this project.

Example request

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/environmentvariables/

Example response

{ "count": 15, "next": "/api/v3/projects/pip/environmentvariables/?limit=10&offset=10", "previous": null, "results": ["ENVIRONMENTVARIABLE"] }

Environment variable create

POST /api/v3/projects/(str: project_slug)/environmentvariables/

Create an environment variable for this project.

Example request:

$ curl
-X POST
-H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/environmentvariables/
-H "Content-Type: application/json"
-d @body.json

The content of body.json is like,

{ "name": "MYVAR", "value": "My secret value", "public": true }

Example response:

See Environment Variable details

Status Codes:

Note

Environment variable delete

DELETE /api/v3/projects/(str: project_slug)/environmentvariables/(int: environmentvariable_id)/

Delete an environment variable for this project.

Example request:

$ curl
-X DELETE
-H "Authorization: Token " https://readthedocs.org/api/v3/projects/pip/environmentvariables/1/

Request Headers:

Status Codes:

Organizations

Note

The /api/v3/organizations/ endpoint is only available in Read the Docs for Business currently. We plan to have organizations on Read the Docs Community in a near future and we will add support for this endpoint at the same time.

Organizations list

GET /api/v3/organizations/

Retrieve a list of all the organizations for the current logged in user.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.com/api/v3/organizations/

Example response:

{ "count": 1, "next": null, "previous": null, "results": [ { "_links": { "_self": "https://readthedocs.com/api/v3/organizations/pypa/", "projects": "https://readthedocs.com/api/v3/organizations/pypa/projects/" }, "created": "2019-02-22T21:54:52.768630Z", "description": "", "disabled": false, "email": "pypa@psf.org", "modified": "2020-07-02T12:35:32.418423Z", "name": "Python Package Authority", "owners": [ { "username": "dstufft" } ], "slug": "pypa", "url": "https://github.com/pypa/" } }

Organization details

GET /api/v3/organizations/(string: organization_slug)/

Retrieve details of a single organization.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.com/api/v3/organizations/pypa/

Example response:

{ "_links": { "_self": "https://readthedocs.com/api/v3/organizations/pypa/", "projects": "https://readthedocs.com/api/v3/organizations/pypa/projects/" }, "created": "2019-02-22T21:54:52.768630Z", "description": "", "disabled": false, "email": "pypa@psf.com", "modified": "2020-07-02T12:35:32.418423Z", "name": "Python Package Authority", "owners": [ { "username": "dstufft" } ], "slug": "pypa", "url": "https://github.com/pypa/" }

Organization projects list

GET /api/v3/organizations/(string: organization_slug)/projects/

Retrieve list of projects under an organization.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.com/api/v3/organizations/pypa/projects/

Example response:

{ "count": 1, "next": null, "previous": null, "results": [ { "_links": { "_self": "https://readthedocs.com/api/v3/projects/pypa-pip/", "builds": "https://readthedocs.com/api/v3/projects/pypa-pip/builds/", "environmentvariables": "https://readthedocs.com/api/v3/projects/pypa-pip/environmentvariables/", "redirects": "https://readthedocs.com/api/v3/projects/pypa-pip/redirects/", "subprojects": "https://readthedocs.com/api/v3/projects/pypa-pip/subprojects/", "superproject": "https://readthedocs.com/api/v3/projects/pypa-pip/superproject/", "translations": "https://readthedocs.com/api/v3/projects/pypa-pip/translations/", "versions": "https://readthedocs.com/api/v3/projects/pypa-pip/versions/" }, "created": "2019-02-22T21:59:13.333614Z", "default_branch": "master", "default_version": "latest", "homepage": null, "id": 2797, "language": { "code": "en", "name": "English" }, "modified": "2019-08-08T16:27:25.939531Z", "name": "pip", "programming_language": { "code": "py", "name": "Python" }, "repository": { "type": "git", "url": "https://github.com/pypa/pip" }, "slug": "pypa-pip", "subproject_of": null, "tags": [], "translation_of": null, "urls": { "builds": "https://readthedocs.com/projects/pypa-pip/builds/", "documentation": "https://pypa-pip.readthedocs-hosted.com/en/latest/", "home": "https://readthedocs.com/projects/pypa-pip/", "versions": "https://readthedocs.com/projects/pypa-pip/versions/" } } ] }

Organization teams list

GET /api/v3/organizations/(string: organization_slug)/teams/

Retrieve list of teams under an organization.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.com/api/v3/organizations/pypa/teams/

Example response:

{ "count": 2, "next": null, "previous": null, "results": [ { "access": "admin", "created": "2024-07-01T21:19:55.573819Z", "modified": "2024-07-01T21:19:55.573837Z", "name": "Admins", "slug": "admins" }, { "access": "readonly", "created": "2024-07-01T21:19:55.593815Z", "modified": "2024-07-01T21:19:55.593829Z", "name": "Read Only", "slug": "read-only" } ] }

Query Parameters:

Remote organizations

Remote organizations are the VCS organizations connected viaGitHub, GitLab and Bitbucket.

Remote organization listing

GET /api/v3/remote/organizations/

Retrieve a list of all Remote Organizations for the authenticated user.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/remote/organizations/

Example response:

{ "count": 20, "next": "api/v3/remote/organizations/?limit=10&offset=10", "previous": null, "results": [ { "avatar_url": "https://avatars.githubusercontent.com/u/12345?v=4", "created": "2019-04-29T10:00:00Z", "modified": "2019-04-29T12:00:00Z", "name": "Organization Name", "pk": 1, "slug": "organization", "url": "https://github.com/organization", "vcs_provider": "github" } ] }

The results in response is an array of remote organizations data.

Query Parameters:

Request Headers:

Remote repositories

Remote repositories are the importable repositories connected viaGitHub, GitLab and Bitbucket.

Remote repository listing

GET /api/v3/remote/repositories/

Retrieve a list of all Remote Repositories for the authenticated user.

Example request:

$ curl -H "Authorization: Token " https://readthedocs.org/api/v3/remote/repositories/?expand=remote_organization

Example response:

{ "count": 20, "next": "api/v3/remote/repositories/?expand=remote_organization&limit=10&offset=10", "previous": null, "results": [ { "remote_organization": { "avatar_url": "https://avatars.githubusercontent.com/u/12345?v=4", "created": "2019-04-29T10:00:00Z", "modified": "2019-04-29T12:00:00Z", "name": "Organization Name", "pk": 1, "slug": "organization", "url": "https://github.com/organization", "vcs_provider": "github" }, "projects": [{ "id": 12345, "name": "project", "slug": "project", "created": "2010-10-23T18:12:31+00:00", "modified": "2018-12-11T07:21:11+00:00", "language": { "code": "en", "name": "English" }, "programming_language": { "code": "py", "name": "Python" }, "repository": { "url": "https://github.com/organization/project", "type": "git" }, "default_version": "stable", "default_branch": "master", "subproject_of": null, "translation_of": null, "urls": { "documentation": "http://project.readthedocs.io/en/stable/", "home": "https://readthedocs.org/projects/project/" }, "tags": [ "test" ], "users": [ { "username": "dstufft" } ], "_links": { "_self": "/api/v3/projects/project/", "versions": "/api/v3/projects/project/versions/", "builds": "/api/v3/projects/project/builds/", "subprojects": "/api/v3/projects/project/subprojects/", "superproject": "/api/v3/projects/project/superproject/", "redirects": "/api/v3/projects/project/redirects/", "translations": "/api/v3/projects/project/translations/" } }], "avatar_url": "https://avatars3.githubusercontent.com/u/test-organization?v=4", "clone_url": "https://github.com/organization/project.git", "created": "2019-04-29T10:00:00Z", "description": "This is a test project.", "full_name": "organization/project", "html_url": "https://github.com/organization/project", "modified": "2019-04-29T12:00:00Z", "name": "project", "pk": 1, "ssh_url": "git@github.com:organization/project.git", "vcs": "git", "vcs_provider": "github", "default_branch": "master", "private": false, "admin": true } ] }

The results in response is an array of remote repositories data.

Query Parameters:

Request Headers:

Embed

GET /api/v3/embed/

Retrieve HTML-formatted content from documentation page or section. Read How to embed content from your documentation to know more about how to use this endpoint.

Warning

The content will be returned as is, without any sanitization or escaping. You should not include content from arbitrary projects, or projects you do not trust.

Example request:

curl https://readthedocs.org/api/v3/embed/?url=https://docs.readthedocs.io/en/latest/features.html%23read-the-docs-features

Example response:

{ "url": "https://docs.readthedocs.io/en/latest/features.html#read-the-docs-features", "fragment": "read-the-docs-features", "content": "<div class="section" id="read-the-docs-features">\n

Read the Docs ...", "external": false }

Response JSON Object:

Query Parameters:

Note

Passing ?doctool=, ?doctoolversion= and ?maincontent= may improve the response since the endpoint will know more about the exact structure of the HTML and can make better decisions.

Additional APIs