> 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/rest-api.md).

# REST API

HTTP endpoints for validating the semantic layer and inspecting the data catalog — full documentation in progress.

The Lynk REST API provides HTTP endpoints for working with your semantic layer programmatically — validating a build and inspecting the data catalog (the warehouse tables and columns the layer points at) without using the Lynk UI. Schemas themselves are authored in the `.lynk/` git repository and deployed through the [build](https://docs.getlynk.ai/concepts/project.md), not edited over the API.

{% hint style="info" %}
Full REST API documentation is in progress. For current API access and endpoint details, contact your Lynk account team or visit [app.getlynk.ai](https://app.getlynk.ai).
{% endhint %}

***

## Related reference

* [Lynk SQL](https://docs.getlynk.ai/api-reference/api/lynk-sql.md) — the query syntax the agent uses, which you can also use directly
* [Project](https://docs.getlynk.ai/concepts/project.md) — how a build is validated and deployed before it serves queries


---

# 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/rest-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.
