Every API here is available over the APIs.io API and to AI agents over MCP.
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](https://tools.ietf.org/html/bcp14) [[RFC2119](https://tools.ietf.org/html/rfc2119)] [[RFC8174](https://tools.ietf.org/html/rfc8174)] when, and only when, they appear in all capitals, as shown here.\n\n# Other API Versions\n\nThe [v3 API](/api/documentation/v3) is less complete than the v2 API, and is still a work in progress. Currently, if a resource has endpoints in both the v2 API and the v3 API you **SHOULD** use the v2 API endpoints. At some point in the future we will recommend the v3 API instead.\n\n# Documentation Organization\n\nv2 API endpoints are categorized by stability:\n\n1. JSON:API\n2. Other\n3. Unstable\n4. Proposed\n\nv2 API endpoints in the “JSON:API”, “Unstable”, and “Proposed” categories are [JSON:API](https://jsonapi.org)-compliant ([specification](https://jsonapi.org/format/)) and can be used with any [JSON:API-compliant client](https://jsonapi.org/implementations/).\n\n<aside>\n\nTo strictly comply with the JSON:API specification your requests for endpoints in the “JSON:API”, “Unstable”, and “Proposed” categories **MUST** set the `Accept` HTTP header to `application/vnd.api+json`. The server response’s `Content-Type` HTTP header will also be `application/vnd.api+json`.\n\nYou **SHOULD** use `application/vnd.api+json` for maximum stability, but v2 API endpoints **MAY** allow the `Accept` HTTP header to be `application/json`; if so, the response’s `Content-Type` HTTP header will be `application/json`. This support for `application/json` **MAY** disappear from a given endpoint at any time, and is not available on all endpoints.\n</aside>\n\n“Other” endpoints are stable, but do not follow the JSON:API specification. (Some “Other” endpoints have data that resembles the JSON:API structure, but **MUST** be parsed as generic JSON.) Your requests **MUST** set the `Accept` HTTP header to `application/json`, and the response’s `Content-Type` HTTP header will be `application/json`.\n\n## Unstable Endpoints\n\n*Note:* This generally refers resources in the “Unstable” category, but includes endpoints with a summary that’s prefixed by `[UNSTABLE]`. These `[UNSTABLE]` endpoints may be part of a “Stable” resource.\n\nThe data structure and behavior of “Unstable” endpoints are not guaranteed, and we **MAY** change them at any time. You **MUST NOT** use these endpoints for production features, but **MAY** use them as a preview of upcoming features, and we welcome feedback.\n\n## Proposed Endpoints\n\n“Proposed” endpoints **MUST NOT** be used (they’re not yet implemented), and we **MAY** change or remove them at any time. We publish them at our discretion to share our plans and encourage internal feedback. We also welcome your feedback.\n\n# Design Principles\n\n## Breaking Changes\n\nWe **MAY** expand the data for “JSON:API” and “Other” resources, but will not change or remove existing attributes or relationships for these resources. These expansions should not require any changes to your code.\n\nWe provide no guarantees for “Unstable” and “Proposed” endpoints.\n\n## Firehose Rule\n\nBy default endpoints include all the relevant data that’s accessible to the authenticated user. Clients **MAY** specify filters, ordering, pagination, sparse fields, and other limiting mechanisms to pare down the desired data.\n\n*Note:* Existing endpoints **MAY NOT** follow this maximalist approach, but new endpoints will, and we **MAY** enhance existing endpoints.\n\n## Obscurity\n\nIn order to provide customers with as much privacy as possible, many API calls that fail authorization will return `404 Not Found` rather than `403 Forbidden`. Do not design frontends around the expectation that a `404 Not Found` status code means a resource would not be returned given different authentication credentials.\n\n# Authentication Strategies\n## OAuth 2.0\nOpal uses OAuth 2.0 (https://oauth.net/2) to authenticate users and grant access to protected resources. After registering your application as an OAuth client, you must get permission from each user before accessing their account.\n\nThe main steps are:\n\n1. Register your application\n2. Direct the user to Opal, to authorize your application\n3. Opal confirm's user identity, and asks the user to grant your application permissions\n4. Opal issues tokens your application can use to access the user's Opal resources\n5. Your application can begin making requests to the Opal API on behalf of the user\n\n### Roles\n#### Client\nThe 3rd-party application accessing the API on behalf of the User.\n\n#### API\nAPI endpoints used to interact with a User's resources in Opal.\n\n#### User\nThe person authorizing the Client to access to their Opal account.\n\n### Registering your application\nApplication registration is currently a manual process.\n\nTo begin, you will need to provide the following information to the Opal integrations team:\n\n- Application name\n- Logo URI\n- Redirect URI\n\nIn return, expect to receive:\n\n- Client ID\n - public\n- Application secret\n - keep this private\n - keep this written down someplace safe. Opal cannot retrieve this for you if it is lost.\n\n### Authorization\nFor a Client to make API requests on behalf of Users, the User must first give consent.\nHere is an overview of the consent flow:\n\n1. Direct the User to grant access in Opal\n\n```\nhttps://login.ouropal.com/oauth2/auth?grant_type=authorization_code&scope=offline_access&response_type=code&client_id={client_id}&state={state}&redirect_uri={url_encoded_redirect}\n```\n\nParameters:\n- `client_id`: Provided by Opal.\n- `grant_type`: Set the value to authorization_code to receive a code string that can be exchanged for an access token.\n- `redirect_uri`: Defined by Client. After authentication, the user will be directed to this location.\n- `response_type`: The value code should be set for refresh tokens to be issued.\n- `scope`: The value offline_access must be present if you wish to use refresh tokens.\n- `state`: Defined by the Client. A unique value used to validate the response.\n\n\n2. If logged out, User is directed to log in to Opal\n\n3. User is redirected to consent page (if the User has not already given consent)\n\n```\nhttps://login.ouropal.com/oauth2/consent?consent_challenge=abc123\n```\n\n4. If the User grants permission, User is sent to the specified `redirect_uri`\n\n```\nhttps://example.com/defined-by-client?code=Mu9z2DndN7TfXSLaf99O8ReqqXqMabXhSqP5e0jlx_Q.naLKbko-GyfPJRGYcWyclxU0sBGwygPy05OSFww0XZ8&scope=offline_access&state={state}\n```\n\nParameters:\n- `code`: The Client may use this to get an access token.\n- `scope`: API permissions granted to the Client by the User.\n- `state`: The validation string provided by the Client in step 1.\n\nIf the User declines the consent prompt, User will be sent to the same `redirect_uri`, but with an error parameter :\n\n```\nhttps://example.com/defined-by-client?error=consent+request+denied&state={state}\n```\n\nParameters:\n- `error`: A brief description of the issue.\n- `state`: The validation string provided by the Client in step 1.\n\n### Retrieving Access Token\nYou must make a POST request to the token endpoint to get an access token, before the code expires:\n\n```\ncurl -X POST \\\n https://login.ouropal.com/oauth2/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'code={code}&client_id={client_id}&redirect_uri={url_encoded_redirect}&client_secret={client_secret}&grant_type=authorization_code'\n```\n\nParameters:\n- `code`\n- `client_id`: Client ID provided by Opal.\n- `client_secret`: Client secret provided by Opal.\n- `grant_type`: Set value to authorization_code .\n- `redirect_uri`: Optional.\n\nIf successful, a JSON-formatted response body will contain the access_token and refresh_token:\n\n```json\n{\n \"access_token\":\"ABC123\",\n \"token_type\":\"bearer\",\n \"expires_in\":3600,\n \"refresh_token\":\"DEF456\",\n \"scope\":\"offline_access\"\n}\n```\n\n### Refreshing an Access Token\nOnce the access_token expires, you may generate a new one at the same token endpoint, but with different parameters.\nNote that in this request, a \"refresh_token\" parameter is used instead of \"code\", and the \"grant_type\" value is now \"refresh_token\" instead of \"authorization_code\".\n\n```\ncurl -X POST \\\n https://login.ouropal.com/oauth2/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'refresh_token={refresh_token}&client_id={client_id}&redirect_uri={url_encoded_redirect}&client_secret={secret}&grant_type=refresh_token'\n```\n\nParameters:\n- `client_id`: Client ID provided by Opal.\n- `client_secret`: Client secret provided by Opal.\n- `grant_type`: Set value to refresh_token .\n- `redirect_uri`: Optional.\n- `refresh_token`: Refresh token value\n\n### Making Authenticated Requests\n\nSet an authorization header in your requests, specifying your access token as documented here: https://tools.ietf.org/html/rfc6750#section-2.1.\n\n**NOTE** that the `Authorization` header supercedes the `Session-Token` header described in the documentation for many endpoints. Specifying an `Authorization` header means you do not need to specify a `Session-Token` header.\n\n```\nAuthorization: Bearer ACCESS_TOKEN\n```\n\nFor example:\n```\n GET /resource HTTP/1.1\n Host: server.example.com\n Authorization: Bearer mF_9.B5f-4.1JqM\n```\n\n### Client Revoke/Rolling OAuth secrets\nClient secrets must be kept secret and not exposed outside of the token retrieval requests. If a secret has been potentially compromised, please notify Opal as soon as possible and let us know the OAuth client id associated with the secret. We will roll/update the secret, which will invalidate all existing access and refresh tokens. Invalidating tokens will cause users to need to reauthenticate, but consent should be remembered.\n"
servers:
- url: https://login.ouropal.com
tags:
- name: Asset References
description: '## 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.
'
paths:
/api/v1/asset_references:
post:
tags:
- Asset References
operationId: CreateAssetReferenceV1
summary: Create an asset reference, optionally associated with Opal objects.
security:
- oauth2:
- offline_access
- api_key:
- Session-Token
requestBody:
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
required:
- type
- attributes
- relationships
properties:
type:
type: string
enum:
- asset_reference
attributes:
type: object
required:
- asset_uuid
- filename
- filesize
- full_url
properties:
asset_type:
type: string
description: 'This field is semi-open ended but should be set to `image`, `audio`,
or `video` for those respective types of media and `file` for most
other types of media.
'
asset_source:
type:
- string
- 'null'
description: 'Asset Sources are pre-existing records indicating the origin of an
asset reference. You can''t set this field to arbitrary values. If you
know of an Asset Source and you''d like to indicate a new asset
reference originated with that source, this field should contain that
source''s name.
'
asset_uuid:
type: string
description: 'The `id` of an `asset` resource this asset reference will surface
within the Asset Library.
'
content_type:
type: string
description: 'This field was used by some legacy systems. It is exposed for
historical reasons. If set, setting it to the same value as
`asset_type` is generally a good idea. It is not a MIME type.
'
description:
type: string
format:
type: string
description: 'Used differently by some legacy systems but any new asset reference
should use the `format` field to store its filetype extension (ex. `png`,
`mp4`, `gif`, `mov`, etc.).
'
filename:
type: string
filesize:
type: integer
description: Size of file in bytes.
full_url:
type: string
description: 'When associating an asset with an asset reference, this field
should be set to the `url` property of the asset.
'
meta_data:
type: object
description: Can contain arbitrary key-value pairs related to the asset.
additionalProperties:
type: string
original_url:
type: string
public_id:
type: string
width:
type: integer
description: 'When associating an asset with an asset reference, this field
should be set to the `width` of the asset.
'
height:
type: integer
description: 'When associating an asset with an asset reference, this field
should be set to the `height` of the asset.
'
uuid:
type: string
s3_response:
type: string
relationships:
type: object
properties:
brand:
type: object
required:
- data
additionalProperties: false
properties:
data:
type:
- object
- 'null'
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
type:
type: string
enum:
- brand
stories:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: array
items:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
type:
type: string
enum:
- story
labels:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: array
items:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
type:
type: string
enum:
- label
responses:
'201':
description: A newly created asset reference.
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
title: asset_reference
type: object
required:
- id
- attributes
- type
- relationships
additionalProperties: false
properties:
id:
type: string
pattern: ^[0-9]+$
type:
type: string
enum:
- asset_reference
attributes:
type: object
required:
- asset_type
- asset_uuid
- content_type
- format
- filename
- escaped_filename
- filesize
- full_url
- meta_data
- original_url
- preview_url
- public_id
- width
- height
- uuid
additionalProperties: false
properties:
asset_type:
type:
- string
- 'null'
description: 'This field is semi-open ended but should be set to `image`, `audio`,
or `video` for those respective types of media and `file` for most
other types of media.
'
asset_source:
type:
- string
- 'null'
description: 'Asset Sources are pre-existing records indicating the origin of an
asset reference. You can''t set this field to arbitrary values. If you
know of an Asset Source and you''d like to indicate a new asset
reference originated with that source, this field should contain that
source''s name.
'
asset_uuid:
type:
- string
- 'null'
description: 'The `id` of an `asset` resource this asset reference will surface
within the Asset Library.
'
content_type:
type:
- string
- 'null'
description: 'This field was used by some legacy systems. It is exposed for
historical reasons. If set, setting it to the same value as
`asset_type` is generally a good idea. It is not a MIME type.
'
description:
type:
- string
- 'null'
format:
type:
- string
- 'null'
description: 'Used differently by some legacy systems but any new asset reference
should use the `format` field to store its filetype extension (ex. `png`,
`mp4`, `gif`, `mov`, etc.).
'
filename:
type:
- string
- 'null'
escaped_filename:
type: string
readOnly: true
filesize:
type:
- integer
- 'null'
description: Size of file in bytes.
full_url:
type:
- string
- 'null'
description: 'When associating an asset with an asset reference, this field
should be set to the `url` property of the asset.
'
meta_data:
type:
- object
- 'null'
description: Can contain arbitrary key-value pairs related to the asset.
properties:
duration:
type: string
description: Parsed from video assets.
page_count:
type: string
description: Parsed from PDF assets.
processed_height:
type: string
description: Parsed from video assets.
processed_width:
type: string
description: Parsed from video assets.
additionalProperties:
type: string
original_url:
type:
- string
- 'null'
preview_url:
type:
- string
- 'null'
readOnly: true
public_id:
type:
- string
- 'null'
width:
type:
- integer
- 'null'
description: 'When associating an asset with an asset reference, this field
should be set to the `width` of the asset.
'
height:
type:
- integer
- 'null'
description: 'When associating an asset with an asset reference, this field
should be set to the `height` of the asset.
'
uuid:
type: string
readOnly: true
description: 'Use this ID when referring to the same asset reference from one of
Opal''s v3 APIs.
'
relationships:
type: object
additionalProperties: false
properties:
brand:
type: object
required:
- data
additionalProperties: false
properties:
data:
type:
- object
- 'null'
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
type:
type: string
enum:
- brand
stories:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: array
items:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
type:
type: string
enum:
- story
cover_asset_reference:
type: object
required:
- data
additionalProperties: false
properties:
data:
type:
- object
- 'null'
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
type:
type: string
enum:
- asset_reference
labels:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: array
items:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
type:
type: string
enum:
- label
asset_reference_options:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: array
items:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
type:
type: string
enum:
- asset_reference_option
options:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: array
items:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
type:
type: string
enum:
- option
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
properties:
errors:
type: array
items:
type: object
properties:
status:
type: string
title:
type: string
detail:
type: string
required:
- status
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-asset-references-api-openapi.yml