# Opal Asset References API

**Canonical:** https://apis.io/apis/opal/opal-asset-references-api/  
**Provider:** Opal — https://apis.io/providers/opal/  
**Base URL:** https://login.ouropal.com  
**Documentation:** https://login.ouropal.com/api/documentation/v2

Opal Asset References API is one of 79 APIs that [Opal](https://apis.io/providers/opal/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Asset References. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

## Asset References Overview In Opal, you create `assets` to represent files uploaded to the platform and `asset_references` to surface those assets for use in the Asset Library, Moments, Content, and more. Before reading into the Asset Reference endpoints, look over the [Assets documentation](#tag/Assets). Once you've created an Asset, use its `id` as the `asset_uuid` for a new Asset Reference. You'll also likely also want to at least copy the Asset's `file_name`, `bytes`, and `url` over to the new Asset Reference (into the `filename`, `filesize`, and `full_url` fields, respectively). The one relationship that you probably want to make sure all of your new Asset References have is `brand`. The Brand (also known as the Workspace) must be specified for an Asset Reference to be available for use within the workspace you choose; it won't even show up in the Asset Library without a Workspace association.

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-asset-references-api-openapi.yml
- **Documentation** — https://login.ouropal.com/api/documentation/v2
- **APIReference** — https://login.ouropal.com/api/documentation/v2
- **Documentation** — https://login.ouropal.com/api/documentation/v3
- **APIReference** — https://login.ouropal.com/api/documentation/v3
- **Documentation** — https://login.ouropal.com/api/documentation/asgard_bff

## Other Opal APIs (12)

- [Opal Accounts API](https://apis.io/apis/opal/opal-accounts-api/)
- [Opal Activities API](https://apis.io/apis/opal/opal-activities-api/)
- [Opal Annotations API](https://apis.io/apis/opal/opal-annotations-api/)
- [Opal Asset Reference Options API](https://apis.io/apis/opal/opal-asset-reference-options-api/)
- [Opal Asset Reference Usage Rights Options API](https://apis.io/apis/opal/opal-asset-reference-usage-rights-options-api/)
- [Opal Assets API](https://apis.io/apis/opal/opal-assets-api/)
- [Opal Block Connectors API](https://apis.io/apis/opal/opal-block-connectors-api/)
- [Opal Block Custom Field Values API](https://apis.io/apis/opal/opal-block-custom-field-values-api/)
- [Opal Block Duplication API](https://apis.io/apis/opal/opal-block-duplication-api/)
- [Opal Blocks API](https://apis.io/apis/opal/opal-blocks-api/)
- [Opal Board Collaborators API](https://apis.io/apis/opal/opal-board-collaborators-api/)
- [Opal Board Columns API](https://apis.io/apis/opal/opal-board-columns-api/)

## Tags

Asset References

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/opal/opal-asset-references-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/opal/.
