# Hyperflow 2 API

The Hyperflow API is directly integrated into your site.

Access it using your default domain name, e.g. `https://www.mysite.com/.hf`&#x20;

{% hint style="success" %}
Since Webflow does not permit pages or paths that begin with a period `.`, there is no risk of conflicting with an existing Webflow page.&#x20;
{% endhint %}

## Get Hyperflow Overview

```
GET /.hf
```

Indicates the Hyperflow version and all installed apps.&#x20;

## Hyperflow Core API Calls&#x20;

All Hyperflow Core API calls follow the pattern;&#x20;

```
/.hf/api/*
```

## Hyperflow Version

```
GET /.hf/api/version
```

Returns the version number only, designed for app use.&#x20;

## Specific App API Calls

Fall under the app-name, e.g. `wfx` .

Each app will have a distinct API and its own docs.&#x20;

```
/.hf/(app-name)/* 
```

## Hyperflow Info

On your HF2 enabled Webflow site, just add `/.hf` to the end of your domain name, like this;&#x20;

e.g. <https://www.sygnal.com/.hf>

You'll get a version report.&#x20;

```
Sygnal Hyperflow v2.0.2.0

Docs:
https://hyperflow.sygnal.com/
```

<figure><img src="https://536357598-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVQuEOlALOzn8bqKjkyEo%2Fuploads%2FgTWUNIXkYDUwyFDBZWo2%2Fimage.png?alt=media&#x26;token=05c3f1b9-431e-4849-bd3d-71679447a936" alt=""><figcaption></figcaption></figure>
