# Air API Documentation

> Documentation for Air API

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Getting Started with Air's API](https://developer.air.inc/docs/getting-started.md)
- [Upload an Asset Using Air's Public API](https://developer.air.inc/docs/upload-assets.md)

## API Reference
- [/assets](https://developer.air.inc/reference/get_v1-assets.md): Get a list of assets. Sorted by coverVersion.updatedAt descending (most recently updated asset version first).
- [/assets/:assetId](https://developer.air.inc/reference/get_v1-assets-assetid.md): Get an asset
- [/assets/:assetId](https://developer.air.inc/reference/delete_v1-assets-assetid.md): Delete an asset
- [/assets/:assetId/cdnLink](https://developer.air.inc/reference/post_v1-assets-assetid-cdnlink.md): Create an evergreen CDN link for an asset (deprecated — use POST /cdnLinks)
- [/assets/:assetId/cdnLinks](https://developer.air.inc/reference/get_v1-assets-assetid-cdnlinks.md): List all CDN links for an asset
- [/assets/:assetId/cdnLinks](https://developer.air.inc/reference/post_v1-assets-assetid-cdnlinks.md): Create a CDN link for an asset (evergreen or version-pinned)
- [/assets/:assetId/cdnLinks/:cdnLinkId](https://developer.air.inc/reference/patch_v1-assets-assetid-cdnlinks-cdnlinkid.md): Activate or deactivate a CDN link
- [/assets/:assetId/customfields/:customFieldId](https://developer.air.inc/reference/put_v1-assets-assetid-customfields-customfieldid.md): Set or unset custom field value(s) on an asset
- [/assets/:assetId/versions](https://developer.air.inc/reference/get_v1-assets-assetid-versions.md): Get a list of asset versions associated with an asset. Sorted by newest version first (highest internal version number). Note: version isn't returned in the response.
- [/assets/:assetId/versions/:versionId](https://developer.air.inc/reference/get_v1-assets-assetid-versions-versionid.md): Get an asset version associated with an asset, including metadata fields like `IPTC` and `EXIF`.
- [/assets/:assetId/versions/:versionId](https://developer.air.inc/reference/patch_v1-assets-assetid-versions-versionid.md): Update an asset version
- [/assets/:assetId/versions/:versionId/download](https://developer.air.inc/reference/get_v1-assets-assetid-versions-versionid-download.md): Get the download URL of an asset version
- [/assets/:assetId/versions/:versionId/cdnLink](https://developer.air.inc/reference/post_v1-assets-assetid-versions-versionid-cdnlink.md): Create a version-pinned CDN link for an asset (deprecated — use POST /cdnLinks)
- [/assets/:assetId/versions/:versionId/tags](https://developer.air.inc/reference/post_v1-assets-assetid-versions-versionid-tags.md): Add a tag to an asset version
- [/assets/:assetId/versions/:versionId/tags/:tagId](https://developer.air.inc/reference/delete_v1-assets-assetid-versions-versionid-tags-tagid.md): Delete a tag from an asset version
- [/assets/:assetId/boards](https://developer.air.inc/reference/get_v1-assets-assetid-boards.md): Get the list of parent boards of an asset. Sorted by createdAt descending (most recently created board first).
- [/boards](https://developer.air.inc/reference/get_v1-boards.md): Get the list of boards defined in an Air workspace. Sorted by updatedAt descending (most recently updated board first).
- [/boards](https://developer.air.inc/reference/post_v1-boards.md): Create a board at the top-level of the workspace or as a child of another board
- [/boards/:boardId](https://developer.air.inc/reference/get_v1-boards-boardid.md): Get a board
- [/boards/:boardId](https://developer.air.inc/reference/patch_v1-boards-boardid.md): Update one or more properties on a board
- [/boards/:boardId](https://developer.air.inc/reference/delete_v1-boards-boardid.md): Delete a board and any assets that are only contained in this board or its direct descendant boards.
- [/boards/:boardId/customfields/:customFieldId](https://developer.air.inc/reference/put_v1-boards-boardid-customfields-customfieldid.md): Set or unset custom field value(s) on a board
- [/boards/:boardId/assets](https://developer.air.inc/reference/post_v1-boards-boardid-assets.md): Associates one or more assets to a board
- [/boards/:boardId/assets/:assetId](https://developer.air.inc/reference/delete_v1-boards-boardid-assets-assetid.md): Removes an asset from a board
- [/boards/:boardId/guests](https://developer.air.inc/reference/get_v1-boards-boardid-guests.md): Get the list of guests of the board. Accepted guests are returned first, followed by pending invitations. Returns a maximum of 200 guests (pagination is not supported for this endpoint).
- [/boards/:boardId/guests](https://developer.air.inc/reference/post_v1-boards-boardid-guests.md): Add a guest to the board.
- [/boards/:boardId/guests/:guestId](https://developer.air.inc/reference/patch_v1-boards-boardid-guests-guestid.md): Change the role of a guest.
- [/boards/:boardId/guests/:guestId](https://developer.air.inc/reference/delete_v1-boards-boardid-guests-guestid.md): Remove a guest from the board.
- [/libraries](https://developer.air.inc/reference/get_v1-libraries.md): Get the list of libraries in an Air workspace.
- [/libraries](https://developer.air.inc/reference/post_v1-libraries.md): Create a library.
- [/libraries/:libraryId](https://developer.air.inc/reference/get_v1-libraries-libraryid.md): Get a library.
- [/libraries/:libraryId](https://developer.air.inc/reference/patch_v1-libraries-libraryid.md): Update one or more properties on a library.
- [/libraries/:libraryId](https://developer.air.inc/reference/delete_v1-libraries-libraryid.md): Delete a library.
- [/customfields](https://developer.air.inc/reference/get_v1-customfields.md): List custom fields. Sorted by custom field position as configured in the app.
- [/customfields](https://developer.air.inc/reference/post_v1-customfields.md): Create a custom field (maximum total allowed per workspace: `100`)
- [/customfields/:customFieldId](https://developer.air.inc/reference/get_v1-customfields-customfieldid.md): Get a custom field
- [/customfields/:customFieldId:](https://developer.air.inc/reference/patch_v1-customfields-customfieldid.md): Update one or more properties on a custom field
- [/customfields/:customFieldId:](https://developer.air.inc/reference/delete_v1-customfields-customfieldid.md): Delete a custom field
- [/customfields/:customFieldId:/values](https://developer.air.inc/reference/post_v1-customfields-customfieldid-values.md): Add a new value to a `single-select` or `multi-select` custom field.
- [/customfields/:customFieldId:/values/:valueId](https://developer.air.inc/reference/patch_v1-customfields-customfieldid-values-valueid.md): Update the name of a custom field value
- [/customfields/:customFieldId:/values/:valueId](https://developer.air.inc/reference/delete_v1-customfields-customfieldid-values-valueid.md): Delete a value off of a custom field
- [/tags](https://developer.air.inc/reference/get_v1-tags.md): List tags in the workspace. Sorted by name ascending (alphabetical).
- [/tags](https://developer.air.inc/reference/post_v1-tags.md): Create a new tag
- [/tags/:tagId](https://developer.air.inc/reference/patch_v1-tags-tagid.md): Update the name of a tag
- [/tags/:tagId](https://developer.air.inc/reference/delete_v1-tags-tagid.md): Delete a tag
- [/uploads](https://developer.air.inc/reference/post_v1-uploads.md): Upload an asset to a workspace
- [uploads/uploadPart](https://developer.air.inc/reference/post_v1-uploads-uploadpart.md): Create a part upload url
- [uploads/completeMultipart](https://developer.air.inc/reference/post_v1-completemultipart.md): Complete a large file upload
- [/imports](https://developer.air.inc/reference/post_v1-imports.md): Create an import of an asset or asset version from a public URL.
- [/imports/:importId/status](https://developer.air.inc/reference/get_v1-imports-importid-status.md): Retrieve the status of a specific import by providing the import ID in the URL.
- [/roles](https://developer.air.inc/reference/get_v1-roles.md): Get the list of guest roles available in a workspace. Sorted by type ascending.
- [/workspaces](https://developer.air.inc/reference/get_v1-workspaces.md): List the workspaces the authenticated user can view. Bearer-token only; does not require the workspace ID header.