Opal

Opal Asset References API

## 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.

Documentation GitHub OpenAPI

Operations 4

POST /api/v1/asset_references Create an asset reference, optionally associated with Opal objects #

GET /api/v1/asset_references/{asset_reference_id} Get an asset reference available to the authenticated user #

PATCH /api/v1/asset_references/{asset_reference_id} Updates an asset reference and its associations with Opal objects #

DELETE /api/v1/asset_references/{asset_reference_id} Deletes an asset reference #

Documentation

📖

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

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-asset-references-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/opal-asset-references-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: 2.0.0
  title: Opal Asset References API
  license:
    name: Opal API License
    url: https://www.workwithopal.com/api-license
  description: The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
servers:
- url: https://login.ouropal.com
tags:


# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-asset-references-api-openapi.yml