API reference - Yungle

This tab lists every endpoint in /api/v1. Each page is generated from the OpenAPI 3.1 document that the server validates requests with, so it matches the running API.

Base URL

https://yungle.co/api/v1

Requests and responses are JSON. File bytes are not: you upload them over tus to the tusEndpoint a create call returns. See Upload large files.

Authentication

Send an API key as a bearer token on every request:

curl https://yungle.co/api/v1/me \
  -H "Authorization: Bearer $YUNGLE_API_KEY"

An endpoint needs the read or write scope of its resource, such as transfers:read for a GET on a transfer and transfers:write to change one. Authentication lists what each scope covers and which endpoints the free plan reaches.

How endpoints are grouped

The sidebar follows the tags in the OpenAPI document:

Group	What it covers
Account	The workspace, plan and key behind a request; your referral link.
Transfers	Create, upload to, send, change and revoke transfers; download receipts; URL imports.
Collections	Collections, their files, folders and guests. Needs a paid plan.
Contacts	The workspace’s address book.
Upload requests	Public upload pages that put files into a collection.
Downloads	Signed download URLs for a link someone shared with you.
Webhooks	Endpoints, delivery attempts, and events to pull.

The OpenAPI document

The document is at https://yungle.co/api/v1/openapi.json. It needs no key to read. Use it to generate a client, import the API into Postman or Insomnia, or give an AI coding tool the exact contract.

Before you build

Errors

The error shape, every code, and when to retry.

Limits

Rate limits, email budgets and size ceilings.

Pagination and idempotency

Walk long lists and retry writes safely.

Quickstart

Send a transfer end to end before you read the reference.

​Base URL

​Authentication

​How endpoints are grouped

​The OpenAPI document

​Before you build