# 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` 

{% 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. 
{% endhint %}

## Get Hyperflow Overview

```
GET /.hf
```

Indicates the Hyperflow version and all installed apps. 

## Hyperflow Core API Calls 

All Hyperflow Core API calls follow the pattern; 

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

## Hyperflow Version

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

Returns the version number only, designed for app use. 

## Specific App API Calls

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

Each app will have a distinct API and its own docs. 

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

## Hyperflow Info

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

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="/files/29txaCwvmO7UxfkAx4YN" alt=""><figcaption></figcaption></figure>


---

# 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://hyperflow.sygnal.com/core/hyperflow-2-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.