# Markdown Badge API

The Markdown Badge API provided by Runway enables teams to display badges on their repositories, showcasing either the number of completed releases (release\_count) or the live release version (live\_release) of their app. These badges offer a dynamic way to present project status directly on markdown files, such as READMEs, and automatically link back to Runway for additional insights.

## **API Endpoint**

To access the Markdown Badge API, use the following URL format:

`https://app.runway.team/api/markdownBadge?app_id={APP_ID}&style={STYLE}&badge_type={TYPE}`

### **Parameters**

* **`app_id` (required)**: The unique identifier of your team’s app in Runway. You can find your app’s app\_id by going to App settings > General > App identifier on the Runway dashboard
* **`style`**: Defines the appearance of the badge. Options include:
  * `flat` (default)

<figure><img src="/files/hv5s4C51ERMjptkD0M5l" alt=""><figcaption></figcaption></figure>

* `flat-square`

<figure><img src="/files/I2RyiYZB2ut93G9KmGBq" alt=""><figcaption></figcaption></figure>

* `plastic`

<figure><img src="/files/wXfjYN6IpheWw9IiJCn1" alt=""><figcaption></figcaption></figure>

* `for-the-badge`

<figure><img src="/files/OXBfJJNantfWEZeBHYvH" alt=""><figcaption></figcaption></figure>

* `social`

<figure><img src="/files/gtT2MmLrCSMFhgmStcmZ" alt=""><figcaption></figcaption></figure>

* `badge_type`: Specifies the type of information the badge displays. Options are:
  * `release_count` (default): Shows the number of completed releases on Runway
  * `live_release`: Displays the live release version number

**Usage Example**

To create a badge displaying the latest release version of your app in a flat style, your URL might look like this:<br>

`https://app.runway.team/api/markdownBadge?app_id=12345&style=flat&badge_type=live_release`

This URL can be embedded in markdown files to display the badge.

### **Embedding in Markdown**

To embed the badge in your markdown file, use the following syntax:

`![Badge](https://app.runway.team/api/markdownBadge?app_id={APP_ID}&style={STYLE}&badge_type={TYPE})`

Replace `{APP_ID}`, `{STYLE}`, and `{TYPE}` with your app's details.\ <br>

<br>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.runway.team/api/markdown-badge-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.