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

# Overview

Use the Linkie API to manage profiles and posts in your app, automate workflows, and retrieve detailed analytics through REST endpoints.

Welcome to the Linkie API, a RESTful API for all Linkie users, built for developers who want to connect Linkie with their own applications, automations, and backend services.

Use it to work with Linkie profiles, sync post items into a profile, and retrieve analytics data programmatically.

{% hint style="info" %}
Access to the Linkie API is **free** for all users and does not require an active paid plan.
{% endhint %}

### What you can do with the Linkie API

There's a couple of things you might want to interact with the API:

* List your Linkie profiles
* Add posts to a profile in bulk
* Update or remove a post item from a profile
* Retrieve analytics for traffic, sources, countries, user agents, and cards

### API Specifications

| Property       | ValueText                     |
| -------------- | ----------------------------- |
| Base URL       | `https://app.linkie.bio`      |
| Format         | JSON                          |
| Authentication | `Authorization: Bearer <key>` |
| Version        | `v1`                          |
| Rate Limits    | `60 req/min`                  |

### Authentication

Include your key in the `Authorization` header for every request:

```http
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
```

### Getting Started

1. Generate an API key in your Linkie account settings. [Show me how](https://linkie.bio/help/en/article/how-to-access-the-linkie-api-mzfuyh/?bust=1781098005880).
2. Validate your key by listing your Linkie profiles:

```bash
curl -X GET https://app.linkie.bio/api/v1/profiles \
     -H "Authorization: Bearer YOUR_API_KEY"
```

3. Continue with [Getting Started](/docs/getting-started/quickstart.md).


---

# 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://linkie.bio/docs/overview.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.