# Overview

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-add-website-links-to-linkie-10vm00e/).
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: 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://linkie.bio/docs/overview.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.