# Yungle

- [Yungle developer docs](https://docs.yungle.co/index.md): Send files, build client collections and collect uploads from your own code, a terminal or an AI assistant, over one EU-hosted API.
- [Quickstart](https://docs.yungle.co/quickstart.md): Send your first transfer through the Yungle API and read its download receipt in about five minutes, with curl, JavaScript or Python.
- [Authentication](https://docs.yungle.co/authentication.md): Create an API key, choose its scopes, and learn which endpoints the free plan reaches and what each authentication error means.
- [Concepts](https://docs.yungle.co/concepts.md): The words these docs use and what each one means: workspace, transfer, collection, upload request, contact, scanning, encryption and plans.
- [Send a transfer](https://docs.yungle.co/guides/send-a-transfer.md): Create a transfer, upload its files, send it by link or by email, then change its expiry, read receipts per recipient, or revoke it.
- [Upload large files](https://docs.yungle.co/guides/upload-large-files.md): Upload files of any size with resumable tus uploads: register, stream in parts, resume after a dropped connection, and renew tokens on long uploads.
- [Receive files with an upload request](https://docs.yungle.co/guides/receive-files.md): Create an upload request link that lets anyone send files into one of your collections, share it, see what arrived, and close it.
- [Give each client a collection](https://docs.yungle.co/guides/client-collections.md): Create a collection per client from your own system, upload folders into it with their structure intact, and invite the client as a guest.
- [Download files](https://docs.yungle.co/guides/download-files.md): Get signed, resumable download URLs for your own transfers and collections, or for a link someone shared with you, and see who downloaded what.
- [Get notified with webhooks](https://docs.yungle.co/guides/webhooks.md): Receive signed events when a transfer is ready, downloaded or expiring, verify them in Node or Python, and post to Slack when a client downloads.
- [Manage contacts](https://docs.yungle.co/guides/contacts.md): Read and write your workspace address book through the API, and keep it in step with a CRM without creating duplicates.
- [Send files from CI and cron](https://docs.yungle.co/guides/send-from-ci.md): Send build output from GitHub Actions or any CI with the Yungle CLI and an API key, and schedule a nightly report from cron.
- [Send files from Python](https://docs.yungle.co/guides/send-from-python.md): Send files of any size from a Python script with the yungle SDK: one call for a quick send, or create, upload and send step by step.
- [CLI](https://docs.yungle.co/cli.md): Install the yungle CLI, sign in, send files and folders resumably, push into collections, script it with --json, and look up every command.
- [MCP server](https://docs.yungle.co/mcp-server.md): Connect Claude, ChatGPT, Cursor or VS Code to Yungle with one sign-in, choose what the assistant may do, and see every tool it gets.
- [SDKs](https://docs.yungle.co/sdks.md): Install and use the JavaScript (yungle-client) and Python (yungle) SDKs: clients, operations, uploads, errors, retries and webhook verification.
- [Errors](https://docs.yungle.co/errors.md): The error shape every Yungle API failure shares, every error code with its status, and which errors are worth retrying.
- [Limits](https://docs.yungle.co/limits.md): Request rate limits, the monthly call allowance, email budgets, and size and count ceilings on the Yungle API, and how to stay under them.
- [Pagination and idempotency](https://docs.yungle.co/pagination-and-idempotency.md): Walk long lists with limit, cursor and nextCursor, and make POST requests safe to retry with an Idempotency-Key header.
- [What the API cannot do](https://docs.yungle.co/unsupported.md): The limits of the Yungle API: what can never be reachable, what is left out on purpose, and the gaps you may need to design around.
- [Changelog](https://docs.yungle.co/changelog.md): What changed in the Yungle API, uploads, OAuth, MCP, CLI, SDKs and browser extension, and the versioning policy for /api/v1.
- [API reference](https://docs.yungle.co/api-reference/index.md): Every endpoint in the Yungle API with its parameters, request body and responses, generated from the OpenAPI 3.1 document.
- [The workspace, plan and key behind this request](https://docs.yungle.co/api-reference/account/the-workspace-plan-and-key-behind-this-request.md): Check which workspace, plan and scopes an API key belongs to before you send anything. One call, no parameters.
- [Your invite link and referral progress](https://docs.yungle.co/api-reference/account/your-invite-link-and-referral-progress.md): Read the invite link and code of the key’s owner, and how many free months their referrals have earned so far.
- [List transfers, newest first](https://docs.yungle.co/api-reference/transfers/list-transfers-newest-first.md): List the transfers in your workspace, newest first, with status, size and expiry. Cursor-paged, up to 500 per page.
- [Create a transfer](https://docs.yungle.co/api-reference/transfers/create-a-transfer.md): Create a draft transfer and get a tus upload endpoint with one token per file. Nothing is live until you finalize it.
- [Transfer detail, files and recipient status](https://docs.yungle.co/api-reference/transfers/transfer-detail-files-and-recipient-status.md): Get one transfer: its files, recipients, who has downloaded, the link, and when it expires.
- [Revoke a transfer](https://docs.yungle.co/api-reference/transfers/revoke-a-transfer.md): Revoke a transfer: the link stops working at once and its files are deleted. Cannot be undone.
- [Change expiry or download limit](https://docs.yungle.co/api-reference/transfers/change-expiry-or-download-limit.md): Change a transfer’s expiry or download limit after it was sent, without changing its link.
- [Send it](https://docs.yungle.co/api-reference/transfers/send-it.md): Make a draft transfer live: the link starts working and recipients are emailed once every file has uploaded.
- [Add files to an unsent transfer](https://docs.yungle.co/api-reference/transfers/add-files-to-an-unsent-transfer.md): Add more files to a draft transfer before it is sent, and get an upload token for each new file.
- [Remove a file from an unsent transfer](https://docs.yungle.co/api-reference/transfers/remove-a-file-from-an-unsent-transfer.md): Remove one file from a draft transfer before it is sent. Its upload is cancelled and its bytes deleted.
- [Store the sealed name and thumbnail of an encrypted file](https://docs.yungle.co/api-reference/transfers/store-the-sealed-name-and-thumbnail-of-an-encrypted-file.md): Store the encrypted name and thumbnail of a file in an end-to-end encrypted transfer. The server never sees either.
- [Download receipts](https://docs.yungle.co/api-reference/transfers/download-receipts.md): See who downloaded a transfer and when, per file and per recipient, including downloads that did not finish.
- [Download your own transfer](https://docs.yungle.co/api-reference/transfers/download-your-own-transfer.md): Get short-lived direct download URLs for every file in your own transfer, for scripts and agents.
- [Follow a URL import](https://docs.yungle.co/api-reference/transfers/follow-a-url-import.md): Follow a URL import: whether Yungle has fetched the file from the web yet, how far it got, and why it failed.
- [List upload requests](https://docs.yungle.co/api-reference/upload-requests/list-upload-requests.md): List your upload requests: links that let other people send files to you, with how many have arrived.
- [Create an upload request](https://docs.yungle.co/api-reference/upload-requests/create-an-upload-request.md): Create an upload request: a link anyone can use to send files into one of your collections, no account needed.
- [An upload request and who has sent what](https://docs.yungle.co/api-reference/upload-requests/an-upload-request-and-who-has-sent-what.md): Get one upload request and every submission to it: who sent what, and when.
- [Pause, resume or close an upload request](https://docs.yungle.co/api-reference/upload-requests/pause-resume-or-close-an-upload-request.md): Pause, resume or close an upload request, or change its title, message and limits.
- [Download a link someone shared with you](https://docs.yungle.co/api-reference/downloads/download-a-link-someone-shared-with-you.md): Turn a Yungle link someone shared with you into direct download URLs for its files, from a script or agent.
- [List collections](https://docs.yungle.co/api-reference/collections/list-collections.md): List the collections in your workspace with their size, file count and how they are shared.
- [Create a collection](https://docs.yungle.co/api-reference/collections/create-a-collection.md): Create a collection: a lasting, folder-structured space for files that you can share with clients.
- [Collection detail](https://docs.yungle.co/api-reference/collections/collection-detail.md): Get one collection: its title, sharing settings, size and the link guests use to open it.
- [Delete a collection and its contents](https://docs.yungle.co/api-reference/collections/delete-a-collection-and-its-contents.md): Delete a collection and everything in it. Its files are removed and its link stops working.
- [Rename or re-describe](https://docs.yungle.co/api-reference/collections/rename-or-re-describe.md): Rename a collection or change how it is shared, its description and its expiry.
- [Download your own collection](https://docs.yungle.co/api-reference/collections/download-your-own-collection.md): Get short-lived direct download URLs for the files in a collection you own or were invited to.
- [List files](https://docs.yungle.co/api-reference/collections/list-files.md): List the files in a collection or one of its folders, with size, type and scan status. Cursor-paged.
- [Register files for upload](https://docs.yungle.co/api-reference/collections/register-files-for-upload.md): Add files to a collection, keeping their folder paths, and get a tus upload token for each one.
- [Delete files](https://docs.yungle.co/api-reference/collections/delete-files.md): Delete one or more files from a collection by id. Storage is freed as soon as they are gone.
- [List folders](https://docs.yungle.co/api-reference/collections/list-folders.md): List the folders in a collection, with their paths, so you can place uploads and build links.
- [Create a folder](https://docs.yungle.co/api-reference/collections/create-a-folder.md): Create a folder in a collection, nested under another folder or at the top level.
- [List guests](https://docs.yungle.co/api-reference/collections/list-guests.md): List the people invited to a collection and when each of them last opened it.
- [Invite guests by email](https://docs.yungle.co/api-reference/collections/invite-guests-by-email.md): Invite people to a collection by email. Each gets their own access, which you can remove later.
- [Remove a guest](https://docs.yungle.co/api-reference/collections/remove-a-guest.md): Remove a guest from a collection. Their access ends immediately; nothing else changes.
- [List webhook endpoints](https://docs.yungle.co/api-reference/webhooks/list-webhook-endpoints.md): List your webhook endpoints, the events each one receives, and whether it is active or paused.
- [Create an endpoint](https://docs.yungle.co/api-reference/webhooks/create-an-endpoint.md): Add a webhook endpoint and choose its events. Every delivery is signed so you can verify it came from Yungle.
- [Get an endpoint](https://docs.yungle.co/api-reference/webhooks/get-an-endpoint.md): Get one webhook endpoint: its URL, the events it receives and its recent delivery health.
- [Delete an endpoint](https://docs.yungle.co/api-reference/webhooks/delete-an-endpoint.md): Delete a webhook endpoint. Nothing more is sent to it; events already delivered are unaffected.
- [Change, pause or resume an endpoint](https://docs.yungle.co/api-reference/webhooks/change-pause-or-resume-an-endpoint.md): Change a webhook endpoint’s URL or events, or pause and resume deliveries to it.
- [Replace the signing secret](https://docs.yungle.co/api-reference/webhooks/replace-the-signing-secret.md): Replace a webhook endpoint’s signing secret. The old secret stops verifying new deliveries at once.
- [Send a webhook.test event](https://docs.yungle.co/api-reference/webhooks/send-a-webhooktest-event.md): Send a test event to a webhook endpoint to check that your server receives it and verifies the signature.
- [Recent delivery attempts](https://docs.yungle.co/api-reference/webhooks/recent-delivery-attempts.md): See recent delivery attempts to a webhook endpoint: status codes, timing and errors, newest first.
- [Redeliver an event](https://docs.yungle.co/api-reference/webhooks/redeliver-an-event.md): Send a failed webhook delivery again, with the same event and a fresh signature.
- [Read events (pull)](https://docs.yungle.co/api-reference/webhooks/read-events-pull.md): Pull the events for an endpoint yourself, for scripts that cannot receive webhooks on a public URL.
- [List contacts](https://docs.yungle.co/api-reference/contacts/list-contacts.md): List the contacts in your workspace: the people you send to, with names and email addresses.
- [Create a contact](https://docs.yungle.co/api-reference/contacts/create-a-contact.md): Add a contact to your workspace so you can send transfers and invites to them by name.
- [Get a contact](https://docs.yungle.co/api-reference/contacts/get-a-contact.md): Get one contact from your workspace by id: their name, email address and when they were added.
- [Delete a contact](https://docs.yungle.co/api-reference/contacts/delete-a-contact.md): Delete a contact from your workspace. Transfers already sent to them are not affected.
- [Replace a contact](https://docs.yungle.co/api-reference/contacts/replace-a-contact.md): Update a contact’s name or email address. The whole contact is replaced with what you send.

## OpenAPI Specs

- [openapi](/openapi.json)


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