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

# Weglot Developer Documentation

Translate your project with Weglot, and customize the Weglot plugins and libraries.

Documentation for developers: translate your app or codebase from your development workflow, customize the Weglot CMS plugins and JavaScript library, or call the Weglot API.

## Translate your project

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Translate Action</strong></td><td>Translate your JSON localization files from GitHub Actions.</td><td><a href="https://developers.weglot.com/frameworks-and-ai/translate-action">https://developers.weglot.com/frameworks-and-ai/translate-action</a></td></tr><tr><td><strong>API</strong></td><td>Call the Weglot API directly over HTTP.</td><td><a href="https://developers.weglot.com/api-reference">https://developers.weglot.com/api-reference</a></td></tr></tbody></table>

Coming soon:

* **React**: translate React apps (Next.js, Vite) with the `@weglot/translate-react` package.
* **AI agents**: with the Weglot MCP server, add Weglot to your project and manage your projects and translations from your LLM.
* **API 2.0**: the reference for the new Weglot API.

## Customize your integration

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>WordPress</strong></td><td>Hooks, filters and helper functions to customize the plugin.</td><td><a href="https://developers.weglot.com/cms/wordpress/getting-started">https://developers.weglot.com/cms/wordpress/getting-started</a></td></tr><tr><td><strong>Craft CMS</strong></td><td>Settings, events and use cases to customize the plugin.</td><td><a href="https://developers.weglot.com/cms/craft-cms/overview">https://developers.weglot.com/cms/craft-cms/overview</a></td></tr><tr><td><strong>JavaScript snippet</strong></td><td>Options, functions and link hooks of the JavaScript library.</td><td><a href="https://developers.weglot.com/cms/javascript/javascript">https://developers.weglot.com/cms/javascript/javascript</a></td></tr><tr><td><strong>Shopify</strong></td><td>Customize the Weglot JavaScript integration on your Shopify theme.</td><td><a href="https://developers.weglot.com/cms/integrations/shopify">https://developers.weglot.com/cms/integrations/shopify</a></td></tr><tr><td><strong>Proxy</strong></td><td>Headers Weglot sends to your original website.</td><td><a href="https://developers.weglot.com/cms/proxy/headers">https://developers.weglot.com/cms/proxy/headers</a></td></tr></tbody></table>

## Resources

* [Weglot 1.0](https://dashboard.weglot.com/): sign in, create a project and get your API key.
* [Weglot 2.0](https://auth.weglot.com/): sign in, create a project and get your project keys.
* [API 1.0 reference](https://developers.weglot.com/api-reference/1.0)
* [Weglot Community](https://inviter.co/weglot): join our Slack to share feedback and get tips.


---

# 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://developers.weglot.com/readme.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.