> For the complete documentation index, see [llms.txt](https://guide.gftv.asia/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guide.gftv.asia/api/overview.md).

# API Overview

The gftv.asia API lets you programmatically **get**, **create**, and **update** short links on your account. It is available to all **Editor** and **Admin** users.

## Base URL

All API endpoints are served from:

```
https://gftv.asia/api/v1
```

## Authentication

Every request must include your API key in the `Authorization` header using the `ApiKey` scheme:

```
Authorization: ApiKey <your_api_key>
```

You can generate or regenerate your API key from the **API Integration** page inside the portal. Copy it immediately — the full key is only shown once.

{% hint style="warning" %}
**Keep your API key secret.** Anyone who has your key can create and modify links on your behalf. If you believe your key has been compromised, regenerate it immediately from the API Integration page — the old key stops working instantly.
{% endhint %}

## Request format

All request bodies must be JSON. Include the `Content-Type: application/json` header when sending a body.

## Response format

All responses are JSON objects. A successful response includes `"success": true` along with the returned data. An error response includes `"success": false` and an `"error"` field describing what went wrong.

**Success example:**

```json
{
  "success": true,
  "links": [ … ]
}
```

**Error example:**

```json
{
  "success": false,
  "error": "slug is already taken"
}
```

## Status codes

| Code  | Meaning                                                                             |
| ----- | ----------------------------------------------------------------------------------- |
| `200` | OK — request succeeded                                                              |
| `201` | Created — a new resource was successfully created                                   |
| `400` | Bad Request — missing or invalid parameters                                         |
| `401` | Unauthorized — API key is missing or invalid                                        |
| `403` | Forbidden — your account does not have permission                                   |
| `404` | Not Found — the requested resource does not exist                                   |
| `405` | Method Not Allowed — HTTP method is not supported on this endpoint                  |
| `409` | Conflict — a resource with the same identifier already exists (e.g. duplicate slug) |
| `500` | Internal Server Error — something went wrong on our end                             |


---

# 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 dynamically by asking a question.

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

```
GET https://guide.gftv.asia/api/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.