> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yungle.co/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference

> Every endpoint in the Yungle API with its parameters, request body and responses, generated from the OpenAPI 3.1 document.

This tab lists every endpoint in `/api/v1`. Each page is generated from the [OpenAPI 3.1 document](https://yungle.co/api/v1/openapi.json) that the server validates requests with, so it matches the running API.

## Base URL

```text theme={null}
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](/guides/upload-large-files).

## Authentication

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

```bash theme={null}
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](/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](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

<Columns cols={2}>
  <Card title="Errors" icon="triangle-exclamation" href="/errors">
    The error shape, every code, and when to retry.
  </Card>

  <Card title="Limits" icon="gauge" href="/limits">
    Rate limits, email budgets and size ceilings.
  </Card>

  <Card title="Pagination and idempotency" icon="arrows-rotate" href="/pagination-and-idempotency">
    Walk long lists and retry writes safely.
  </Card>

  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Send a transfer end to end before you read the reference.
  </Card>
</Columns>


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