https://blog.readthedocs.comRead the Docs Blog - Posts tagged reference2024-01-10T23:05:11.128228+00:00ABloghttps://blog.readthedocs.com/api-v3-stable/API v3 is now stable2021-02-16T00:00:00+00:00Manuel Kaufmann<section id="api-v3-is-now-stable">
<p>We are excited to announce that our <a class="reference external" href="https://docs.readthedocs.io/page/api/v3.html">API v3</a> has reached a stable release,
and is now available for all Read the Docs users.
Since we <a class="reference internal" href="../../../api-v3-beta/"><span class="doc">announced the API v3 beta</span></a>,
we have been adding extra functionality and bug-fixing minor issues based on user feedback.</p>
<p>The new API v3 <em>is not</em> a fully replacement (yet!) of API v2,
but <strong>we highly recommend using API v3 for all the new integrations</strong>.
API v2 will be deprecated soon,
though we don’t have a firm timeline for deprecation.
We will alert users with our plans when we do.</p>
<section id="new-features">
<h2>New features</h2>
<p>We’re excited about the following actions that API v3 makes possible:</p>
<ul class="simple">
<li><p>Import new projects</p></li>
<li><p>Activate a version</p></li>
<li><p>Trigger builds</p></li>
<li><p>Check build status</p></li>
<li><p>Manage redirects</p></li>
</ul>
<p>API v3 allows you to easily manage common tasks on your Read the Docs project and organization.
These include:</p>
<ul class="simple">
<li><p>Setting up documentation for a new project</p></li>
<li><p>Automating the release of a new version</p></li>
<li><p>Pausing a release if you detect a failed build</p></li>
<li><p>Automatically create redirects for changes files</p></li>
</ul>
<p>If you want to know more about it,
please check out the full <a class="reference external" href="https://docs.readthedocs.io/page/api/v3.html">APIv3 documentation</a>.</p>
</section>
<section id="help-us-make-it-better">
<h2>Help us make it better</h2>
<p>We always love to hear from users about how they are using the API.
We want to help you manage your documentation in the easiest and most efficient way possible.
Please, feel free to <a class="reference external" href="https://github.com/rtfd/readthedocs.org/issues/">open an issue in our issue tracker</a>
if there is a use case we are not covering.</p>
</section>
</section>
We are excited to announce that our API v3 has reached a stable release,
and is now available for all Read the Docs users.
Since we announced the API v3 beta,
we have been adding extra functionality and bug-fixing minor issues based on user feedback.The new API v3 is not a fully replacement (yet!) of API v2,
but we highly recommend using API v3 for all the new integrations.
API v2 will be deprecated soon,
though we don’t have a firm timeline for deprecation.
We will alert users with our plans when we do.2021-02-16T00:00:00+00:00