> For the complete documentation index, see [llms.txt](https://developers.getafile.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.getafile.io/master.md).

# Introduction

Welcome to the GetaFile API documentation.

## What is GetaFile?

GetaFile is a subscription-based web application delivering version-controlled files via customised web links created by subscribers. Read more about GetaFile [here](https://www.getafile.online).

## Getting Access to the GetaFile API

To get started with the GetaFile API, register an account at [https://getafile.io/auth/register](https://getafile.online/app#/register)

{% hint style="info" %}
 Once you have registered your account, verified and setup your Two-Factor authentication you'll need to create an API token.
{% endhint %}

## Create an API Token

To generate an API token, go to your Profile and select "API TOKENS". Enter a name for the token and click "Generate token".

<figure><img src="https://1822885327-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MIl50zPgPqmR5_k56xs%2Fuploads%2Fy4aKbB9ekTv3HKG4ViLm%2Fgetafile-api-tokens.png?alt=media&amp;token=a0048fbb-ded5-4410-bd69-be174df4541c" alt=""><figcaption></figcaption></figure>

To revoke an API Token, click the delete icon next to the token you wish to revoke.

## Using the API Token

Once you have generated an API Token, include it in the Authorization header for each request.

There are 2 regions for GetaFile. Depending on where your account is located, use the following base URLs:\
\
**Oceanic, Asia**\
`au.getafile.io/api/v1`\
\
**Americas**\
`us.getafile.io/api/v1`

**Europe**\
`eu.getafile.io/api/v1`

<mark style="color:blue;">`GET`</mark> `https://{region}.getafile.io/api/v1/auth/checklogin`

Set the Authorization header for each request.

#### Headers

| Name          | Type   | Description                            |
| ------------- | ------ | -------------------------------------- |
| Authorization | string | Bearer ADeEW12312ZzSDS2112432xxxxxxxxx |

{% tabs %}
{% tab title="200 " %}

```
{
    email: "test@test.net"
    first_name: "Test"
    id: 1
    last_name: "User"
}
```

{% endtab %}

{% tab title="401 Returned if there is an issue with the Token." %}

```
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.getafile.io/master.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.