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 Assets 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: Assets
description: '## Assets Overview
Assets represent images, videos, PDFs, and any other file uploads. Any upload to
the Opal platform must start with an `asset`. Some resources like `boards` can be
directly related to an `asset` while other resources like `moments` require that
you also create an `asset_reference` that further describes your `asset`.
Assets can either be created by uploading data directly or by creating a Url
Upload that requests an asset from some other publicly available web address and
streams it to Opal. The former endpoint is described immediately below and the
latter option can be found under the [Url Uploads](#tag/Url-Uploads) tag.
Once you''ve created an Asset and you have its `id`, you''ll likely want to create
an [Asset Reference](#tag/Asset-References) as well, unless you don''t want your asset exposed in the
Asset Library or used with other resources you''ll find to have asset reference
relationships.
'
paths:
/assets/v2:
post:
tags:
- Assets
operationId: CreateAssetV2
summary: Upload an asset available to the authenticated user.
security:
- oauth2:
- offline_access
- api_key:
- Session-Token
parameters:
- in: header
name: X-File-Name
schema:
type: string
required: true
description: This header must contain the desired filename including file extension. If the client does not support sending UTF-8 Unicode characters, it may Base64 encode this value, which the server will decode.
requestBody:
description: The request body should be the file binary itself passed as application/octet-stream. This endpoint does not currently support multipart uploads.
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
'201':
description: A single asset with basic metadata.
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
title: asset
type: object
required:
- id
- type
- attributes
- relationships
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- asset
attributes:
type: object
required:
- bytes
- created_at
- download_url_override
- duration
- file_extension
- file_name
- height
- mime_type
- updated_at
- url
- width
additionalProperties: false
properties:
url:
type: string
download_url_override:
type:
- string
- 'null'
description: 'An alternative download URL for the file. If set, downloading the
asset will result in a redirect to the overridden location instead of
downloading the asset data directly. When not present, `url` should
be used.
'
width:
type:
- integer
- 'null'
description: When applicable, the width in pixels of an image or video.
height:
type:
- integer
- 'null'
description: When applicable, the height in pixels of an image or video.
duration:
type:
- integer
- 'null'
description: When applicable, the play time of a video in seconds.
pages:
type:
- integer
- 'null'
description: When applicable, the number of pages in a PDF document.
mime_type:
type: string
description: The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) that corresponds to the uploaded file.
file_name:
type: string
file_extension:
type: string
bytes:
type: integer
description: The size of the file in bytes.
created_at:
type: string
format: date-time
description: An ISO8601 date-time.
readOnly: true
updated_at:
type: string
format: date-time
description: An ISO8601 date-time.
readOnly: true
relationships:
required:
- opal
type: object
additionalProperties: false
properties:
opal:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
type:
type: string
enum:
- opal
'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
required:
- errors
properties:
errors:
type: array
items:
type: object
properties:
status:
type: string
title:
type: string
detail:
type: string
required:
- status
'422':
description: Unprocessable entity
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
get:
tags:
- Assets
operationId: GetAssetsV2
summary: '[UNSTABLE] Get a collection of assets available to the authenticated user.'
security:
- oauth2:
- offline_access
- api_key:
- Session-Token
parameters:
- name: filter
in: query
description: 'Filters for limiting the results.
'
required: false
schema:
type: object
properties:
id:
type: array
description: 'The IDs of the resources that should be returned.
Comma separated list of IDs. If included, will only attempt to fetch resources matching those IDs. (Note that some or all resources may not be available.) If not included, will return all resources matching the other provided filters. For example, `filter[id]=798ac6d9-b3fc-4155-88ee-237f43f3404b` will fetch the resource with id `798ac6d9-b3fc-4155-88ee-237f43f3404b`, while `filter[id]=798ac6d9-b3fc-4155-88ee-237f43f3404b,d79e513e-9246-454e-80bf-8268bc39cd6e,f2b19a4a-ba0c-49be-8aa7-a1bf68a4a4ed` will fetch each of the resources with the ids `798ac6d9-b3fc-4155-88ee-237f43f3404b`, `d79e513e-9246-454e-80bf-8268bc39cd6e`, or `f2b19a4a-ba0c-49be-8aa7-a1bf68a4a4ed`.
'
items:
type: string
format: uuid
created_at:
type: object
description: 'Filter for exact dates or for dates greater than or less than a given date.
Supports the comparison operators: `eq` (equal to), `gt` (greater than),
`gteq` (greater than or equal to), `lt` (less than), and `lteq` (less than or
equal to).
Filters are formatted as `filter[created_at][gt]=2025-01-01T12:01:00Z` where
`created_at` is the field you want to filter on, `gt` is the operator, and
`2025-01-01T12:01:00Z` can be either a date or date-time value.
If no operator is specified, `eq` is assumed but date values without time
components will have the semantics of matching all records "on the same day"
as the given date. For example, `filter[created_at]=2025-01-01T12:01:00Z` is
equivalent to `filter[created_at][eq]=2025-01-01T12:01:00Z` which will only
match that exact date and time. Alternatively,
`filter[created_at]=2025-01-01` has the semantics "greater than midnight on
2025-01-01 and less than midnight on 2025-01-02."
'
properties:
eq:
type: string
description: 'Equal to filter. If no other filter is specified, `eq` will be assumed.
'
gt:
type: string
description: Greater than filter
gteq:
type: string
description: Greater than or equal to filter
lt:
type: string
description: Less than filter
lteq:
type: string
description: Less than or equal to filter
updated_at:
type: object
description: 'Filter for exact dates or for dates greater than or less than a given date.
Supports the comparison operators: `eq` (equal to), `gt` (greater than),
`gteq` (greater than or equal to), `lt` (less than), and `lteq` (less than or
equal to).
Filters are formatted as `filter[created_at][gt]=2025-01-01T12:01:00Z` where
`created_at` is the field you want to filter on, `gt` is the operator, and
`2025-01-01T12:01:00Z` can be either a date or date-time value.
If no operator is specified, `eq` is assumed but date values without time
components will have the semantics of matching all records "on the same day"
as the given date. For example, `filter[created_at]=2025-01-01T12:01:00Z` is
equivalent to `filter[created_at][eq]=2025-01-01T12:01:00Z` which will only
match that exact date and time. Alternatively,
`filter[created_at]=2025-01-01` has the semantics "greater than midnight on
2025-01-01 and less than midnight on 2025-01-02."
'
properties:
eq:
type: string
description: 'Equal to filter. If no other filter is specified, `eq` will be assumed.
'
gt:
type: string
description: Greater than filter
gteq:
type: string
description: Greater than or equal to filter
lt:
type: string
description: Less than filter
lteq:
type: string
description: Less than or equal to filter
style: deepObject
explode: true
- name: page
description: Specify an offset and limit for pagination
in: query
required: false
schema:
type: object
properties:
limit:
type: integer
default: 50
offset:
type: integer
style: deepObject
explode: true
responses:
'200':
description: A collection of assets
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: array
items:
title: asset
type: object
required:
- id
- type
- attributes
- relationships
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- asset
attributes:
type: object
required:
- bytes
- created_at
- download_url_override
- duration
- file_extension
- file_name
- height
- mime_type
- updated_at
- url
- width
additionalProperties: false
properties:
url:
type: string
download_url_override:
type:
- string
- 'null'
description: 'An alternative download URL for the file. If set, downloading the
asset will result in a redirect to the overridden location instead of
downloading the asset data directly. When not present, `url` should
be used.
'
width:
type:
- integer
- 'null'
description: When applicable, the width in pixels of an image or video.
height:
type:
- integer
- 'null'
description: When applicable, the height in pixels of an image or video.
duration:
type:
- integer
- 'null'
description: When applicable, the play time of a video in seconds.
pages:
type:
- integer
- 'null'
description: When applicable, the number of pages in a PDF document.
mime_type:
type: string
description: The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) that corresponds to the uploaded file.
file_name:
type: string
file_extension:
type: string
bytes:
type: integer
description: The size of the file in bytes.
created_at:
type: string
format: date-time
description: An ISO8601 date-time.
readOnly: true
updated_at:
type: string
format: date-time
description: An ISO8601 date-time.
readOnly: true
relationships:
required:
- opal
type: object
additionalProperties: false
properties:
opal:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
type:
type: string
enum:
- opal
meta:
type: object
required:
- total
- page
- resource_type
properties:
resource_type:
type: string
total:
type: integer
page:
type: object
required:
- limit
- offset
properties:
limit:
type: integer
offset:
type: integer
'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
required:
- errors
properties:
errors:
type: array
items:
type: object
properties:
status:
type: string
title:
type: string
detail:
type: string
required:
- status
/assets/v2/{asset_id}:
get:
tags:
- Assets
operationId: GetAssetV2
summary: Get an assets metadata
security:
- oauth2:
- offline_access
- api_key:
- Session-Token
parameters:
- name: asset_id
in: path
required: true
description: The ID of the Asset
schema:
type: string
responses:
'200':
description: An single asset reference.
content:
application/json:
schema:
# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-assets-api-openapi.yml