> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Overleaf Import API

> Let other websites open LaTeX snippets and projects in a Kubernetes deployment.

The Import API (`/docs` and the "Open in Ayakaleaf" buttons, the `open-in-overleaf` module) runs in the **web** service of every Ayakaleaf Pro pod and is on by default. Files given by URL are downloaded through linked-url-proxy in the same pod. How to call it is described in [Overleaf Import API](https://ayakaleaf-pro.mintlify.site/on-premises/configuration/overleaf-toolkit/integrations/overleaf-import-api.md).

| | |
| - | - |
| Service | web (`open-in-overleaf` module); downloads through linked-url-proxy |
| Outside → Overleaf | browsers `GET` or `POST ${OVERLEAF_SITE_URL}/docs` from any website |
| Pod → outside | `snip_uri` and `zip_uri` downloads, limited as described in [External URL](https://ayakaleaf-pro.mintlify.site/on-premises/configuration/kubernetes/external-url.md) |
| State | a signed-out visitor's request, kept in Redis for 10 minutes until they log in |
| Periodic jobs | none |

### Configuration

Nothing is needed to turn it on. Related settings in the ConfigMap:

| Setting | |
| - | - |
| `OVERLEAF_ALLOW_PUBLIC_ACCESS: "true"` | Signed-out visitors can open `/devs`, and a request they send is kept until they log in, see [Public Access](https://ayakaleaf-pro.mintlify.site/on-premises/configuration/kubernetes/authentication/public-access.md). |
| `MAX_UPLOAD_SIZE` | Largest ZIP a request may carry, in MB (default `50`). Your ingress or load balancer must accept request bodies of that size too. |
| `OVERLEAF_LINKED_URL_*` | Which addresses `snip_uri` and `zip_uri` may point to, see [External URL](https://ayakaleaf-pro.mintlify.site/on-premises/configuration/kubernetes/external-url.md). |

### Several replicas

Nothing extra. A signed-out visitor's request is kept in Redis, so it is resumed on whichever replica the visitor reaches after logging in.

### Tested on Kubernetes

On Kubernetes 1.37 with one replica, our end-to-end tests for the Import API pass (14 cases): the `/devs` page and its example project, snippets, complete documents, URL-encoded links and files from data URLs turned into projects, submissions that cannot become a project refused, downloads from internal addresses refused, signed-out posts and links kept through the login, and, with `OVERLEAF_ALLOW_PUBLIC_ACCESS`, `/devs` for signed-out visitors and a posted snippet resumed once after logging in; the last case also passes on three replicas behind HAProxy.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.