Skip to main content
Use the Export API when you need the same CSV-style output available from Runway, but pulled programmatically.

Supported objects

The Export API supports model pages and database pages. Generic pages are not supported by the server and return Pages cannot be exported. Example Runway URLs:
  • Main scenario model: https://app.runway.com/your-org-slug/submodel/afd94c7e-1e7f-4e55-b99a-472aa5a43cd9
  • Scenario model: https://app.runway.com/your-org-slug/proposal/445f8fea-df2a-49cb-9cce-f805be588137/submodel/afd94c7e-1e7f-4e55-b99a-472aa5a43cd9
  • Main scenario database: https://app.runway.com/your-org-slug/page/5fb5f2a6-7a13-4085-a89c-86e2da66a17c
  • Scenario database: https://app.runway.com/your-org-slug/proposal/445f8fea-df2a-49cb-9cce-f805be588137/page/5fb5f2a6-7a13-4085-a89c-86e2da66a17c

Exporting with the API

1

Create an API secret

In Runway settings, open API and create or copy your API secret.
2

Set the authorization header

Send the secret as a bearer token:
Authorization: Bearer <your API secret>
3

Build the API URL

Start from the model or database URL, remove the org slug, and use https://api.runway.com/api.
https://app.runway.com/your-org-slug/submodel/afd94c7e-1e7f-4e55-b99a-472aa5a43cd9
https://api.runway.com/api/submodel/afd94c7e-1e7f-4e55-b99a-472aa5a43cd9
4

Send a GET request

Use GET for the export request.
Supported URL paths:
  • /api/submodel/:pageID
  • /api/proposal/:layerID/submodel/:pageID
  • /api/page/:pageID
  • /api/proposal/:layerID/page/:pageID

Response shape

The response is JSON with:
FieldDescription
filenameSuggested CSV filename.
contentsCSV contents as a string.

Limitations

  • Export uses the same model or database view that Runway can export to CSV.
  • The time period comes from the page or block configuration.
  • Formulas are not exported as formulas; the export returns CSV data.
  • The request must come from a user with export permission. If the user does not have permission, Runway returns You do not have the permissions to export this page.
For manual exports from the app, see Exporting CSVs.