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

# API Reference

The programmatic interfaces — the Lynk SQL query dialect and the REST endpoints for validation and catalog inspection.

**Interfaces for querying and inspecting your Lynk semantic layer.**

This section documents the programmatic interfaces exposed by Lynk — how to write queries against your semantic layer, and how to call Lynk's HTTP endpoints to validate the semantic layer and inspect the data catalog.

***

## What's in this section

| Page                                                              | What it covers                                                                                                                                                                                                                  |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Lynk SQL](https://docs.getlynk.ai/api-reference/api/lynk-sql.md) | The SQL dialect the agent uses internally — single-domain scope, entity references, `metric(<entity>.<metric_name>)`, joins (default, `USING('<join_name>')`, `USING(<common_feature_name>)`, `ON`), CTEs, supported statements |
| [REST API](https://docs.getlynk.ai/api-reference/api/rest-api.md) | HTTP endpoints for validating the semantic layer and inspecting the data catalog (tables and columns)                                                                                                                           |

***

**Where to go next:**

* Need to understand how entities and metrics are defined? → [Entity](https://docs.getlynk.ai/concepts/entity.md)
* Want the authoring grammar behind `sql:` fields? → [SQL expressions](https://docs.getlynk.ai/reference/sql-expressions.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://docs.getlynk.ai/api-reference/api.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.
