Overview

This feature is limited to certain plans. Please visit our pricing page to learn more.

Runway’s REST API (available for Enterprise teams and above) offers more flexibility in how your team can take advantage of Runway’s core features. By using the Runway API to interact with entities within Runway (like ‘releases’), you can create powerful workflows that leverage Runway’s functionality in concert with your team’s existing toolchain and processes.

To get started, create an API key from the organization settings of your Runway dashboard.

Create an API key

Admin permissions are required to create API keys.

Navigate to your organization settings page, where you’ll find the API keys section. Then, create a new API key – you'll be prompted to fill in the following details about your new key:

• API key name – The key's name. We recommend a descriptive name to help you remember what the key will be used for.

• Group scopes – The user groups whose allowed user actions the API key should be granted.

• App scopes – The apps that the API key should be granted access to.

• Admin scope – If selected, the API key will be given admin scope, which will grant it access to perform all actions across all apps in the organization.

To configure an API key with org-wide read-only scope, leave the Group scopes and App scopes fields empty, and keep the Admin scope field unchecked. To configure read-only access for only a subset of apps in the organization, select the apps from in the App scopes field, but leave Group scopes empty.

Be sure to copy your new API key immediately, as it will not be available again once you complete the creation flow. Remember to store your API key in a safe place.

Revoke an API key

To revoke access to an API key, delete it from the list of keys in your organization. This will immediately revoke the key’s access to the API, and remove it from the list of active keys for your organization.

Interact with the API

Once you’ve created an API key, you’re ready to start calling endpoints on the Runway API. For detailed instructions on how to authenticate requests to the API, and to learn more about the endpoints available, please visit our 🔗 API reference documentation.