API docs by Redocly

Mediagraph API Documentation (1.2.0)

Download OpenAPI specification:Download

API Support: [email protected] URL: https://www.mediagraph.io/contact License: Apache 2.0 Terms of Service

Authentication

Use your Mediagraph account via API with either a Personal Access Token or OAuth Access Token.

Personal Access Tokens

All endpoints using Personal Access Tokens (besides User specifics) require the OrganizationId header, which can be found in "Profile Settings" when logged into the Organization.

curl -u :YOUR_ACCESS_TOKEN \
  -H "OrganizationId: 100" \
  "https://api.mediagraph.io/api/assets/search?q=sunset"

OAuth Access Tokens

OAuth Access Tokens use the Authorization header and are implicitly associated with the authorized Organization.

curl -H "Authorization: Bearer YOUR_OAUTH_TOKEN" \
  "https://api.mediagraph.io/api/assets/search?q=sunset"

OAuth Handshake URLs

Step Method URL
Authorize GET or POST https://mediagraph.io/oauth/authorize?response_type=code&client_id=...&redirect_uri=...&state=...
Get Refresh Token POST https://mediagraph.io/oauth/token?grant_type=authorization_code&token=...
Revoke Token POST https://mediagraph.io/oauth/revoke?token=...

Pagination & Sorting

List endpoints return paginated results with sorting support:

Parameter Default Description
page 1 Page number
per_page 10 Items per page
sortField varies Column to sort by (see each endpoint for supported values)
sortOrder descend Sort direction: ascend or descend

The total number of records is returned in the Total-Entries response header.

curl -u :YOUR_ACCESS_TOKEN \
  -H "OrganizationId: 100" \
  "https://api.mediagraph.io/api/creator_tags?page=2&per_page=25&sortField=name&sortOrder=ascend"

Access Requests

Access Requests allow users to request access to assets. Grants are a special type of access request where an admin grants access to external users. The workflow supports pending, submitted, and finalized states.

List Access Requests

Returns a paginated list of access requests for the organization.

Authorizations:
Authorization
query Parameters
q
string

Search by name, email, or user

type
string
Enum: "grant" "request"

Filter by type

aasm_state
string
Enum: "pending" "submitted" "finalized"

Filter by state

submitted
string

Filter submitted requests (use 'all' for all states)

sortField
string
Enum: "aasm_state" "submitted_at" "created_at" "request_deadline" "requested_assets_count" "granted_assets_count" "agreed_at"

Sort field

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

Access Request ID

name
string

Request name

aasm_state
string

Current state

is_grant
string

Whether this is a grant

requester_name
string

Requester name

requester_email
string

Requester email

submitted_at
string

Submission timestamp

finalized_at
string

Finalization timestamp

assets_count
string

Number of assets

Response samples

Content type
application/json
[
  • {
    }
]

Create Access Request

Create a new access request or grant. For grants, set is_grant: true and provide requester details.

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
id
string

Created Access Request ID

code
string

Unique access code

Request samples

Content type
application/json
{
  • "access_request": {
    }
}

Response samples

Content type
application/json
{
  • "id": 926561747,
  • "user_id": 1015819300,
  • "workflow_id": null,
  • "aasm_state": "pending",
  • "name": "New Request",
  • "description": null,
  • "submitted_at": null,
  • "finalized_at": null,
  • "finalized_by_id": null,
  • "request_deadline": null,
  • "valid_through": null,
  • "revoked_at": null,
  • "revoked_by_id": null,
  • "requester_email": null,
  • "requester_name": null,
  • "request_lightbox_id": 1073065114,
  • "grant_lightbox_id": null,
  • "created_at": "2026-05-28T19:50:10.145Z",
  • "updated_at": "2026-05-28T19:50:10.179Z",
  • "requested_assets_count": 1,
  • "granted_assets_count": 0,
  • "note": null,
  • "modified_description": null,
  • "requested_image_and_video_permission": "original",
  • "requested_other_permission": "download",
  • "granted_image_and_video_permission": null,
  • "granted_other_permission": null,
  • "to_destroy": null,
  • "is_grant": false,
  • "agreed_at": null,
  • "code": "18d87f8a3e5584c083890def094305a3",
  • "user": {
    },
  • "slug": "926561747-new-request",
  • "managable": true,
  • "finalized_by": null
}

Access Requests Tree

Returns a tree view of access requests grouped by state (pending, submitted, finalized).

Authorizations:
Authorization
query Parameters
parent_id
string
Enum: "pending" "submitted" "finalized"

State to filter by

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Access Request Details

Get details of a specific access request.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
id
string

Access Request ID

name
string

Request name

description
string

Request description

aasm_state
string

Current state

is_grant
string

Whether this is a grant

requester_name
string

Requester name (for grants)

requester_email
string

Requester email (for grants)

request_deadline
string

Request deadline

valid_through
string

Access valid through date

requested_image_and_video_permission
string

Requested permission level for images/videos

requested_other_permission
string

Requested permission level for other files

granted_image_and_video_permission
string

Granted permission level for images/videos

granted_other_permission
string

Granted permission level for other files

code
string

Unique access code

Response samples

Content type
application/json
{
  • "id": 926561744,
  • "user_id": 1015819276,
  • "workflow_id": null,
  • "aasm_state": "pending",
  • "name": "Berkelium",
  • "description": null,
  • "submitted_at": null,
  • "finalized_at": null,
  • "finalized_by_id": null,
  • "request_deadline": null,
  • "valid_through": null,
  • "revoked_at": null,
  • "revoked_by_id": null,
  • "requester_email": null,
  • "requester_name": null,
  • "request_lightbox_id": 1073065041,
  • "grant_lightbox_id": null,
  • "created_at": "2026-05-28T19:49:57.288Z",
  • "updated_at": "2026-05-28T19:49:57.310Z",
  • "requested_assets_count": 1,
  • "granted_assets_count": 0,
  • "note": null,
  • "modified_description": null,
  • "requested_image_and_video_permission": "original",
  • "requested_other_permission": "original",
  • "granted_image_and_video_permission": null,
  • "granted_other_permission": null,
  • "to_destroy": null,
  • "is_grant": false,
  • "agreed_at": null,
  • "code": "fa69edda1c6c099a4882c01770c15abb",
  • "user": {
    },
  • "slug": "926561744-berkelium",
  • "managable": true,
  • "finalized_by": null
}

Update Access Request

Update an access request. Different fields are editable depending on state.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "access_request": {
    }
}

Response samples

Content type
application/json
{
  • "organization_id": 1071574457,
  • "id": 926561748,
  • "user_id": 1015819312,
  • "workflow_id": null,
  • "aasm_state": "pending",
  • "name": "Updated Request Name",
  • "description": null,
  • "submitted_at": null,
  • "finalized_at": null,
  • "finalized_by_id": null,
  • "request_deadline": null,
  • "valid_through": null,
  • "revoked_at": null,
  • "revoked_by_id": null,
  • "requester_email": null,
  • "requester_name": null,
  • "request_lightbox_id": 1073065150,
  • "grant_lightbox_id": null,
  • "created_at": "2026-05-28T19:50:16.598Z",
  • "updated_at": "2026-05-28T19:50:17.068Z",
  • "email": null,
  • "code": "ef7e4206c1a4f53e74816f797e06bfec",
  • "modified_description": null,
  • "note": null,
  • "requested_image_and_video_permission": "original",
  • "requested_other_permission": "original",
  • "granted_image_and_video_permission": null,
  • "granted_other_permission": null,
  • "parent_access_request_id": null,
  • "is_grant": false,
  • "agreed_at": null
}

Delete Access Request

Delete a pending access request.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Find Access Request

Find an access request by ID or code. Public users can only find finalized requests by code.

Authorizations:
Authorization
query Parameters
id
required
string

Access request ID or code

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "access_request": {
    },
  • "asset_group": {
    },
  • "editable": true,
  • "managable": true
}

Submit Access Request

Submit a pending access request for review.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 926561749,
  • "user_id": 1015819324,
  • "workflow_id": 1014085959,
  • "aasm_state": "submitted",
  • "name": "Flerovium",
  • "description": null,
  • "submitted_at": "2026-05-28T19:50:23.126Z",
  • "finalized_at": null,
  • "finalized_by_id": null,
  • "request_deadline": null,
  • "valid_through": null,
  • "revoked_at": null,
  • "revoked_by_id": null,
  • "requester_email": null,
  • "requester_name": null,
  • "request_lightbox_id": 1073065186,
  • "grant_lightbox_id": null,
  • "created_at": "2026-05-28T19:50:22.709Z",
  • "updated_at": "2026-05-28T19:50:23.149Z",
  • "requested_assets_count": 1,
  • "granted_assets_count": 0,
  • "note": null,
  • "modified_description": null,
  • "requested_image_and_video_permission": "original",
  • "requested_other_permission": "original",
  • "granted_image_and_video_permission": "original",
  • "granted_other_permission": "original",
  • "to_destroy": null,
  • "is_grant": false,
  • "agreed_at": null,
  • "code": "1ed73f49b44299626099976de5c52058",
  • "user": {
    },
  • "slug": "926561749-flerovium",
  • "managable": true,
  • "finalized_by": null
}

Asset Data Versions

Asset Data Versions resources.

Get Asset Data Versions

Get versions for an Asset.

Authorizations:
Authorization
query Parameters
asset_id
integer
Example: asset_id=1060943027

Asset ID

include_renditions
boolean
Example: include_renditions=true

Include list of downloadable sizes and formats

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[]

Get Asset Data Version Details

Get version details for Asset using the Version number.

Authorizations:
Authorization
query Parameters
asset_id
integer
Example: asset_id=1060943028

Asset ID

number
integer
Example: number=2

Asset Data Version Number

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1061584916,
  • "asset_id": 1060943028,
  • "user_id": 1015819370,
  • "number": 2,
  • "file_size": null,
  • "width": null,
  • "height": null,
  • "filename": "odit.ods",
  • "ppi": null,
  • "captured_at": null,
  • "meta": null,
  • "duration": null,
  • "frame_rate": null,
  • "md5": null,
  • "ext": "ods",
  • "created_via": null,
  • "previews_generated_at": null,
  • "thumbs_count": null,
  • "created_at": "2026-05-28T19:50:43.283Z",
  • "updated_at": "2026-05-28T19:50:43.283Z",
  • "thumb_url": null,
  • "is_head": true,
  • "aasm_state": "pending",
  • "user": {
    },
  • "grid_url": null,
  • "type": "Document",
  • "mime_type": "application/vnd.oasis.opendocument.spreadsheet",
  • "created_via_id": null,
  • "created_via_meta": null,
  • "is_version": true,
  • "storage_folder_path": "message-galaxy12",
  • "full_url": null
}

Assets

Asset resources.

Search Assets

Searches all Assets you have access to in the Organization. POST is also supported for long lists e.g. Asset IDs.

Authorizations:
Authorization
query Parameters
q
string

Query text

taxonomy_filter_mode
string
Enum: "union" "intersection"

Taxonomy Filter Mode

gps
boolean

Filter Assets containing GPS coordinates.

bounds
string
Example: bounds=36.49097449773101,-106.41286192187499,31.258707788122383,-120.37648496874999

Bounding box with format: ne_lat,ne_lon,sw_lat,sw_lon

include_totals
boolean

Include aggregate counts (aggs) in results

as_filters
boolean

Aggregate counts will be formatted as Filters

include_renditions
boolean

Include list of downloadable sizes and formats

include_meta
boolean

Include all IPTC, EXIF, and XMP metadata (exiftool compatible)

ids
Array of integers

Array of Asset IDs to include.

guids
Array of strings

Array of Asset GUIDs to include.

upload_id
integer

Upload

upload_guid
string

The GUID for the Upload session

storage_folder_id
integer

Storage folder

omit_child_storage_folders
boolean

Omit assets belonging to sub-level Storage Folders (top-level only)

collection_id
integer

Collection

omit_child_collections
boolean

Omit assets belonging to sub-level Collections (top-level only)

lightbox_id
integer

Lightbox

omit_child_lightboxes
boolean

Omit assets belonging to sub-level Lightboxes (top-level only)

lightbox_folder_id
integer

The ID of a Folder ("Bin") within a Lightbox.

omit_child_lightbox_folders
boolean

Omit assets belonging to sub-level Lightboxe Folders (top-level only)

taxonomy
boolean

Taxonomy

hide_taxonomy
boolean

Hide taxonomy

tags
Array of strings

Tags

hide_tags
Array of strings

Hide tags

exts
Array of strings

Exts

has_people
string
Enum: "yes" "no" "untagged"

Has people

has_alt_text
string
Enum: "yes" "no"

Has alt text

file_size_range
string
Enum: "<1" "1-10" "10-50" "50-100" ">100"

File size range

captured_at
Array of strings
Example: captured_at=2021-06-11T21:35:49-07:00,2021-06-25T23:59:59-07:00

Captured At Range

missing_captured_at
boolean

Captured At Missing

created_at
Array of strings
Example: created_at=2021-06-11T21:35:49-07:00,2021-06-25T23:59:59-07:00

Created At Range

updated_at
Array of strings
Example: updated_at=2021-06-11T21:35:49-07:00,2021-06-25T23:59:59-07:00

Last Update Range

snapshot_timestamp
integer
Example: snapshot_timestamp=1625198149000

Timestamp (in milliseconds) to filter assets created before this time, used for consistent pagination

aspect
string
Enum: "square" "portrait" "landscape" "panorama"

Aspect Ratio

proximity_field
string
Enum: "transcript" "description" "content"

Proximity field

proximity_word_1
string

Proximity word 1

proximity_word_2
string

Proximity word 2

proximity_max_gaps
integer

Proximity max gaps

rating
Array of integers[ items [ 0 .. 5 ] ]

Rating range 0-5 (e.g. 'rating[]=3&rating[]=5'), or single value (e.g. 'rating=5')

rights
Array of integers

Array of Rights Package IDs (or 'missing')

rights_code
Array of strings

Array of Rights Codes

user_ids
Array of integers

User ids

creator_tag_id
Array of integers

Creator tag

contracts
boolean

Contracts

releases
boolean

Releases

expired
boolean

Expired

submitted
boolean

Submitted

contract_asset_id
Array of integers

Contract asset

release_ids
Array of integers

Release ids

custom_meta
object

Search Custom Meta Values by name, using an array for controlled vocabulary values, e.g. "custom_meta": {"Custom Field 1 Name": "value 1", "Controlled Vocab Field 2 Name": ["controlled vocab value 1", "controlled vocab value 2"}

no_collections
boolean

No collections

contribution_id
integer

View all Assets from a Contribution Request

my_contribution_id
integer

View my Assets from a Contribution Request

upload_type
string
Enum: "all" "group" "link" "lightbox"

Upload type

view_all
string
Enum: "Collection" "Lightbox"

View all

optimization_request
string
Enum: "none" "requested" "completed"

Optimization Requests

vote
integer [ -1 .. 1 ]

Vote (Like / Dislike)

sort
string
Enum: "filename" "created_at" "captured_at" "file_size" "rating" "custom"

Sort field

order
string
Enum: "asc" "desc"

Sort direction (default: desc)

sync
boolean

Sets last_external_sync_at timestamp on returned Assets

aasm_state
string
Enum: "pending" "uploaded" "processing" "processed" "processing_error"

Search by Asset processing state (must have Manage Asset permissions). Defaults to processed unless overridden or upload_id or upload_guid specified. Supports comma delimited list for multiple.

all_ids
boolean

Return all Asset IDs in search results, un-paginated.

Responses

Response Headers
total-entries
integer
Response Schema: application/json
object

Response samples

Content type
application/json
{}

Asset Details

Get the asset details. ID can also be the Asset GUID.

Authorizations:
Authorization
path Parameters
id
required
integer
query Parameters
sync
boolean

Sets last_external_sync_at timestamp on Asset

include_renditions
boolean
Default: false

Include renditions

Responses

Response Schema: application/json
source_url
string

Source URL for Web Page assets (a PDF is generated from this URL)

Response samples

Content type
application/json
{
  • "id": 1060943047,
  • "filename": "doloribus.jpg",
  • "file_size": null,
  • "guid": "1cbc989a-496a-45b7-b891-4851fb7a14cb",
  • "short_guid": "1cbc989a",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "source_url": null,
  • "thumb_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574467/1cbc989a-496a-45b7-b891-4851fb7a14cb/1/1779997918/1cbc989a-thumb.jpg?Expires=1780026723&Signature=cUgG1yF~I9TuXhQlZ6qa8n47C0cSiRWPevxoJlfvUNntZbXcde75gIcn-F9Y6Az2msi8T0SwArxMmBh-9Tjp6x2wRElF2KyG1SIitkx2YMgjwo~jnNPfnJm-7JCmZf-JWDgdG6XiyFwO7eafmlMadbxJEb8ZMf4MQ6QAOpbsbPW1i5FQgApSgjNv25ChnXeCBE8GPtwUzXTXR1WpmfysbC6GjTFMeS7ydLK-oc0r4vHMmxbylq1ahLPtT3Sak-8fD5j5BnA9bu-RIfeyJQ2wBuM~Oe4p5gQ9Sc8ZcMmxLGKNILlr-6Em0YqDEOTWKArlI9hFnXl1uZqJw1xwBLBdqg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "grid_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574467/1cbc989a-496a-45b7-b891-4851fb7a14cb/1/1779997918/1cbc989a-grid.jpg?Expires=1780026723&Signature=Eg9oVGMOFKGqLdjD2n-7Eew4axJLa7eqUzcPWaulfL8bBWkyK0nlfRLPGo6HQJHtOqK-8CKYM4W89c9FPsL2n9GfPIXhorD2vsZ7XnlNqOimtCzcl4XyyShgnEenx-hOMbbGX0G5NlxFiFUIslLjrYO-owcrPmnLZUqTI6VEzUsouOvN-kbuxnntLF2ZYvTOOQ1sh~PMd8P5HMztcEkxPcCXPeI1VueHbJ7uxBE5mSozXJcWi1aLLbFjBGJMz6cSJqjrB6gpGx9mW0ST0LnUaPJXRln4kRN3gbroUnd7OVJVwUCQBep7RhmXTUMgRcZdZyWVXDyUBMcqrmKk7-RwvQ__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "small_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574467/1cbc989a-496a-45b7-b891-4851fb7a14cb/1/1779997918/1cbc989a-small.jpg?Expires=1780026723&Signature=Y1cbx0mPPSub5SJRB7-C3Bx4XJdH3jeIHPkMbeTTjNOVtWW2fFLz2QUHIXWfnzzR4sbQkEU8tY60Uxy2XQ5iqzUbf7gatf2IPda3WXZBh1FZE1hxmby0IGaDQy2aBc-TSFdOhILIiHPBgZ9TznBgznWhqvFUpDPAvLjRt5HgrktRh81uxw41KXET7pvN7IWSbQ1zGBGEHNVY5T3iShpCi~M-jFAmUO8nj5Nw~XniNEBDTUYvLOIwGv32Ev~DIoIiEw1ny60vr-V~iG28hacA9z~2~kkpWpYB4g2SZb98qOaHwXpG7gbTW35ZwRdlsMW9e4S2tJ9FXJMs-1FV0gYF1w__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "expired": false,
  • "expires_at": null,
  • "release": false,
  • "contract": false,
  • "released": false,
  • "has_people": true,
  • "headline": null,
  • "title": null,
  • "credit_line": null,
  • "event": null,
  • "city": null,
  • "state": null,
  • "country": null,
  • "sublocation": null,
  • "featured_organization_name": null,
  • "usage_terms": null,
  • "content_preview": null,
  • "has_transcript": false,
  • "transcription_job_status": null,
  • "creator": [ ],
  • "vote": {
    },
  • "nsfw_detected": false,
  • "data_version_number": 1,
  • "preview_type": "Image",
  • "downloadable_previews": true,
  • "block_level": 0,
  • "rights_package_block_level": 0,
  • "max_block_level": 0,
  • "textract_retrieved_at": null,
  • "submitted": true,
  • "preview_image_url": null,
  • "checked_out_at": null,
  • "frame_asset_id": null,
  • "frame_status": null,
  • "alt_text": null,
  • "organization_id": 1071574467,
  • "has_alpha": false,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "has_document_url": false,
  • "has_pdf_url": false,
  • "rating": null,
  • "path": null,
  • "catalogue_number": null,
  • "upload_finished_at": null,
  • "upload_started_at": null,
  • "processing_started_at": null,
  • "upload_id": 903046113,
  • "user_id": 1015819506,
  • "aasm_state": "processed",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2026-05-28T19:51:58.371Z",
  • "updated_at": "2026-05-28T19:51:58.477Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "1071574467/f9928a6f/1cbc989a-496a-45b7-b891-4851fb7a14cb-doloribus.jpg",
  • "time_to_process": 0,
  • "captured_at": "2026-05-27T19:51:58.369Z",
  • "captured_at_truncation": null,
  • "captured_at_offset": null,
  • "notes": null,
  • "created_via": null,
  • "created_via_id": null,
  • "vector": false,
  • "rights_package_id": 957290143,
  • "submitted_at": "2026-05-28T07:51:58.369Z",
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": "2026-05-28T19:52:03.624Z",
  • "auto_tags_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "na",
  • "faces_searched_at": null,
  • "bedrock_retrieved_at": null,
  • "custom_meta_values": [ ],
  • "user": {
    },
  • "rights_status": "owned",
  • "rights_status_name": "Owned by Organization",
  • "rights_status_description": "e.g. employee-created image done as part of job description, or commissioned work done under work for hire contract",
  • "creator_tag": null,
  • "storage_folder_path": "confuse_ample33",
  • "tags": [ ],
  • "renditions": [
    ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": null,
  • "preserved_filename": null,
  • "description_writer": null,
  • "country_code": null,
  • "iptc_event_id": null,
  • "organization_in_image_name": null,
  • "extended_description": null,
  • "iptc_job_id": null,
  • "intellectual_genre": null,
  • "scene": null,
  • "subject_code": null,
  • "instructions": null,
  • "iptc_rights": null,
  • "web_statement": null,
  • "model_release_status": null,
  • "property_release_status": null,
  • "authors_position": null,
  • "iptc_source": null,
  • "copyright_owner": null,
  • "iptc_dig_image_guid": null,
  • "image_supplier": null,
  • "iptc_image_supplier_image_id": null,
  • "licensor": null,
  • "addl_model_info": null,
  • "iptc_model_release_id": null,
  • "model_age": null,
  • "minor_model_age_disclosure": null,
  • "iptc_property_release_id": null,
  • "has_published_images": false,
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "bedrock_prompt": null,
  • "bedrock_data": null,
  • "downloads_count": 0,
  • "views_count": 1,
  • "up_votes_count": 1,
  • "down_votes_count": 0,
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574467/1cbc989a-496a-45b7-b891-4851fb7a14cb/1/1779997918/1cbc989a-permalink.jpg?Expires=1780026723&Signature=KvSA46QEg5wih0bOMjNM~H~GvO2rwVaSAr1xj8OVQCBhNncO~mb40bNP~R6Kjtyo6qOCNeoywf8h~LKBHowJa~eeQ26Rof~irm7vo~Quww3Fh2LEX0Bg08-0d9Rhfy5nLDdzcs9DgH8eXflfjMIss0~xf3d0oSEShVaQeHFgfohiAnDrieI4ugU851TU5nyblU6CH73fXs4DKR4sEsRH19r393YgvY5PPZhCBYwBtJD2WhRp7q0e0t1jQNPGaHVnGvpyJnhGczRGjx5~OR0hjfD1MQwRL5P-lle6U1-CEWZweFz3Ffb5wUZ4LPb~rNsJ7v6jdAgCTVfkB0ZzLERp4Q__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "full_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574467/1cbc989a-496a-45b7-b891-4851fb7a14cb/1/1779997918/1cbc989a-full.jpg?Expires=1780026723&Signature=TjokWivdK6ATNiHx62f4qbKUBtSApvk6ATlZ3lojnURs~pI0aBjVAxouJ4oRiEkGN56htPx6TeaQKs4pc8QmPVme2gWshflqc84N9TtprVh7f1FxPiOOyhQ1MPOQvDtLQ2dh85bdSTjDPeTxVd3ioPTeNNbMVyjVCCtSiZkgkHXWe91sZVQVGYRHdb9lX5V5Zcag2AoFPxxwY5fDnh5hnvO536O6HRS2wz2NXHlzeixMHUiMwpano5WeHj5tCinjKFgU7kBIBYg7ten5P~L~Ty4JcteDoPba6UG6E3WXGsCmLFCMlI2iW0CMPnuJVgFAhL6O1sSl51WdRa4GRxlBpA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "rights_package": {
    },
  • "upload": {
    },
  • "collective_work_ids": [ ]
}

Update Asset

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object
sync
boolean

Sets last_external_sync_at timestamp on Asset

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "asset": {
    },
  • "sync": true
}

Response samples

Content type
application/json
{
  • "id": 1060943062,
  • "filename": "qui.jpg",
  • "file_size": null,
  • "guid": "13569d7c-dac7-49e6-a0a2-f2f429ba679d",
  • "short_guid": "13569d7c",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "source_url": null,
  • "thumb_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574472/13569d7c-dac7-49e6-a0a2-f2f429ba679d/1/1779997976/13569d7c-thumb.jpg?Expires=1780026783&Signature=cr25CKTjryziyWaEHNrz0B6--tMMO17QDWLb68UxDFcklwRdpp5ZwwIwW8gOmUo~HX7yyN3SAK6fXLGWm8zGjyKQviNnDtEOUVeMJw6KfDGzkc9ilZzyqRePlNsXPo5jYYx4e0rPg7KDhmqDPMn-JBc7xY3bbX51xyjdb~QnNlrrnbu5hX8OKpCO8qAcQq-S7~73bXUmwA2KS6q3pwCNBB6j9G97gJ~keN1Cw6V8KwRfNdAZqb0CGtPxCaxy8q5Zt51bYqDsZYWRNBLtYgzNTIoP77cCdC~lQb7VzlWwvF6YkfBP5p2HFP0tVcYZJc6lmKHQsMX9w30A9tcgjIxcJQ__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "grid_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574472/13569d7c-dac7-49e6-a0a2-f2f429ba679d/1/1779997976/13569d7c-grid.jpg?Expires=1780026783&Signature=ERyrIu33GKG~ShYX9lgs6ki26t6HNcKGjIUDZgX8yNvnDGz2EZftAN36hbKmei91AN~9JGU340O-Lo5p3BE493MB~C-dqRp63PN9yh3qHpOljLOP-513XuA3HeRNxtL9kFRMdKjoX~-XwJEr9eCSCKs9sbpvUx5LAwUmvMqEP-CJv4pGLHzc4P~WpcNtuIhlE0MQ-TYJ9V5~NTV1VUwEwMRVfHUlmXTnReEcUtQk-hj-1z0ADrcno7P~wUBRMtpK7WmUK5DmyW1GfXaH4AEt6BJfl-iymSr7vjT1EaqpuPAcd3rdC8bNCtcwNHigGxgDmA~4vL63zjqmEXiKNWVaZw__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "small_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574472/13569d7c-dac7-49e6-a0a2-f2f429ba679d/1/1779997976/13569d7c-small.jpg?Expires=1780026783&Signature=PGH~EiO3vaBPongdb2SNGFQxTSsOhjCuEsJrSqpsLeM~XF~ZvijDjyQ6piesgYillq6ak~j8ctBWHnNKvFKF0R4Xr62YPmmEX9~PFPaRkAoVKYb3PvUglknFJBrr06STPcXusaFc0nnb5R7wvCHsJeAnLZBKMRcdViecmC4WDenMYFw9cUoqqnZ6muleFdEHit-k6wL2L2lvkFeKTmqX1V~iHwZJfaphtQdNCRRbYqxNIcRzyjbVH28SnLQa9Q1wkbg9gtOYDXBS2ctLuuZBGTUpKArnfqb2PNhWTP3FFnhYIcwOXs8u~o-PVoedsDZQZiJJXcUrLStHcy0GlMZ-yA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "description": "Updated Description.",
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "expired": false,
  • "expires_at": null,
  • "release": false,
  • "contract": false,
  • "released": false,
  • "has_people": true,
  • "headline": null,
  • "title": null,
  • "credit_line": null,
  • "event": null,
  • "city": null,
  • "state": null,
  • "country": null,
  • "sublocation": null,
  • "featured_organization_name": null,
  • "usage_terms": null,
  • "content_preview": null,
  • "has_transcript": false,
  • "transcription_job_status": null,
  • "creator": [ ],
  • "vote": {
    },
  • "nsfw_detected": false,
  • "data_version_number": 1,
  • "preview_type": "Image",
  • "downloadable_previews": true,
  • "block_level": 0,
  • "rights_package_block_level": 0,
  • "max_block_level": 0,
  • "textract_retrieved_at": null,
  • "submitted": true,
  • "preview_image_url": null,
  • "checked_out_at": null,
  • "frame_asset_id": null,
  • "frame_status": null,
  • "alt_text": null,
  • "organization_id": 1071574472,
  • "has_alpha": false,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "has_document_url": false,
  • "has_pdf_url": false,
  • "rating": null,
  • "path": null,
  • "catalogue_number": null,
  • "upload_finished_at": null,
  • "upload_started_at": null,
  • "processing_started_at": null,
  • "upload_id": 903046128,
  • "user_id": 1015819611,
  • "aasm_state": "processed",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2026-05-28T19:52:56.792Z",
  • "updated_at": "2026-05-28T19:53:02.728Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "1071574472/d2205d72/13569d7c-dac7-49e6-a0a2-f2f429ba679d-qui.jpg",
  • "time_to_process": 0,
  • "captured_at": "2026-05-27T19:52:56.789Z",
  • "captured_at_truncation": null,
  • "captured_at_offset": null,
  • "notes": null,
  • "created_via": null,
  • "created_via_id": null,
  • "vector": false,
  • "rights_package_id": 957290183,
  • "submitted_at": "2026-05-28T07:52:56.789Z",
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": "2026-05-28T19:53:03.447Z",
  • "auto_tags_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "na",
  • "faces_searched_at": null,
  • "bedrock_retrieved_at": null,
  • "custom_meta_values": [
    ],
  • "user": {
    },
  • "rights_status": "owned",
  • "rights_status_name": "Owned by Organization",
  • "rights_status_description": "e.g. employee-created image done as part of job description, or commissioned work done under work for hire contract",
  • "creator_tag": null,
  • "storage_folder_path": "diagram_kidnap48",
  • "tags": [
    ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": null,
  • "preserved_filename": null,
  • "description_writer": null,
  • "country_code": null,
  • "iptc_event_id": null,
  • "organization_in_image_name": null,
  • "extended_description": null,
  • "iptc_job_id": null,
  • "intellectual_genre": null,
  • "scene": null,
  • "subject_code": null,
  • "instructions": null,
  • "iptc_rights": null,
  • "web_statement": null,
  • "model_release_status": null,
  • "property_release_status": null,
  • "authors_position": null,
  • "iptc_source": null,
  • "copyright_owner": null,
  • "iptc_dig_image_guid": null,
  • "image_supplier": null,
  • "iptc_image_supplier_image_id": null,
  • "licensor": null,
  • "addl_model_info": null,
  • "iptc_model_release_id": null,
  • "model_age": null,
  • "minor_model_age_disclosure": null,
  • "iptc_property_release_id": null,
  • "has_published_images": false,
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "bedrock_prompt": null,
  • "bedrock_data": null,
  • "downloads_count": 0,
  • "views_count": 0,
  • "up_votes_count": 1,
  • "down_votes_count": 0,
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [],
  • "permalink_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574472/13569d7c-dac7-49e6-a0a2-f2f429ba679d/1/1779997976/13569d7c-permalink.jpg?Expires=1780026783&Signature=Lv0gtIeUbOxkC4Eo52HUQoessU9UJz4dtwhB44lBo7ZOB7BP-pPLD1I~vQRPRsvz63ketuanLNurpkEgkhHM7M7YxI10cHbX4m3uxLsqyu-G82ytaNAS6ax3Xaxs7nYztymBtBZxqD5DpG9jPmizqZoqkD0i6tqGmVsPP8~KpFvZZTF8iIlRWK8emZliWgkD19JUEtfnITHaEBj2-0hMR8fM3gYaeCGi0EyTEQMNG4dnoaimVbMu6GpFiFMwlqhb3avoWfOI8YfPNCYCfH-FiYXEUFPvWeaaIHyGJQkiJDYQ4NNtzhoH7wYKOaMwsRB~7us1C8HLLCfP76AJIE35rg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "full_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574472/13569d7c-dac7-49e6-a0a2-f2f429ba679d/1/1779997976/13569d7c-full.jpg?Expires=1780026783&Signature=DkKMCgSqTVtfLque7tvyZ8Z~dkeHsCbwuZXrX0p3rJIqyfl0OSoy383tw1uPshpfHlNZ9aKyjLQ8dnFU7oefWlmH74kkGSd2Bv68Ko4duVNTDVc88qfrcMQONeR8KF3I7RNVshLFhH1BYpMJo-iG4PiviYo0LHQtCF9C-6R0LAjQ8aSqwSa5nJayos5GPx6wqYQ8~ZqwELwnj~NZtBSBFYypNNoBicGpbRopw2id02o4BzdSmXDkX03tVS4yvmTYatTHR8WxDc4ktK9JIR0iGcqCFJlidu4GtSyzMBQTjwOupF0Xx-zD0z6PPBQQ00LwmiKCWRmrnkHnreNv8Dmhyg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "rights_package": {
    },
  • "upload": {
    },
  • "collective_work_ids": [ ]
}

Delete Asset

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Download Asset

Downloads the Asset. Partial downloading is supported using the header: Range: bytes=<start>-<end>

Authorizations:
Authorization
path Parameters
id
required
integer
query Parameters
size
string
Enum: "small" "medium" "full" "original"

The maximum size requested for assets in the download (default original). To use a specific Crop Preset, use the format size=crop-preset-{id}.

watermarked
boolean

Request watermarked versions

via
string
Example: via=My-Integration

Description of the app or integration making the API call

version_number
integer
Example: version_number=1

Data Version number to download

skip_meta
boolean
Default: false

Do not write metadata on the fly to the file (original file size and MD5 will match)

Responses

Response Schema: image/jpeg
object

Download Asset

The accept-ranges response header will be 'bytes'.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: image/jpeg
object

Batch Update Assets

Update up to 100 Assets in one request. Each entry must identify the Asset by id or guid and may provide an asset or attributes object using the same fields accepted by the single Asset update endpoint. Use sync=true to mark each successfully updated Asset as externally synced.

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
sync
boolean

Sets last_external_sync_at timestamp on successfully updated Assets

assets
required
Array of objects

Array of Asset update objects. Each item requires id or guid and accepts asset or attributes update fields.

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "updated": [
    ],
  • "errors": [ ]
}

Add Asset Version

Prepare a new asset version upload using this endpoint, then PUT the data to the returned signed_upload_url, and finally call /api/assets/:id/set_uploaded when the upload is complete.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
signed_upload_url
string

Use this URL to PUT the file data on S3.

Request samples

Content type
application/json
{
  • "asset": {
    }
}

Request Asset Optimization

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1060943071,
  • "filename": "atque.jpg",
  • "file_size": null,
  • "guid": "09c34b44-d626-4ae6-8908-91070691d264",
  • "short_guid": "09c34b44",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "source_url": null,
  • "thumb_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574475/09c34b44-d626-4ae6-8908-91070691d264/1/1779998013/09c34b44-thumb.jpg?Expires=1780026818&Signature=az0UQMkCP1DfvxagH98sYkbwTtGsTSd7BFKiC8ez-gJej4MfUkWCzWzKFX7uEehjU~SNCAITteUiIL9EfhunKn4cJj~7qs9tHND7Jnzsx411dvn8GBlJnAtFuwARrEcUN0chGa4ulrj-mA7tp7wZlxLZXwHaBJAwHH2Dh9jINME2MMkNuimNxIIbG6OcWaND3frizowOUYMyYvu~751KwYSq7DbekIhaHskwVMhkyOulLLhRHKRcWIUPWe-g83ay9A418IalGbOR5VqNjdwdrFvjcFNzS~aQbTETLxpEt8vWhN0vYKjtx~yJG223NRqRtrcsvcU~17YjIWUE8UUI2A__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "grid_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574475/09c34b44-d626-4ae6-8908-91070691d264/1/1779998013/09c34b44-grid.jpg?Expires=1780026818&Signature=HvcQxFizftzM5AKEFin-Pz1Ta9ZqUPOZmmHS3H2uywvdl9lCXW8nHiUg1oil3GQ-e10BhqVAJP77eiAHz4ChWgK2yY7UNIG4lRtFqk8dTenOdqdeLa4c62ILhhUcAki8il0D-Au-WfJp~sqlmjQ1qyVLgu5q~GDvAgt5o9bR~64g436pRXYqcVO1yAnKXeJY-jKtOTqxKi63MIyD7a0BDml3O5GrEZ0TvoxxVC9ujSD295S63sDCJEBJq8JTcJyiyBDCSUsnw4kUKS-u~BG1i9N3rOLz6K66~lSVAnLr91vxRqzkHNGD3E6IFhf2P9A1vCn2JCfQj~q1MS5xJNhI~A__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "small_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574475/09c34b44-d626-4ae6-8908-91070691d264/1/1779998013/09c34b44-small.jpg?Expires=1780026818&Signature=R~V8BzOw-CqafkxLs5j~qbxOAlA4idD-1nEBZd4Rmb~rd~4OGS5dTQrGHfMdc~iGsGU2HkP2tqDabMfywkWXiYZzaFi-ID4TENgPFKSb6pgCV7-ofdLo8FKrA9aKTyAB-Nf1R5a56ZUWIZnWi49ymn7akkzo5UYh~5irILEaykRqRM0aQNJkxNwmdN5GF9PtvWbCg4l8yiMADzB890lDgXKIkyURmlzFGkD6NlYq8I~zLY5cvYsjr6NXTiMn58tg5wN0zfUtjECiio6PFy9ZuDa3HZ~mFmm2qoSuwB3zyYI3hkp-sm~zlxnxVvP~RfH3-V07jitAKDktJDcELilRTg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "expired": false,
  • "expires_at": null,
  • "release": false,
  • "contract": false,
  • "released": false,
  • "has_people": true,
  • "headline": null,
  • "title": null,
  • "credit_line": null,
  • "event": null,
  • "city": null,
  • "state": null,
  • "country": null,
  • "sublocation": null,
  • "featured_organization_name": null,
  • "usage_terms": null,
  • "content_preview": null,
  • "has_transcript": false,
  • "transcription_job_status": null,
  • "creator": [ ],
  • "vote": {
    },
  • "nsfw_detected": false,
  • "data_version_number": 1,
  • "preview_type": "Image",
  • "downloadable_previews": true,
  • "block_level": 0,
  • "rights_package_block_level": 0,
  • "max_block_level": 0,
  • "textract_retrieved_at": null,
  • "submitted": true,
  • "preview_image_url": null,
  • "checked_out_at": null,
  • "frame_asset_id": null,
  • "frame_status": null,
  • "alt_text": null,
  • "organization_id": 1071574475,
  • "has_alpha": false,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "has_document_url": false,
  • "has_pdf_url": false,
  • "rating": null,
  • "path": null,
  • "catalogue_number": null,
  • "upload_finished_at": null,
  • "upload_started_at": null,
  • "processing_started_at": null,
  • "upload_id": 903046137,
  • "user_id": 1015819674,
  • "aasm_state": "processed",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2026-05-28T19:53:33.448Z",
  • "updated_at": "2026-05-28T19:53:38.698Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "1071574475/877aebdd/09c34b44-d626-4ae6-8908-91070691d264-atque.jpg",
  • "time_to_process": 0,
  • "captured_at": "2026-05-27T19:53:33.445Z",
  • "captured_at_truncation": null,
  • "captured_at_offset": null,
  • "notes": null,
  • "created_via": null,
  • "created_via_id": null,
  • "vector": false,
  • "rights_package_id": 957290207,
  • "submitted_at": "2026-05-28T07:53:33.446Z",
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": "2026-05-28T19:53:38.691Z",
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": null,
  • "auto_tags_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "na",
  • "faces_searched_at": null,
  • "bedrock_retrieved_at": null,
  • "custom_meta_values": [ ],
  • "user": {
    },
  • "rights_status": "owned",
  • "rights_status_name": "Owned by Organization",
  • "rights_status_description": "e.g. employee-created image done as part of job description, or commissioned work done under work for hire contract",
  • "creator_tag": null,
  • "storage_folder_path": "corpse-cruelty57",
  • "tags": [ ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": null,
  • "preserved_filename": null,
  • "description_writer": null,
  • "country_code": null,
  • "iptc_event_id": null,
  • "organization_in_image_name": null,
  • "extended_description": null,
  • "iptc_job_id": null,
  • "intellectual_genre": null,
  • "scene": null,
  • "subject_code": null,
  • "instructions": null,
  • "iptc_rights": null,
  • "web_statement": null,
  • "model_release_status": null,
  • "property_release_status": null,
  • "authors_position": null,
  • "iptc_source": null,
  • "copyright_owner": null,
  • "iptc_dig_image_guid": null,
  • "image_supplier": null,
  • "iptc_image_supplier_image_id": null,
  • "licensor": null,
  • "addl_model_info": null,
  • "iptc_model_release_id": null,
  • "model_age": null,
  • "minor_model_age_disclosure": null,
  • "iptc_property_release_id": null,
  • "has_published_images": false,
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "bedrock_prompt": null,
  • "bedrock_data": null,
  • "downloads_count": 0,
  • "views_count": 0,
  • "up_votes_count": 1,
  • "down_votes_count": 0,
  • "optimization_requested_by": {
    },
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574475/09c34b44-d626-4ae6-8908-91070691d264/1/1779998013/09c34b44-permalink.jpg?Expires=1780026818&Signature=GoUTXIGmNN8KuJv4DhodwMN~NtC5XZTfM4bN87-4KTXC8Pow6zJSM51FeHmsFMfQkbW4Wg7KRYA7bsAQytvapPYNUWhJnJ-G6M5R3CVq6vZNBNbjC-8lNJPaxsjgGOAtDDw9YhAfwV41y5jjhMS212f5JEmtrevxkSHk01QYZvUlqwCtUyov4NGZ-LUA612eYiMbL-zlLdO~3ws5-9BvQQ3Y9OG6YrtDhoY0-xTi5ntjfuhNq~BHF-5zTBzAv1bHksVrNKtWUapsw~pgoRBmnfve7~v8svYq3cTvLZiizE-ET81FVmdnZNsm2H2JeIUPyn0OovBTxTAFB9HhkL2SWA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "full_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574475/09c34b44-d626-4ae6-8908-91070691d264/1/1779998013/09c34b44-full.jpg?Expires=1780026818&Signature=dxqz4xwSauD5~vM5OOPSwDCe-1eJcDXyINHZXhm6pYVDExPJ~azbk-u-s0FNHllTy9crmXZrGgmZ2Zqub33IWhG10k~tOe~oB0CD9pqyj3DwQe9eiyzoWs9KKeRF429nTCOlubamyplNcJYVMmFOsP3d~7Ndo4DPPiCajgRV9JOwtBEYXr3VD7B9I6~Xwt~le95g5IqjptA9CMsJiSOAjMHtViuOt3rSHeR2tFGzz6iXS149yIvs0Yr4li-j7U7MZAFWnJyyNC-KnYgdv3~Ppv1OsqLUZIl3NpPMU2DfnjWOmVPyNhzE3S45180wXmrjWDVxLebdI0aLlIf8D3qGcA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "rights_package": {
    },
  • "upload": {
    },
  • "collective_work_ids": [ ]
}

Complete Asset Optimization

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1060943074,
  • "filename": "ipsum.jpg",
  • "file_size": null,
  • "guid": "14c4b511-215d-452f-bb0b-eebbe6d4abf1",
  • "short_guid": "14c4b511",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "source_url": null,
  • "thumb_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574476/14c4b511-215d-452f-bb0b-eebbe6d4abf1/1/1779998025/14c4b511-thumb.jpg?Expires=1780026830&Signature=EE-yBSG5ZeY9ZTmhEDUapGXjWMfSUYCbwaMD0Em-VDVtQqesohOtQnKKlkDMjwhOSE4C4epZSHcW-2admUSUIfDm61eCF1D9HJ5Ed8KqiYbz7chWfG4f6uUiOGt-lBOMpI9JCWabpzv1iBYNwm5JrFWD3vqRgYEUuPysNBRxUAPZ9SXs2KwNMEZTHkjjuf4bwMAmcFVXt-veg86yVzOsaDr7cXfaijnVDHkLLtkcJxiQsaMLPtHbq51aPF-~gGen6y5MmXf6fl93r7L5mfYOq~9i7SiXbcLq6wHOA0wza7jKeuC0gloZ69qXr~TCiGtLDtI3WnHpBV9a85ilLc4Fug__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "grid_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574476/14c4b511-215d-452f-bb0b-eebbe6d4abf1/1/1779998025/14c4b511-grid.jpg?Expires=1780026830&Signature=eLNFJY8JCkA~SAnOpVaX4L-1t8zlfbzQmFc3taHHJqylHdnBlyuPUMrwWZjQ0gKMAU-tXoVJBE7q~AP2Qpc~xrZ31zGhm-jJPuBXeSZrZD8dVF2e7NO30HH8bPa5V1z91OTlGZDEs3NUsyTioDcPV2CSVgU2EzNVCaK5oX-HWO~vwzRxxSLEYGb-Mtaq8ZOa2GWMpaeDiq-xhEQaKMc~GalzQtgT~KqRrUF~q2hp4DLrAXts6kyWJiM2IXZohpQ8QiTTDPmoQisQfinRkEulraW8I~nLDvK~QlPF3ejaRUc6DUclVMUK9iCtgbGAW2fHO2dgqtV6dUqpYiVsFqGlWg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "small_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574476/14c4b511-215d-452f-bb0b-eebbe6d4abf1/1/1779998025/14c4b511-small.jpg?Expires=1780026830&Signature=eUQPdzqYV4rn5gUaoazy6u~wCr506-8H2z0oM70XtrAFC3ek0WYpzuGla0--W5cAf0GINUTTg-MbAAyLfvLIiCb42IfnKWOVISz2VMJ~R-sH2rCcBvh6Rrw8hvSUuJHwY1KZX1CjVnwcHxUy79FD9d4rvuwXoTl6eKp05VjKjWAzv4hh5vEpXM3HKJTA7ALqo~fqYcAJeh1IyVR0QMiBCn4WQkqQSDMqhlatYEC23iJwGfxFDzMxm1JTqVxN~BwVrRZQtWZFzXJcAZwVuHE8YfKFc5MP2m1wSff8VVKCRwV2dUcsyXpjBaJBtwdgALv-m-XpSakdSEsUns4hwd1K0w__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "expired": false,
  • "expires_at": null,
  • "release": false,
  • "contract": false,
  • "released": false,
  • "has_people": true,
  • "headline": null,
  • "title": null,
  • "credit_line": null,
  • "event": null,
  • "city": null,
  • "state": null,
  • "country": null,
  • "sublocation": null,
  • "featured_organization_name": null,
  • "usage_terms": null,
  • "content_preview": null,
  • "has_transcript": false,
  • "transcription_job_status": null,
  • "creator": [ ],
  • "vote": {
    },
  • "nsfw_detected": false,
  • "data_version_number": 1,
  • "preview_type": "Image",
  • "downloadable_previews": true,
  • "block_level": 0,
  • "rights_package_block_level": 0,
  • "max_block_level": 0,
  • "textract_retrieved_at": null,
  • "submitted": true,
  • "preview_image_url": null,
  • "checked_out_at": null,
  • "frame_asset_id": null,
  • "frame_status": null,
  • "alt_text": null,
  • "organization_id": 1071574476,
  • "has_alpha": false,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "has_document_url": false,
  • "has_pdf_url": false,
  • "rating": null,
  • "path": null,
  • "catalogue_number": null,
  • "upload_finished_at": null,
  • "upload_started_at": null,
  • "processing_started_at": null,
  • "upload_id": 903046140,
  • "user_id": 1015819695,
  • "aasm_state": "processed",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2026-05-28T19:53:45.071Z",
  • "updated_at": "2026-05-28T19:53:50.512Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "1071574476/14ac2f25/14c4b511-215d-452f-bb0b-eebbe6d4abf1-ipsum.jpg",
  • "time_to_process": 0,
  • "captured_at": "2026-05-27T19:53:45.069Z",
  • "captured_at_truncation": null,
  • "captured_at_offset": null,
  • "notes": null,
  • "created_via": null,
  • "created_via_id": null,
  • "vector": false,
  • "rights_package_id": 957290215,
  • "submitted_at": "2026-05-28T07:53:45.069Z",
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": "2026-05-28T19:53:50.505Z",
  • "trashed_at": null,
  • "last_external_sync_at": null,
  • "auto_tags_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "na",
  • "faces_searched_at": null,
  • "bedrock_retrieved_at": null,
  • "custom_meta_values": [ ],
  • "user": {
    },
  • "rights_status": "owned",
  • "rights_status_name": "Owned by Organization",
  • "rights_status_description": "e.g. employee-created image done as part of job description, or commissioned work done under work for hire contract",
  • "creator_tag": null,
  • "storage_folder_path": "story-strikebreaker60",
  • "tags": [ ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": null,
  • "preserved_filename": null,
  • "description_writer": null,
  • "country_code": null,
  • "iptc_event_id": null,
  • "organization_in_image_name": null,
  • "extended_description": null,
  • "iptc_job_id": null,
  • "intellectual_genre": null,
  • "scene": null,
  • "subject_code": null,
  • "instructions": null,
  • "iptc_rights": null,
  • "web_statement": null,
  • "model_release_status": null,
  • "property_release_status": null,
  • "authors_position": null,
  • "iptc_source": null,
  • "copyright_owner": null,
  • "iptc_dig_image_guid": null,
  • "image_supplier": null,
  • "iptc_image_supplier_image_id": null,
  • "licensor": null,
  • "addl_model_info": null,
  • "iptc_model_release_id": null,
  • "model_age": null,
  • "minor_model_age_disclosure": null,
  • "iptc_property_release_id": null,
  • "has_published_images": false,
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "bedrock_prompt": null,
  • "bedrock_data": null,
  • "downloads_count": 0,
  • "views_count": 0,
  • "up_votes_count": 1,
  • "down_votes_count": 0,
  • "optimization_completed_by": {
    },
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574476/14c4b511-215d-452f-bb0b-eebbe6d4abf1/1/1779998025/14c4b511-permalink.jpg?Expires=1780026830&Signature=Fkp-FKU4aZSC5xvlNH3WyixYljNh09h00MZMh6h0olthpao44BVym6pZ78GIX88pfOPEAGafrIv2pxfzo7wFNZ7~3jhfONS6mekzcUmF0qfLgp1RvPdAIZuSI-gY7XzxrZo2PWoSxxwFgrZ-WWZbl4afaK3TLWuFI-ssrPWVRS-zoggKgRJTsjkNDH-xA~Jgcw3eNh9xMyQSZT0yWeRTq7Qma5DOJvGHLNqyOO~Gk9dKVI6HPTRxxsyPAP0gP8O50TMFVeKemwoYqJjF1AHjng~WunKV1va3mPV1Ihy6G4q66Pd~fwfn~WRlam9ovVgncSuKk~krH7UNfKxMexiYJw__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "full_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574476/14c4b511-215d-452f-bb0b-eebbe6d4abf1/1/1779998025/14c4b511-full.jpg?Expires=1780026830&Signature=fR3uPSnQtEzLx5OQct5jjBhZfZbVw4TzWjcry4t~ABPpTHpcbt3aZ0VXJL2Ujxssvf5fh6kz-UnkocP2Tl61ihZRy9szrDLAUbyYwpkvufUXze4OCF6FSsxyKX2NgTUlg36c9kMzUB7l2CCx~qdcY7oCsbK-cydiuw5racBx1wuGlolCRQeVGXAs65iESH~mZNN74DxoBtwgI-H62YZqOailVxpwfSBSaOQnShvimU78vzbQk5dZZZsde8BXGVL1dGh4fU3KZVVIGOh7C1a8t7yBzrnVmjXogmMr6Mh80uhs6fkejQSv52QOyvmuufnZ9Y7~MQQ3xn2W0sQp9o08kg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "rights_package": {
    },
  • "upload": {
    },
  • "collective_work_ids": [ ]
}

Remove Asset Optimization Request

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1060943077,
  • "filename": "occaecati.jpg",
  • "file_size": null,
  • "guid": "87df8326-a543-4e5d-bd34-28c8406904d8",
  • "short_guid": "87df8326",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "source_url": null,
  • "thumb_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574477/87df8326-a543-4e5d-bd34-28c8406904d8/1/1779998037/87df8326-thumb.jpg?Expires=1780026842&Signature=IgxTqj6IJGwD8QNtYFXDL~svOn-JZsBWYwTgqRxY2vGt3AkEAcHVugywIAVHxGBSgB9FzovNb0DrzaJ2KZAXg6cGFMzQ07Co92Ybs-HOTRZjPxogMqm2OlJ9NZRbPrnjo4KBX6ilZBqQlaDAwMTIR5s5Pn7wuyBz0ataxMCVmpI6G-3hnI6Ju~xnsVGwdVoOTBMvhK-cnuMnc~IAXWsI3UyMJNY-nen1D59PG2z2A7HTUnZEJi4OoCldk7VMHohULCY038~lrP8v56bjR3suJjoMG7~4BgOCRbEwisR2rzSub7dArohD1lehIsmv4fjWbxvS3gTWsdJs9MtvCCN84Q__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "grid_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574477/87df8326-a543-4e5d-bd34-28c8406904d8/1/1779998037/87df8326-grid.jpg?Expires=1780026842&Signature=djCrZTEW00hOowLNEuuxQE1oQBoBG63afAflojOnrjB70-3MLjiplnu2ggMri08nwXY06DO5I-uz2we0vCg6Hso09HKDuFR~Hl1ssHy4eSR76UTgIzXdS36y1-U97daMYomFV6iCj1CxVwJztmWmCNftNTm2k-PUi8-ZJFDuMcWE-wXTJejaMqHiyiNU5uApAzKHer762dxt1ZYF13l9vFh6K~Kj27sn7iPZvMuYkkbTrykL6c7k11z5u1hRGLq1k3VG81-hvHcBR0YSAx-d-bOxKte7DY0zNOIBH5SZlsbnQwbqm3QMvXP8J9k2ukI6nXeZ1V1CMhEHMW9p7WGFXA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "small_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574477/87df8326-a543-4e5d-bd34-28c8406904d8/1/1779998037/87df8326-small.jpg?Expires=1780026842&Signature=eA--vzakY1eDNd1Ihwx6gbsIzVJ6yjZp7e4KUcglqUNGy-Miz8deYLZCXfQUk44GIf4BLhZLiQMwGZ6EBWg0iFrdEFV10DRa~IG~piSjF95aZm0wFtuvngeIUzIwL4D008pXP7S7DYvC-UtGkHjfySPVEafkUj~jgQ6Quk8DSOQMMV8yfNzUcjT92GMjQDyYjQcuT0DGfuKZip~Yj3lrLhBDnkpTklqkNyL8WrO~4f7FGsMdXQ7oLrq9uaariMJhyqgmhWuEwcEeHBeg4I09ZC6CrwML7qxFc3Nui8FDUj0H2695aHgDlna~W5pKOQPhuu6Crivu9KiDjdTkdpypCA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "expired": false,
  • "expires_at": null,
  • "release": false,
  • "contract": false,
  • "released": false,
  • "has_people": true,
  • "headline": null,
  • "title": null,
  • "credit_line": null,
  • "event": null,
  • "city": null,
  • "state": null,
  • "country": null,
  • "sublocation": null,
  • "featured_organization_name": null,
  • "usage_terms": null,
  • "content_preview": null,
  • "has_transcript": false,
  • "transcription_job_status": null,
  • "creator": [ ],
  • "vote": {
    },
  • "nsfw_detected": false,
  • "data_version_number": 1,
  • "preview_type": "Image",
  • "downloadable_previews": true,
  • "block_level": 0,
  • "rights_package_block_level": 0,
  • "max_block_level": 0,
  • "textract_retrieved_at": null,
  • "submitted": true,
  • "preview_image_url": null,
  • "checked_out_at": null,
  • "frame_asset_id": null,
  • "frame_status": null,
  • "alt_text": null,
  • "organization_id": 1071574477,
  • "has_alpha": false,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "has_document_url": false,
  • "has_pdf_url": false,
  • "rating": null,
  • "path": null,
  • "catalogue_number": null,
  • "upload_finished_at": null,
  • "upload_started_at": null,
  • "processing_started_at": null,
  • "upload_id": 903046143,
  • "user_id": 1015819716,
  • "aasm_state": "processed",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2026-05-28T19:53:57.241Z",
  • "updated_at": "2026-05-28T19:53:57.337Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "1071574477/cb6a2355/87df8326-a543-4e5d-bd34-28c8406904d8-occaecati.jpg",
  • "time_to_process": 0,
  • "captured_at": "2026-05-27T19:53:57.238Z",
  • "captured_at_truncation": null,
  • "captured_at_offset": null,
  • "notes": null,
  • "created_via": null,
  • "created_via_id": null,
  • "vector": false,
  • "rights_package_id": 957290223,
  • "submitted_at": "2026-05-28T07:53:57.238Z",
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": null,
  • "auto_tags_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "na",
  • "faces_searched_at": null,
  • "bedrock_retrieved_at": null,
  • "custom_meta_values": [ ],
  • "user": {
    },
  • "rights_status": "owned",
  • "rights_status_name": "Owned by Organization",
  • "rights_status_description": "e.g. employee-created image done as part of job description, or commissioned work done under work for hire contract",
  • "creator_tag": null,
  • "storage_folder_path": "message-corpse63",
  • "tags": [ ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": null,
  • "preserved_filename": null,
  • "description_writer": null,
  • "country_code": null,
  • "iptc_event_id": null,
  • "organization_in_image_name": null,
  • "extended_description": null,
  • "iptc_job_id": null,
  • "intellectual_genre": null,
  • "scene": null,
  • "subject_code": null,
  • "instructions": null,
  • "iptc_rights": null,
  • "web_statement": null,
  • "model_release_status": null,
  • "property_release_status": null,
  • "authors_position": null,
  • "iptc_source": null,
  • "copyright_owner": null,
  • "iptc_dig_image_guid": null,
  • "image_supplier": null,
  • "iptc_image_supplier_image_id": null,
  • "licensor": null,
  • "addl_model_info": null,
  • "iptc_model_release_id": null,
  • "model_age": null,
  • "minor_model_age_disclosure": null,
  • "iptc_property_release_id": null,
  • "has_published_images": false,
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "bedrock_prompt": null,
  • "bedrock_data": null,
  • "downloads_count": 0,
  • "views_count": 0,
  • "up_votes_count": 1,
  • "down_votes_count": 0,
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574477/87df8326-a543-4e5d-bd34-28c8406904d8/1/1779998037/87df8326-permalink.jpg?Expires=1780026842&Signature=f85SZI2C67fuxs~MtEgz7TdUo0w~OO0SavAZd9lnSgyKm4Guk4K5StwVGkP5JydE7rIq7ZZ4b9FvISB9034lbtgVL04QcRZ0icUmzmR8ckDbw6Y~rFaiwPDyZIPgBBfRnma7nyHWn4YWNSnae3Wx-vHjTt7dln5vh2SqDBgr5A0xYRXcMo6Ooqu-2IUVhl-GkmCSa7akTJWfCTtiLbkVVQVW4LrXjJVhgCRLCaKRPa6q-~OcMsRr~rJmyot9MhCGPtALBU5MVruTnshqKFLpSs5ElBLmwRgAgemtwodrxk56~zrLPjjVSb3hdFdBK7GjvxZpJAXbs8TEECHrDDTZmg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "full_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574477/87df8326-a543-4e5d-bd34-28c8406904d8/1/1779998037/87df8326-full.jpg?Expires=1780026842&Signature=MvePPavQIydfmO7Ixg~5rvsODBy2ZAIUK2YCa2NCnE2EV9Vk6YCbJOt-ZkwXKUhbPIDqeGLiWoSv3HMS~lZ6OIsysj9JGpGnmCHPTR~ru9U7XBFqpm7YYEkjf5pQmXXd9zTaQ~ZJJqIKfzgufqJE8PmoB8OukLlmkfUPSKdfbZJh9Vu9Zsj~JkQVXum4aMHF~doxfE96NemAMI-uZpdtxF3v8637gwJhpZBR02OJEVlLShULHZ4IDPdwfofPEsHMpXkC4J9n9-2WZ4R4Icvm9Ieym3uCxfdms3capOXAbKrJqX7hq32dNiTY84lFDbUSYoxhRB-~XRLp~8L02DxFkA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "rights_package": {
    },
  • "upload": {
    },
  • "collective_work_ids": [ ]
}

Set Asset Version

Select the current Asset version by number.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/x-www-form-urlencoded
version
required
integer

Version

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1060943083,
  • "filename": "ullam.jpg",
  • "file_size": null,
  • "guid": "2e5e3f71-0908-4335-a191-300a4d604046",
  • "short_guid": "2e5e3f71",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "source_url": null,
  • "thumb_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574478/2e5e3f71-0908-4335-a191-300a4d604046/1/1779998056/2e5e3f71-thumb.jpg?Expires=1780026857&Signature=dPYADY16vnc-63fPfg2zL7da81vBc71fnEMyiLAuuYw1hD9l5OWxpgNvy~KVOiq4KjwQix5bJ-UJDDkbpP8SWHLDo6EuC1aO0~13AhLSOOK8zY3JMFfs4a~jBPk1vEaKLJ6UcHC42VDSysoF1G9v9PE3QEvLkG-U6lwqQtKlLF55lqBnuxGMOeo~VRLyxgmHN92ccZZnR9OpK3rR-HK37mJj8YMbKD78aWakpV~zCV2aIJC70wlzpKyrZMct64ERc9OgTd29piS7oBNnUFGg-1nt3pZPhzCeclRwnoKmLxUSpO7FC2mZt4AHuy~54R668MJK0EJ4VdiiRpAP6k-30g__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "grid_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574478/2e5e3f71-0908-4335-a191-300a4d604046/1/1779998056/2e5e3f71-grid.jpg?Expires=1780026857&Signature=UmhhPKkVpTX4DfV4jkAnoPAFT1QgFgmI-oCR~EtfB9bWvOvCQuj0PSlKcB3svEX1tQiBn00ye5ZGFRujbXidqlgCouDYn01R6oKnSMMrxY3ifEcbUquQeKHwMPrrawHbP2mOzc0yFLO8TjlZPmGjrfGlwJVysQEiAQAjbdd-tC815qYk~E4WrYiWUs0aEEff33JjsvXrr~hofgkOryHKphQ7sLafbOW5bhdtScrcMt8LIwccbHUY8vkqeXxKGmYfj4a9MNa3CA0hZW~iT5oC7wr15ijdQYTsvzS2al2hcqbbGhvIi4f9KupewlsqIf1scu7sG9G9UsGaot02ophMTg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "small_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574478/2e5e3f71-0908-4335-a191-300a4d604046/1/1779998056/2e5e3f71-small.jpg?Expires=1780026857&Signature=XULXazag4WyZBz7f-mAk6f8RtzbgoczTYA6u26KZA7dOYiV-uXE-Wwxvhwc-eI1COeluKJAgSdmADLe9U2sI7qY6ztCFJBtVNuqtUUEt~nvfZAt6rAi9YEUxtCTlFpkrsn7o6G6y-da~HCOkZS6EdvAKHG1N05T0dsIH-Z5tpkZ0dZBYO1Nzy2B1wdwOYv0r7Ao1N2IcVaIYnMiZVfS2nWZnHPyyWJsvGPB4GQCHoka4z20-MPUFBl56YPEwvtBQWO4aAeMBVBsp-3trC6gNXy01FRmgKvDir05Gp~5~37d5d5164tKt1d9cyNVyq1drIvXIaXCVEqWE8RHfS6wUBA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "expired": null,
  • "expires_at": null,
  • "release": false,
  • "contract": false,
  • "released": false,
  • "has_people": null,
  • "headline": null,
  • "title": null,
  • "credit_line": null,
  • "event": null,
  • "city": null,
  • "state": null,
  • "country": null,
  • "sublocation": null,
  • "featured_organization_name": null,
  • "usage_terms": null,
  • "content_preview": null,
  • "has_transcript": false,
  • "transcription_job_status": null,
  • "creator": [ ],
  • "vote": null,
  • "nsfw_detected": false,
  • "data_version_number": 1,
  • "preview_type": "Image",
  • "downloadable_previews": true,
  • "block_level": 0,
  • "rights_package_block_level": null,
  • "max_block_level": 0,
  • "textract_retrieved_at": null,
  • "submitted": true,
  • "preview_image_url": null,
  • "checked_out_at": null,
  • "frame_asset_id": null,
  • "frame_status": null,
  • "alt_text": null,
  • "organization_id": 1071574478,
  • "has_alpha": false,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "has_document_url": false,
  • "has_pdf_url": false,
  • "rating": null,
  • "path": null,
  • "catalogue_number": null,
  • "upload_finished_at": null,
  • "upload_started_at": null,
  • "processing_started_at": null,
  • "upload_id": 903046149,
  • "user_id": 1015819749,
  • "aasm_state": "processed",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2026-05-28T19:54:16.278Z",
  • "updated_at": "2026-05-28T19:54:17.080Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "1071574478/77ed58b2/2e5e3f71-0908-4335-a191-300a4d604046-ullam.jpg",
  • "time_to_process": 0,
  • "captured_at": "2026-05-27T19:54:16.276Z",
  • "captured_at_truncation": null,
  • "captured_at_offset": null,
  • "notes": null,
  • "created_via": null,
  • "created_via_id": null,
  • "vector": false,
  • "rights_package_id": null,
  • "submitted_at": "2026-05-28T07:54:16.276Z",
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": null,
  • "auto_tags_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "na",
  • "faces_searched_at": null,
  • "bedrock_retrieved_at": null,
  • "custom_meta_values": [ ],
  • "user": {
    },
  • "creator_tag": null,
  • "storage_folder_path": "perception_defend69",
  • "tags": [ ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": null,
  • "preserved_filename": null,
  • "description_writer": null,
  • "country_code": null,
  • "iptc_event_id": null,
  • "organization_in_image_name": null,
  • "extended_description": null,
  • "iptc_job_id": null,
  • "intellectual_genre": null,
  • "scene": null,
  • "subject_code": null,
  • "instructions": null,
  • "iptc_rights": null,
  • "web_statement": null,
  • "model_release_status": null,
  • "property_release_status": null,
  • "authors_position": null,
  • "iptc_source": null,
  • "copyright_owner": null,
  • "iptc_dig_image_guid": null,
  • "image_supplier": null,
  • "iptc_image_supplier_image_id": null,
  • "licensor": null,
  • "addl_model_info": null,
  • "iptc_model_release_id": null,
  • "model_age": null,
  • "minor_model_age_disclosure": null,
  • "iptc_property_release_id": null,
  • "has_published_images": false,
  • "data_versions_count": 2,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "bedrock_prompt": null,
  • "bedrock_data": null,
  • "downloads_count": 0,
  • "views_count": 0,
  • "up_votes_count": 0,
  • "down_votes_count": 0,
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574478/2e5e3f71-0908-4335-a191-300a4d604046/1/1779998056/2e5e3f71-permalink.jpg?Expires=1780026857&Signature=XvfFMRDqGv8V6vR0EYOuEs1fcJYQP7WbzmqHIcnZc6Kdx-tOu6bCkiRV9PzvKBVoUjiTBkvwU3FPTCLFaIK9~xc~y4cyh~IY-ofV-7pA8NnvRYHPUutiavuoG-jyIF8sC1cGHajQ9hkkxh5DU57WsIZpeuSZquRir6lHKzPJf9fmsEaqgmTA8iBfQ0kGXRWiIZtc1j4FhvWLh7Kkj-f5OIcbFLA6MmsMsZ9~DSgFqaGdYZUsd2YjlpU5dozrfn3gFHrhVGOtdOe0BjVFX9HH~dJ8hHVeg5GXp0JQh6sT3aLp8Jk2as4H0kfVpIbrVU2uwZecaxO8qSTfKlcVxIShew__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "full_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574478/2e5e3f71-0908-4335-a191-300a4d604046/1/1779998056/2e5e3f71-full.jpg?Expires=1780026857&Signature=Kex08YHjmeQV5eG-Iq6DwcE78xL9omHAnVAzoen1lk8XFXmK9h9bjtoZLz5PeD70kb0J9zls0~cSBTj9OOWygwvyG48MuHzJU9zU~8h~pGDnIjq5Erej~xUAF4ZsiItf-5qoOwSQ~TdpnC5kKyap6jq5GlCfpJNaSnAqEyzSfDKR0YnSLhsbm197n158VoU7R2AAsW-H0h~2Y0CtXEWljNmAjoyCm1wk6xe97CKuunw~c-1xq81Ib9csE56CylUBvnzlIkBHNFJ1DwaqWyNLYfQ-TX6HJIfYtg6tqtrxvAIC6asyzMmmn2b8oMVDlHmzhzC34NXMfH7dQVqgBMrzmA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "upload": {
    },
  • "collective_work_ids": [ ]
}

Update Collective Work of Asset

Sets the associated Assets as Collective Work

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/x-www-form-urlencoded
asset_ids
Array of integers

Array of Asset IDs to set.

preview_asset_id
integer

ID of an Image Asset to use as the preview (e.g. rendered preview of an INDD)

remove_preview_asset
boolean

Set to true to remove the preview Asset

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1060943084,
  • "filename": "est.jpg",
  • "file_size": null,
  • "guid": "0db66041-8fdd-486a-8645-ffa4fe9d442b",
  • "short_guid": "0db66041",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "source_url": null,
  • "thumb_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574479/64eb5568-d227-42fb-8100-b0378486ae96/1/1779998068/64eb5568-thumb.jpg?Expires=1780026869&Signature=B804LENjX9DUDGmaughZhOwivdcpnLBE2JchLlYvTPzQcSONdwGJGdYd7cB5ihsQKPPI-g~KQt8fUcYLmSSxQcs7nQpK2XOXIFHioAOzpS6ZxWDioO9X6wlsDyR4IO6GRmYxz1yuYKQVTG5QrjUOrVMz884HqdcGEL4LWTSRVgKWFfXZ9Nub3PEv4PcoZvZla5pp96WVFKxyqNG3ZN1o777cll1jG37EjWM3j6QlX1ln8N11d0~cbKtXWJqC-NKe1PCdekLOOMHBBOPh2IVgCJAyJZLKyNKDvCTvrHUVL8ms9AAQxfehwkyYcqP6AmYn1FMsGCcWqWhSKHt981e6TA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "grid_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574479/64eb5568-d227-42fb-8100-b0378486ae96/1/1779998068/64eb5568-grid.jpg?Expires=1780026869&Signature=LhCT52~DRy6KmEw2zjB0wqHC3R6WXY8EdfG2c0t4wMe5S102OMx0aheynykPCVnKNpMZcAwrcCrJWUUO5VohlcVWwlPIfRWiXOnNwxVTo836UNHQagloqWGF9f5kOKadRyEnFdSDQVWBc3iyCJv3qV0DQjBrMCj0kuLrB2rBZKO85XGQuT4LBJv2Oaon2HVyVCnQDplZgL3kt0O9AMPNNeUVZZDUyGI5OXgX3MhjZ5sJLlmpHCloH9aXVZdDE8csKUyzqGACexrMVR9aUZcp7q7iuwMzsEiZr2ImmluXv97vSYrbEzYMufjailpZDUkHUdHBkkhgO5f-viDEuxsQ3A__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "small_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574479/64eb5568-d227-42fb-8100-b0378486ae96/1/1779998068/64eb5568-small.jpg?Expires=1780026869&Signature=JrUIcuDx8Tk-Jct6~XzMb~VUvn25kf6r3O1zsG4AoD5zdWpdL21t~xvlAZ3yUOU-zyIuSYBYrGIaiOtwig8pTpWKY3kplFd0wFl7vn4qkIUitmn17b~W5gNgOHAju0GyVfqu2rLdDkWBgraNEiJ7rkATJUrcSK6ATsdOIQZ9Mg6NGlXCNuy2Rv2NUqAq0dEM~S5C~BoToN0m1~0JkzYFP5YdAW2TL2MLoKKHf3Qul7W2ofXcROn-pS9AHR49eq-KX29i2k1-lwZDPZf-LC7-3PybvRI4Jq7Y-29k8UTs7q6Ok~WL50NfQG2St3Ag5GHSxUY0Q37s~F1eJQfNX1zKsg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "expired": false,
  • "expires_at": null,
  • "release": false,
  • "contract": false,
  • "released": false,
  • "has_people": true,
  • "headline": null,
  • "title": null,
  • "credit_line": null,
  • "event": null,
  • "city": null,
  • "state": null,
  • "country": null,
  • "sublocation": null,
  • "featured_organization_name": null,
  • "usage_terms": null,
  • "content_preview": null,
  • "has_transcript": false,
  • "transcription_job_status": null,
  • "creator": [ ],
  • "vote": {
    },
  • "nsfw_detected": false,
  • "data_version_number": 1,
  • "preview_type": "Image",
  • "downloadable_previews": true,
  • "block_level": 0,
  • "rights_package_block_level": 0,
  • "max_block_level": 0,
  • "textract_retrieved_at": null,
  • "submitted": true,
  • "preview_image_url": null,
  • "checked_out_at": null,
  • "frame_asset_id": null,
  • "frame_status": null,
  • "alt_text": null,
  • "organization_id": 1071574479,
  • "has_alpha": false,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "has_document_url": false,
  • "has_pdf_url": false,
  • "rating": null,
  • "path": null,
  • "catalogue_number": null,
  • "upload_finished_at": null,
  • "upload_started_at": null,
  • "processing_started_at": null,
  • "upload_id": 903046150,
  • "user_id": 1015819762,
  • "aasm_state": "processed",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2026-05-28T19:54:23.451Z",
  • "updated_at": "2026-05-28T19:54:29.055Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "1071574479/25e41e57/0db66041-8fdd-486a-8645-ffa4fe9d442b-est.jpg",
  • "time_to_process": 0,
  • "captured_at": "2026-05-27T19:54:23.448Z",
  • "captured_at_truncation": null,
  • "captured_at_offset": null,
  • "notes": null,
  • "created_via": null,
  • "created_via_id": null,
  • "vector": false,
  • "rights_package_id": 957290239,
  • "submitted_at": "2026-05-28T07:54:23.448Z",
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": null,
  • "auto_tags_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "na",
  • "faces_searched_at": null,
  • "bedrock_retrieved_at": null,
  • "custom_meta_values": [ ],
  • "user": {
    },
  • "rights_status": "owned",
  • "rights_status_name": "Owned by Organization",
  • "rights_status_description": "e.g. employee-created image done as part of job description, or commissioned work done under work for hire contract",
  • "creator_tag": null,
  • "storage_folder_path": "nursery-smile70",
  • "tags": [ ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": null,
  • "preserved_filename": null,
  • "description_writer": null,
  • "country_code": null,
  • "iptc_event_id": null,
  • "organization_in_image_name": null,
  • "extended_description": null,
  • "iptc_job_id": null,
  • "intellectual_genre": null,
  • "scene": null,
  • "subject_code": null,
  • "instructions": null,
  • "iptc_rights": null,
  • "web_statement": null,
  • "model_release_status": null,
  • "property_release_status": null,
  • "authors_position": null,
  • "iptc_source": null,
  • "copyright_owner": null,
  • "iptc_dig_image_guid": null,
  • "image_supplier": null,
  • "iptc_image_supplier_image_id": null,
  • "licensor": null,
  • "addl_model_info": null,
  • "iptc_model_release_id": null,
  • "model_age": null,
  • "minor_model_age_disclosure": null,
  • "iptc_property_release_id": null,
  • "has_published_images": false,
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "bedrock_prompt": null,
  • "bedrock_data": null,
  • "downloads_count": 0,
  • "views_count": 0,
  • "up_votes_count": 1,
  • "down_votes_count": 0,
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574479/64eb5568-d227-42fb-8100-b0378486ae96/1/1779998068/64eb5568-permalink.jpg?Expires=1780026869&Signature=N~v57jUOWzJrBRBNDBvQ-0txzbgSUM1U-ISdgAvSlgWVTPVteD3jr9yxyqG7i4c4vIDKQCVFjxNX-T3FFCLJZYSTMTqFR~AkWBgJy7qA0jo4LIQoJQ2tN0ZAFrgql~dl7zi8CJtd~YmSo6sZFywTx2CLSyVBr1CqnVDbnKxZz-SuxC2i9M3FSox6gsbXkCn3hhru3RUURF-39yUiwNGKuaHJ5V47yCBfFkcJd2yXYc5igKWGft0hRw4V0R7mGdQTIYDKECYmLA~s3E3FHusyJkwPc6LDlNVPU045m-j0qcsS3ZvNf2~6~l1bUPM5dJL7x3HlwQqp38uDrBgcqn~2lA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "full_url": "https://d1ecrzw50yxu6q.cloudfront.net/1071574479/64eb5568-d227-42fb-8100-b0378486ae96/1/1779998068/64eb5568-full.jpg?Expires=1780026869&Signature=X~P10j~i2LLioTeM7oT0VfTvjCEs08tFyOVYskXvLiGE9SmQ4mQtbAbuDSvpMSpQq184nDsN2ag9RqsK2rVvj288KyuN79Tog8xqGpxVlu~2sY7g9TFQRsCy-BMueZuGz4xqcuP7eUCdxiR-rLhoUGssc3LglmX-LCr-~FysCbKl8Y3hNsuUUdxeCxgRl2NMakAopeuDKOPGEhqmUc7Im0LIfQU2wn6ABNfjmvhAObzLaa3uRGJ~3GNSAiKWbgX0jdK1ae3fspqzQAxlsHbP26xpMqL~IH2CQRNSzIs6VazvJfoqfRZzEsnCdErzqBCPyRXZ5hKLbQfsgd235FWb0w__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "rights_package": {
    },
  • "upload": {
    },
  • "collective_work_asset_ids": [
    ],
  • "collective_work_ids": [ ]
}

Asset IDs Updated Since Last Sync

Returns all of your created Asset IDs with last_external_sync_at less than updated_at. The timestamp is set in Search, Details, and Update when parameter sync=true.

Authorizations:
Authorization
query Parameters
created_via
string

Service that created the Assets; uses the created_via field e.g. 'lightroom'

last_sync_at
string

Timestamp to include un-synced Assets created after this time

any_user
boolean

Include Assets from any user in the Organization (requires Content Manager or Admin permission)

custom_meta
object

Filter changed Assets by Custom Meta Values keyed by field name, e.g. {"Sync to website": "Yes"}

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • 1060943096
]

Add Assets to Collection or Lightbox

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
ids
Array of integers

Array of Asset IDs to add.

asset_group_id
integer

ID of Collection or Lightbox

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "count": 2,
  • "added": 2
}

Tag Asset

Update tags on an asset. Supports adding, removing, or replacing tags.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "asset": {
    }
}

Response samples

Content type
application/json
{
  • "tags": [
    ]
}

Asset Auto Tags

Get auto-generated tags (from AI/ML analysis) for an asset.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
auto_tags
string

Array of auto-generated tags with confidence scores

Response samples

Content type
application/json
[ ]

Asset Face Taggings

Get face detection results and their associated person tags for an asset.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
face_taggings
string

Array of detected faces with tag associations

Response samples

Content type
application/json
[ ]

Asset Counts

Get aggregated counts for assets based on the current search/filter criteria.

Authorizations:
Authorization

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "type": {
    }
}

Trashed Assets Count

Get the count of trashed assets for the current user/organization.

Authorizations:
Authorization

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "count": 0
}

Popular Assets

Get the most popular/viewed assets. Requires view_popularity_report permission.

Authorizations:
Authorization
query Parameters
dates
Array of strings

Date range for popularity stats

asset_type
string

Filter by asset type

sortField
string
Enum: "views_count" "downloads_count"

Sort field

Responses

Response Headers
total-entries
integer
Response Schema: application/json
object

Response samples

Content type
application/json
[]

Auto Tags

Auto Tags are automatically generated tags from AI/ML analysis (like AWS Rekognition). They can be converted to regular tags or dismissed.

List Auto Tags

Returns all auto tags for the organization.

Authorizations:
Authorization
query Parameters
q
string

Search by name

Responses

Response Schema: application/json
id
string

Auto Tag ID

name
string

Tag name

confidence
string

Confidence score from ML model

Response samples

Content type
application/json
[ ]

Auto Tag Details

Get details of a specific auto tag.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 690289182,
  • "source": null,
  • "list": null,
  • "name": "test-auto-tag",
  • "created_at": "2026-05-28T19:57:53.245Z",
  • "updated_at": "2026-05-28T19:57:53.245Z",
  • "visible_assets_count": null
}

Delete Auto Tag

Delete/dismiss an auto tag.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Bulk Find Auto Tags

Find multiple auto tags by their names at once.

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
tag_names
required
Array of strings

Array of auto tag names to find

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    }
]

Bulk Jobs

Bulk Jobs are used for batch operations on assets such as adding tags, updating metadata, moving assets between folders, and running AI-powered metadata generation.

List Bulk Jobs

Returns a paginated list of the current user's bulk jobs with their progress status.

Authorizations:
Authorization
query Parameters
sortField
string
Enum: "created_at" "updated_at"

Sort field

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

Bulk Job ID

guid
string

Unique identifier

aasm_state
string

Processing state: pending, processing, processed, errored, canceled

progress
string

Completion percentage (0-100)

total_assets
string

Total number of assets in the job

created_at
string

Creation timestamp

Response samples

Content type
application/json
[ ]

Create Bulk Job

Create a new bulk job to perform batch operations on assets. Specify asset_ids and one or more operations to perform.

Common operations include:

  • Tag Management: Add, remove, or replace tags using tag_names and tag_mode
  • Metadata Updates: Update description, rights package, custom meta fields
  • Asset Organization: Move to folders/collections using add_asset_group_id
  • AI Processing: Run CAI fields using run_custom_meta_field_ids
Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
id
string

Created Bulk Job ID

guid
string

Unique identifier for tracking

aasm_state
string

Initial state (pending)

Request samples

Content type
application/json
{
  • "bulk_job": {
    }
}

Response samples

Content type
application/json
{
  • "guid": "35975078-8474-4db1-83a3-1b805a904e28",
  • "progress": null,
  • "destroy_all": false,
  • "action": "Bulk Asset Edit: Tags",
  • "aasm_state": "pending",
  • "total_assets": 0,
  • "error_message": null,
  • "warnings": null,
  • "error": null
}

List Processing Bulk Jobs

Returns bulk jobs that are currently in the processing state for the current user.

Authorizations:
Authorization

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[ ]

Bulk Job Details

Get details of a specific bulk job by its GUID.

Authorizations:
Authorization
path Parameters
id
required
string

Responses

Response Schema: application/json
id
string

Bulk Job ID

guid
string

Unique identifier

aasm_state
string

Processing state

progress
string

Completion percentage

total_assets
string

Total number of assets

error_message
string

Error message if job failed

warnings
string

Array of warning messages from processing

started_processing_at
string

Timestamp when processing began

finished_processing_at
string

Timestamp when processing completed

Response samples

Content type
application/json
{
  • "guid": "39749b56-5bc4-4034-b057-26c958fb734b",
  • "progress": 0,
  • "destroy_all": false,
  • "action": "Bulk Asset Edit: Meta",
  • "aasm_state": "pending",
  • "total_assets": 0,
  • "error_message": null,
  • "warnings": null,
  • "error": null
}

Cancel Bulk Job

Cancel a pending or processing bulk job. The job must belong to the current user.

Authorizations:
Authorization
path Parameters
id
required
string

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Undo Bulk Job

Create a new bulk job that reverts the changes made by a previous bulk job. Reverts asset metadata, taggings, custom meta values, and asset-group memberships per-field, preserving any field the user has changed since the original bulk job ran. Refused for jobs older than 30 days. Authorization: any user can undo their own bulk jobs; admin and global_content members can undo any in the org.

Authorizations:
Authorization
path Parameters
id
required
string

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "guid": "471862b9-33e8-46e5-9cb4-5a7b022fd2dc",
  • "progress": null,
  • "destroy_all": false,
  • "action": "Bulk Asset Edit: Meta",
  • "aasm_state": "pending",
  • "total_assets": 0,
  • "error_message": null,
  • "warnings": null,
  • "error": null
}

CAI Preview

Preview which assets have existing values for specified Composable AI (CAI) custom meta fields. This helps users understand the impact of running AI on assets with or without existing data.

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
asset_ids
required
Array of integers

Array of Asset IDs to check

cmf_ids
required
Array of integers

Array of Custom Meta Field IDs to check

Responses

Response Schema: application/json
total_assets
string

Total number of assets checked

total_cmfs
string

Total number of CMF fields checked

counts_by_field
string

Breakdown by field showing assets with/without values

summary
string

Overall summary of assets with/without any values

Response samples

Content type
application/json
{
  • "total_assets": 2,
  • "total_cmfs": 1,
  • "counts_by_field": {
    },
  • "summary": {
    }
}

Bulk Job Assets

Returns a paginated list of assets that were processed by this bulk job.

Authorizations:
Authorization
path Parameters
id
required
string

Responses

Response Headers
total-entries
integer
Response Schema: application/json
assets
string

Array of asset objects

Response samples

Content type
application/json
[]

Bulk Job Queue Position

Get the current queue position for a pending bulk job. Returns null if the job is not in the queue (already processing or completed).

Authorizations:
Authorization
path Parameters
id
required
string

Responses

Response Schema: application/json
guid
string

Bulk Job GUID

queue_position
string

Position in the processing queue (null if not queued)

queue_depth
string

Total jobs in queue

aasm_state
string

Current processing state

progress
string

Completion percentage

Response samples

Content type
application/json
{
  • "guid": "a65074b4-a26b-46ba-a77d-72ae5d5b5f40",
  • "queue_position": null,
  • "queue_depth": null,
  • "aasm_state": "pending",
  • "progress": null
}

Collection Shares

Collection Shares enable federated sharing of Collections between organizations within a Federation. This allows one organization to share their collections with other organizations in the same federation.

Search Collection Shares

Search through shared collections by name.

Authorizations:
Authorization
query Parameters
q
required
string

Search query for collection name

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    }
]

Collection Shares Tree

Get a tree view of shared collections. When no parent_id is provided, returns shared libraries (organizations sharing with you). When parent_id is provided, returns the children of that collection.

Authorizations:
Authorization
query Parameters
parent_id
integer

Parent collection or organization ID

sub_type
string

Type of parent: 'CollectionShare' for organization root

Responses

Response Schema: application/json
shared_libraries
string

List of organizations sharing collections (at root level)

collections
string

List of shared collections

Response samples

Content type
application/json
[ ]

Collection Share Details

Get details of a specific collection share.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
id
string

Collection Share ID

name
string

Custom name for the share

description
string

Description

asset_group_id
string

Source collection ID

Response samples

Content type
application/json
{
  • "id": 935961046,
  • "name": null,
  • "description": null,
  • "permission_ids_by_user_group": { },
  • "user_id": 1015820367,
  • "created_at": "2026-05-28T20:00:05.404Z",
  • "updated_at": "2026-05-28T20:00:05.404Z",
  • "permissions": [ ],
  • "organization": {
    }
}

Update Collection Share

Update a collection share configuration, including permissions.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "collection_share": {
    }
}

Response samples

Content type
application/json
{
  • "id": 935961047,
  • "name": "Updated Share Name",
  • "description": "Updated description",
  • "permission_ids_by_user_group": { },
  • "user_id": 1015820382,
  • "created_at": "2026-05-28T20:00:14.500Z",
  • "updated_at": "2026-05-28T20:00:14.738Z",
  • "permissions": [ ],
  • "organization": {
    }
}

Delete Collection Share

Remove a collection share. The source collection is not affected.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Collections

Collection resources.

Collections Index

Authorizations:
Authorization
query Parameters
q
string

Search by name

parent_id
integer

Parent Collection ID

Responses

Response Headers
total-entries
integer
Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    }
]

Create Collection

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "collection": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1073068544,
  • "created_at": "2026-05-28T20:00:46.174Z",
  • "path_names": [
    ],
  • "path_slugs": [
    ],
  • "slug": "test-collection",
  • "sandbox": false,
  • "organizer": null,
  • "type": "Collection",
  • "has_children": false,
  • "parent_id": 1073068543,
  • "ancestor_ids": [
    ],
  • "permission_ids": [ ],
  • "visible_assets_count": null,
  • "asset_group_id": 1073068544,
  • "has_workflow_steps": false,
  • "sort_order": null,
  • "featured": false,
  • "sortable": true,
  • "user_group_id": null,
  • "auto_group": null,
  • "view_settings": null,
  • "enable_embargo": false,
  • "embargo_ends_at": null,
  • "embargoed": false,
  • "children_sort_order": null,
  • "parent_children_sort_order": "name-asc",
  • "position": 1,
  • "last_lightroom_sync_at": null,
  • "created_via": null,
  • "created_via_id": null,
  • "reindexing_at": null,
  • "has_collection_shares": false,
  • "already_shared_with_current_organization": null,
  • "organization_id": 1071574525,
  • "organization_slug": "bechtelarstark",
  • "user": {
    },
  • "editable": true,
  • "can_update_assets": true,
  • "name": "Test Collection",
  • "description": null,
  • "permissions": [ ],
  • "workflow_steps": [ ],
  • "collections": [ ],
  • "enable_toc": true,
  • "toc_copy": null,
  • "toc_contact": null,
  • "enable_poster_image": false,
  • "poster_image": null,
  • "links": [ ],
  • "asset_group_admins": [ ],
  • "webhooks": [ ]
}

Collections Tree

For tree traversal. All children of the Parent folder specified by parent_id (or blank for root level) will be returned.

Authorizations:
Authorization
query Parameters
parent_id
integer

ID of parent folder, blank for root level

Responses

Response Headers
total-entries
integer
Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Collections Details

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1073068508,
  • "created_at": "2026-05-28T20:00:40.780Z",
  • "path_names": [
    ],
  • "path_slugs": [
    ],
  • "slug": "rung-copy159",
  • "sandbox": false,
  • "organizer": false,
  • "type": "Collection",
  • "has_children": false,
  • "parent_id": null,
  • "ancestor_ids": [ ],
  • "permission_ids": [ ],
  • "visible_assets_count": 0,
  • "asset_group_id": 1073068508,
  • "has_workflow_steps": false,
  • "sort_order": null,
  • "featured": false,
  • "sortable": true,
  • "user_group_id": null,
  • "auto_group": null,
  • "view_settings": null,
  • "enable_embargo": false,
  • "embargo_ends_at": null,
  • "embargoed": false,
  • "children_sort_order": null,
  • "parent_children_sort_order": "name-asc",
  • "position": 22,
  • "last_lightroom_sync_at": null,
  • "created_via": null,
  • "created_via_id": null,
  • "reindexing_at": null,
  • "has_collection_shares": false,
  • "already_shared_with_current_organization": null,
  • "organization_id": 1071574524,
  • "organization_slug": "waelchi-fritsch-and-heidenreich",
  • "user": {
    },
  • "editable": true,
  • "can_update_assets": true,
  • "name": "Munch159",
  • "description": "Facere nihil omnis. Error nostrum nulla. Ex tempora labore.",
  • "permissions": [ ],
  • "workflow_steps": [ ],
  • "enable_toc": false,
  • "toc_copy": null,
  • "toc_contact": null,
  • "enable_poster_image": true,
  • "poster_image": null,
  • "links": [ ],
  • "asset_group_admins": [ ],
  • "webhooks": [ ]
}

Update Collection

Update collection name, description, and settings.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "collection": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1073068625,
  • "created_at": "2026-05-28T20:00:59.199Z",
  • "path_names": [
    ],
  • "path_slugs": [
    ],
  • "slug": "updated-collection-name",
  • "sandbox": false,
  • "organizer": false,
  • "type": "Collection",
  • "has_children": false,
  • "parent_id": null,
  • "ancestor_ids": [ ],
  • "permission_ids": [ ],
  • "visible_assets_count": null,
  • "asset_group_id": 1073068625,
  • "has_workflow_steps": false,
  • "sort_order": null,
  • "featured": false,
  • "sortable": true,
  • "user_group_id": null,
  • "auto_group": null,
  • "view_settings": null,
  • "enable_embargo": false,
  • "embargo_ends_at": null,
  • "embargoed": false,
  • "children_sort_order": null,
  • "parent_children_sort_order": "name-asc",
  • "position": 22,
  • "last_lightroom_sync_at": null,
  • "created_via": null,
  • "created_via_id": null,
  • "reindexing_at": null,
  • "has_collection_shares": false,
  • "already_shared_with_current_organization": null,
  • "organization_id": 1071574527,
  • "organization_slug": "schowalter-and-sons",
  • "user": {
    },
  • "editable": true,
  • "can_update_assets": true,
  • "name": "Updated Collection Name",
  • "description": "Updated description",
  • "permissions": [ ],
  • "workflow_steps": [ ],
  • "enable_toc": false,
  • "toc_copy": null,
  • "toc_contact": null,
  • "enable_poster_image": true,
  • "poster_image": null,
  • "links": [ ],
  • "asset_group_admins": [ ],
  • "webhooks": [ ]
}

Delete Collection

Delete a collection. Assets in the collection are not deleted. The collection is queued for deletion.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Add Asset

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/x-www-form-urlencoded
asset_id
integer

ID of Asset To Add

position
integer

ID of parent folder, blank for root level

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1052042141,
  • "asset_group_id": 1073068579,
  • "asset_id": 1060943163,
  • "user_id": 1015820453,
  • "created_at": "2026-05-28T20:00:53.936Z",
  • "updated_at": "2026-05-28T20:00:53.936Z",
  • "approval_id": null,
  • "position": 1,
  • "last_lightroom_sync_at": null,
  • "workflow_step_id": null
}

Find Collection by Slug

Find a collection by its slug.

Authorizations:
Authorization
query Parameters
slug
required
string

Collection slug

organization_slug
string

Organization slug (for cross-org lookups)

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1073068695,
  • "created_at": "2026-05-28T20:01:10.048Z",
  • "path_names": [
    ],
  • "path_slugs": [
    ],
  • "slug": "corpse_judge165",
  • "sandbox": false,
  • "organizer": false,
  • "type": "Collection",
  • "has_children": false,
  • "parent_id": null,
  • "ancestor_ids": [ ],
  • "permission_ids": [ ],
  • "visible_assets_count": null,
  • "asset_group_id": 1073068695,
  • "has_workflow_steps": false,
  • "sort_order": null,
  • "featured": false,
  • "sortable": true,
  • "user_group_id": null,
  • "auto_group": null,
  • "view_settings": null,
  • "enable_embargo": false,
  • "embargo_ends_at": null,
  • "embargoed": false,
  • "children_sort_order": null,
  • "parent_children_sort_order": "name-asc",
  • "position": 22,
  • "last_lightroom_sync_at": null,
  • "created_via": null,
  • "created_via_id": null,
  • "reindexing_at": null,
  • "has_collection_shares": false,
  • "already_shared_with_current_organization": null,
  • "organization_id": 1071574529,
  • "organization_slug": "ebert-bashirian-and-hessel",
  • "user": {
    },
  • "editable": true,
  • "can_update_assets": true,
  • "name": "Munch165",
  • "description": "At totam et. Vel natus quas. Animi ut et.",
  • "commentable": true,
  • "commentable_id": 1073068695,
  • "comments_count": 0
}

Visible Asset Counts

Get the visible asset count for multiple collections at once.

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
asset_groups
required
Array of objects

Array of asset group objects with IDs

Responses

Response Schema: application/json
counts
string

Hash of collection ID to asset count

Response samples

Content type
application/json
[
  • {
    }
]

Comments

Comments allow users to have discussions on Lightboxes and Collections. Comments support @mentions and are rendered as markdown.

Note: The index and create endpoints require type and id query parameters to identify the commentable object (Lightbox or Collection).

List Comments

Returns all comments for a specific Lightbox or Collection. Requires type and id parameters to identify the commentable object.

Authorizations:
Authorization
query Parameters
type
required
string

Type of commentable object (Lightbox or Collection)

id
required
integer

ID of the commentable object

Responses

Response Schema: application/json
id
string

Comment ID

text
string

Comment text (markdown)

html
string

Rendered HTML content

user
string

Author information

what_type
string

Type of commented object

what_id
string

ID of commented object

mentioned_user_ids
string

IDs of mentioned users

created_at
string

Creation timestamp

updated_at
string

Last update timestamp

edited_at
string

When comment was edited (if applicable)

Response samples

Content type
application/json
[
  • {
    }
]

Create Comment

Create a new comment on a Lightbox or Collection. Supports markdown formatting and @mentions.

Authorizations:
Authorization
Request Body schema: application/json
type
required
string

Type of commentable object (Lightbox or Collection)

id
required
integer

ID of the commentable object

object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "type": "string",
  • "id": 0,
  • "comment": {
    }
}

Response samples

Content type
application/json
{
  • "id": 3,
  • "text": "Great work on this lightbox!",
  • "html": "<p>Great work on this lightbox!</p>\n",
  • "edited_at": null,
  • "what_id": 1073068790,
  • "what_type": "AssetGroup",
  • "mentioned_user_ids": "[]",
  • "created_at": "2026-05-28T20:01:25.222Z",
  • "updated_at": "2026-05-28T20:01:25.222Z",
  • "user": {
    },
  • "lightbox": {
    }
}

Update Comment

Update a comment's text. Only the comment author can update their own comments. The edited_at timestamp is automatically set when updating.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "comment": {
    }
}

Response samples

Content type
application/json
{
  • "id": 4,
  • "text": "Updated comment text",
  • "html": "<p>Updated comment text</p>\n",
  • "edited_at": "2026-05-28T20:01:30.113Z",
  • "what_id": 1073068820,
  • "what_type": "AssetGroup",
  • "mentioned_user_ids": "[]",
  • "created_at": "2026-05-28T20:01:30.100Z",
  • "updated_at": "2026-05-28T20:01:30.117Z",
  • "user": {
    },
  • "lightbox": {
    }
}

Delete Comment

Delete a comment. Only the comment author can delete their own comments.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Contributions

Contributions (Upload Links) allow organizations to receive asset uploads from external contributors. Each contribution can have specific settings for where assets are stored, what metadata is collected, and how uploads are processed.

List Contributions

Returns a paginated list of contribution forms (upload links) for the organization.

Authorizations:
Authorization
query Parameters
q
string

Search by contribution name

enabled
Array of strings

Filter by enabled status

featured
Array of strings

Filter by featured status

enable_public
Array of strings

Filter by public visibility

sortField
string
Enum: "name" "user_groups.name" "asset_groups.name" "slug" "enable_quick_upload" "uploads_count" "contribution_memberships_count" "assets_count"

Sort field

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

Contribution ID

name
string

Contribution name

slug
string

URL slug

enabled
string

Whether the contribution is active

featured
string

Whether shown on organization page

enable_public
string

Whether publicly accessible

storage_folder_id
string

Target storage folder for uploads

Response samples

Content type
application/json
[
  • {
    }
]

Create Contribution

Create a new contribution form (upload link).

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
id
string

Created Contribution ID

slug
string

Generated URL slug

Request samples

Content type
application/json
{
  • "contribution": {
    }
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "id": 1025835755,
  • "name": "New Upload Link",
  • "text": null,
  • "featured": true,
  • "slug": "new-upload-link",
  • "storage_folder_id": 1073069090,
  • "auto_approve": false,
  • "auto_add": false,
  • "asset_group_id": null,
  • "enable_comprehensive_tagging": false,
  • "request_people_tags": false,
  • "enable_tag_suggester": false,
  • "enable_quick_upload": false,
  • "create_place_name_tags": false,
  • "created_at": "2026-05-28T20:02:12.109Z",
  • "updated_at": "2026-05-28T20:02:12.109Z",
  • "rights_package_ids": [ ],
  • "require_rights_package": false,
  • "require_creator_tag": false,
  • "uploads_count": 0,
  • "assets_count": 0,
  • "user_assets_count": 0,
  • "type": "link",
  • "is_public": false,
  • "notify_emails": [ ],
  • "notify_copy": null,
  • "membership_ids": [ ],
  • "contribution_memberships_count": 0,
  • "enable_public": false,
  • "to_param": "1025835755-new-upload-link",
  • "tag_names": [ ],
  • "contribution_tag_suggesters_attributes": [ ],
  • "rights_packages": [ ],
  • "storage_folder": {
    },
  • "editable": true,
  • "pending_uploads_count": 0
}

List Featured Contributions

Returns featured contributions that are displayed on the organization's public page.

Authorizations:
Authorization

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    }
]

List Group Contributions

Returns contributions associated with user groups.

Authorizations:
Authorization

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[ ]

List Standalone Link Contributions

Returns standalone contributions (not associated with user groups) that the user has uploaded to.

Authorizations:
Authorization

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    }
]

List Lightbox Contributions

Returns contributions configured for lightbox uploads.

Authorizations:
Authorization

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[ ]

Find Contribution by Slug

Find a contribution by its URL slug.

Authorizations:
Authorization
query Parameters
slug
required
string

Contribution URL slug

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "enabled": true,
  • "id": 1025835718,
  • "name": "ut",
  • "text": "Quo labore necessitatibus. Facere officiis non. Reprehenderit consequuntur non.",
  • "featured": true,
  • "slug": "academy-introduction",
  • "storage_folder_id": 1073069030,
  • "auto_approve": false,
  • "auto_add": false,
  • "asset_group_id": null,
  • "enable_comprehensive_tagging": false,
  • "request_people_tags": false,
  • "enable_tag_suggester": false,
  • "enable_quick_upload": false,
  • "create_place_name_tags": false,
  • "created_at": "2026-05-28T20:02:03.015Z",
  • "updated_at": "2026-05-28T20:02:03.015Z",
  • "rights_package_ids": [ ],
  • "require_rights_package": false,
  • "require_creator_tag": false,
  • "uploads_count": 0,
  • "assets_count": 0,
  • "user_assets_count": 0,
  • "type": "link",
  • "is_public": false,
  • "notify_emails": [ ],
  • "notify_copy": null,
  • "membership_ids": [ ],
  • "contribution_memberships_count": 0,
  • "enable_public": false,
  • "to_param": "1025835718-ut",
  • "tag_names": [ ],
  • "contribution_tag_suggesters_attributes": [ ],
  • "rights_packages": [ ],
  • "storage_folder": {
    },
  • "editable": true,
  • "pending_uploads_count": 0
}

Contribution Details

Get details of a specific contribution.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
id
string

Contribution ID

name
string

Contribution name

slug
string

URL slug

text
string

Description/instructions text

enabled
string

Whether active

featured
string

Whether featured on public page

enable_public
string

Whether publicly accessible

auto_approve
string

Auto-approve uploads

auto_add
string

Auto-add to workflow

storage_folder_id
string

Target storage folder

asset_group_id
string

Target collection/lightbox ID

enable_tag_suggester
string

Show tag suggestions

enable_quick_upload
string

Enable simplified upload UI

require_rights_package
string

Require rights package selection

require_creator_tag
string

Require creator tag

tag_suggesters
string

Available tag suggesters

Response samples

Content type
application/json
{
  • "enabled": true,
  • "id": 1025835736,
  • "name": "distinctio",
  • "text": "Et qui facilis. Nihil corporis praesentium. Assumenda minima qui.",
  • "featured": true,
  • "slug": "outside_compete",
  • "storage_folder_id": 1073069060,
  • "auto_approve": false,
  • "auto_add": false,
  • "asset_group_id": null,
  • "enable_comprehensive_tagging": false,
  • "request_people_tags": false,
  • "enable_tag_suggester": false,
  • "enable_quick_upload": false,
  • "create_place_name_tags": false,
  • "created_at": "2026-05-28T20:02:07.459Z",
  • "updated_at": "2026-05-28T20:02:07.459Z",
  • "rights_package_ids": [ ],
  • "require_rights_package": false,
  • "require_creator_tag": false,
  • "uploads_count": 0,
  • "assets_count": 0,
  • "user_assets_count": 0,
  • "type": "link",
  • "is_public": false,
  • "notify_emails": [ ],
  • "notify_copy": null,
  • "membership_ids": [ ],
  • "contribution_memberships_count": 0,
  • "enable_public": false,
  • "to_param": "1025835736-distinctio",
  • "tag_names": [ ],
  • "contribution_tag_suggesters_attributes": [ ],
  • "rights_packages": [ ],
  • "storage_folder": {
    },
  • "editable": true,
  • "pending_uploads_count": 0
}

Update Contribution

Update an existing contribution configuration.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "contribution": {
    }
}

Response samples

Content type
application/json
{
  • "enabled": false,
  • "id": 1025835773,
  • "name": "Updated Contribution Name",
  • "text": "Velit commodi earum. Esse voluptas atque. Voluptate repudiandae ullam.",
  • "featured": true,
  • "slug": "outside_satisfaction",
  • "storage_folder_id": 1073069120,
  • "auto_approve": false,
  • "auto_add": false,
  • "asset_group_id": null,
  • "enable_comprehensive_tagging": false,
  • "request_people_tags": false,
  • "enable_tag_suggester": false,
  • "enable_quick_upload": false,
  • "create_place_name_tags": false,
  • "created_at": "2026-05-28T20:02:16.674Z",
  • "updated_at": "2026-05-28T20:02:16.684Z",
  • "rights_package_ids": [ ],
  • "require_rights_package": false,
  • "require_creator_tag": false,
  • "uploads_count": 0,
  • "assets_count": 0,
  • "user_assets_count": 0,
  • "type": "link",
  • "is_public": false,
  • "notify_emails": [ ],
  • "notify_copy": null,
  • "membership_ids": [ ],
  • "contribution_memberships_count": 0,
  • "enable_public": false,
  • "to_param": "1025835773-updated-contribution-name",
  • "tag_names": [ ],
  • "contribution_tag_suggesters_attributes": [ ],
  • "rights_packages": [ ],
  • "storage_folder": {
    },
  • "editable": true,
  • "pending_uploads_count": 0
}

Delete Contribution

Permanently delete a contribution. Existing uploads are not affected.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Creator Tags

Creator Tags represent photographers, artists, or other content creators. They can be associated with assets to track authorship.

List Creator Tags

Returns all creator tags for the organization.

Authorizations:
Authorization
query Parameters
q
string

Search by name

sortField
string
Enum: "name" "assets_count"

Sort field

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

Creator Tag ID

name
string

Creator name

Response samples

Content type
application/json
[
  • {
    }
]

Create Creator Tag

Create a new creator tag for the organization.

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "creator_tag": {
    }
}

Response samples

Content type
application/json
{
  • "id": 243514155,
  • "name": "John Photographer",
  • "description": null,
  • "user_id": 1015820651,
  • "linked_user_id": null,
  • "created_at": "2026-05-28T20:02:34.684Z",
  • "updated_at": "2026-05-28T20:02:34.684Z",
  • "user": {
    },
  • "city": null,
  • "country": null,
  • "address_1": null,
  • "postcode": null,
  • "region": null,
  • "email": null,
  • "tel": null,
  • "url": null,
  • "linked_user": null,
  • "editable": true,
  • "links": [ ]
}

Creator Tag Details

Get details of a specific creator tag.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 243514153,
  • "name": "Ying Gleason",
  • "description": null,
  • "user_id": null,
  • "linked_user_id": null,
  • "created_at": "2026-05-28T20:02:30.282Z",
  • "updated_at": "2026-05-28T20:02:30.282Z",
  • "city": null,
  • "country": null,
  • "address_1": null,
  • "postcode": null,
  • "region": null,
  • "email": null,
  • "tel": null,
  • "url": null,
  • "linked_user": null,
  • "editable": true,
  • "links": [ ]
}

Update Creator Tag

Update a creator tag's information.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "creator_tag": {
    }
}

Response samples

Content type
application/json
{
  • "id": 243514157,
  • "name": "Updated Creator Name",
  • "description": null,
  • "user_id": null,
  • "linked_user_id": null,
  • "created_at": "2026-05-28T20:02:43.703Z",
  • "updated_at": "2026-05-28T20:02:43.713Z",
  • "city": null,
  • "country": null,
  • "address_1": null,
  • "postcode": null,
  • "region": null,
  • "email": null,
  • "tel": null,
  • "url": null,
  • "linked_user": null,
  • "editable": true,
  • "links": [ ]
}

Delete Creator Tag

Delete a creator tag.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Find Creator Tags

Find creator tags by their IDs.

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
ids
Array of integers

Array of creator tag IDs to find

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    }
]

Crop Presets

Crop Presets define standard crop sizes for asset downloads. Organizations can create named presets with specific dimensions.

List Crop Presets

Returns all crop presets for the organization.

Authorizations:
Authorization

Responses

Response Schema: application/json
id
string

Crop Preset ID

name
string

Preset name

width
string

Width in pixels

height
string

Height in pixels

Response samples

Content type
application/json
[
  • {
    }
]

Create Crop Preset

Create a new crop preset for the organization.

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "crop_preset": {
    }
}

Response samples

Content type
application/json
{
  • "id": 356730636,
  • "organization_id": 1071574553,
  • "user_id": 1015820705,
  • "enabled": true,
  • "name": "Social Media",
  • "width": 1200,
  • "height": 630,
  • "position": 1,
  • "created_at": "2026-05-28T20:03:01.673Z",
  • "updated_at": "2026-05-28T20:03:01.673Z"
}

Crop Preset Details

Get details of a specific crop preset.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 356730634,
  • "user_id": 1015820696,
  • "enabled": true,
  • "name": "Faker::Camera",
  • "width": 535,
  • "height": 493,
  • "position": 0,
  • "created_at": "2026-05-28T20:02:57.160Z",
  • "updated_at": "2026-05-28T20:02:57.160Z",
  • "closest_size": "small"
}

Update Crop Preset

Update a crop preset's settings.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "crop_preset": {
    }
}

Response samples

Content type
application/json
{
  • "organization_id": 1071574554,
  • "name": "Updated Preset Name",
  • "id": 356730637,
  • "user_id": 1015820714,
  • "enabled": true,
  • "width": 721,
  • "height": 220,
  • "position": 0,
  • "created_at": "2026-05-28T20:03:06.181Z",
  • "updated_at": "2026-05-28T20:03:06.191Z"
}

Delete Crop Preset

Delete a crop preset.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Update Crop Preset Position

Move a crop preset from one position to another.

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
oldIndex
required
integer

Current position index

newIndex
required
integer

New position index

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Custom Meta Fields

Custom Meta Fields allow organizations to define custom metadata schemas for their assets. Fields can be controlled vocabularies (dropdown/multi-select), free text, or AI-powered (CAI - Composable AI) for automated metadata generation.

List Custom Meta Fields

Returns a list of custom meta fields for the organization, optionally filtered by various criteria.

Authorizations:
Authorization
query Parameters
owner_type
string
Default: "Asset"
Enum: "Asset" "AccessRequest"

Filter by owner type

enabled
Array of strings

Filter by enabled status

multi
Array of strings

Filter by multi-select status

free
Array of strings

Filter by free text status

value_type
string
Enum: "text" "number" "date"

Filter by value type

enable_action_menu
Array of strings

Filter by action menu enabled

enable_ai
Array of strings

Filter by AI enabled (CAI fields)

with_color_labels
boolean

Only return fields with color labels

action_menu
boolean

Only return action menu fields

filter_by_role
string

Filter by user role visibility (default: true)

q
string

Search by name or description

Responses

Response Schema: application/json
id
string

Custom Meta Field ID

name
string

Field name

description
string

Field description

free
string

Whether free text input is allowed

multi
string

Whether multiple values can be selected

enabled
string

Whether the field is active

enable_ai
string

Whether AI generation is enabled (CAI)

position
string

Display order position

value_type
string

Value type: text, number, or date

custom_meta_values
string

Available values for controlled vocabularies

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Create Custom Meta Field

Create a new custom meta field for the organization.

Value Types:

  • text - Text input (default)
  • number - Numeric input
  • date - Date picker

For Controlled Vocabularies: Set free: false and provide custom_meta_values_attributes with the allowed values.

For AI (CAI) Fields: Set enable_ai: true along with model, prompt, and source_data configuration.

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
id
string

Created Custom Meta Field ID

Request samples

Content type
application/json
{
  • "custom_meta_field": {
    }
}

Response samples

Content type
application/json
{
  • "id": 879201727,
  • "type": null,
  • "free": true,
  • "name": "Project Code",
  • "description": "Internal project identifier",
  • "multi": false,
  • "created_at": "2026-05-28T20:03:33.263Z",
  • "updated_at": "2026-05-28T20:03:33.263Z",
  • "number": 1,
  • "owner_type": null,
  • "required": false,
  • "value_type": "text",
  • "enable_action_menu": false,
  • "enabled": true,
  • "enable_ai": false,
  • "model": null,
  • "prompt": null,
  • "source_data": null,
  • "auto_run": false,
  • "asset_types": [ ],
  • "destination": null,
  • "enable_controlled_vocab_creation": false,
  • "position": 1,
  • "notes": null,
  • "minimum_role_level": null,
  • "enable_rename": false,
  • "user": {
    },
  • "custom_meta_values_attributes": [ ]
}

Custom Meta Field Details

Get details of a specific custom meta field including all values.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
id
string

Custom Meta Field ID

name
string

Field name

description
string

Field description

free
string

Whether free text is allowed

multi
string

Whether multiple values allowed

enabled
string

Whether field is active

required
string

Whether field is required

enable_ai
string

Whether AI generation is enabled

model
string

AI model ID for CAI fields

prompt
string

AI prompt template for CAI fields

source_data
string

Source data configuration for CAI

destination
string

Destination field for AI output

auto_run
string

Whether to auto-run AI on new assets

asset_types
string

Array of asset types this field applies to

custom_meta_values
string

Available controlled vocabulary values

Response samples

Content type
application/json
{
  • "id": 879201722,
  • "type": null,
  • "free": false,
  • "name": "Category",
  • "description": null,
  • "multi": false,
  • "created_at": "2026-05-28T20:03:28.843Z",
  • "updated_at": "2026-05-28T20:03:28.843Z",
  • "number": 4,
  • "owner_type": "Asset",
  • "required": false,
  • "value_type": "text",
  • "enable_action_menu": false,
  • "enabled": true,
  • "enable_ai": false,
  • "model": null,
  • "prompt": null,
  • "source_data": null,
  • "auto_run": false,
  • "asset_types": [ ],
  • "destination": null,
  • "enable_controlled_vocab_creation": false,
  • "position": 4,
  • "notes": null,
  • "minimum_role_level": null,
  • "enable_rename": false,
  • "user": {
    },
  • "custom_meta_values_attributes": [ ]
}

Update Custom Meta Field

Update an existing custom meta field configuration.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "custom_meta_field": {
    }
}

Response samples

Content type
application/json
{
  • "id": 879201736,
  • "type": null,
  • "free": false,
  • "name": "Updated Category",
  • "description": "Updated description",
  • "multi": false,
  • "created_at": "2026-05-28T20:03:42.175Z",
  • "updated_at": "2026-05-28T20:03:42.187Z",
  • "number": 4,
  • "owner_type": "Asset",
  • "required": false,
  • "value_type": "text",
  • "enable_action_menu": false,
  • "enabled": true,
  • "enable_ai": false,
  • "model": null,
  • "prompt": null,
  • "source_data": null,
  • "auto_run": false,
  • "asset_types": [ ],
  • "destination": null,
  • "enable_controlled_vocab_creation": false,
  • "position": 4,
  • "notes": null,
  • "minimum_role_level": null,
  • "enable_rename": false,
  • "user": {
    },
  • "custom_meta_values_attributes": [ ]
}

Delete Custom Meta Field

Permanently delete a custom meta field. All associated values on assets will be removed.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Export Field Configuration

Export one or more custom meta field configurations as JSON for backup or importing into another organization.

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
ids
required
Array of integers

Array of custom meta field IDs to export

Responses

Response Schema: application/json
name
string

Field name

description
string

Field description

settings
string

All field settings

values
string

Controlled vocabulary values

Response samples

Content type
application/json
[
  • {
    }
]

Import Field Configuration

Import custom meta field configuration(s) from a JSON file (previously exported).

Authorizations:
Authorization
Request Body schema: multipart/form-data
file
required
string <binary>

JSON file containing field configuration

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    }
]

Access Request Fields

Get custom meta fields configured for access requests (owner_type: AccessRequest).

Authorizations:
Authorization

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    }
]

Downloads

Downloading Assets.

Prepare Download

Supply the size and asset IDs to download to receive the token which can then be used within the next 5 minutes to start the data download. Partial downloading is supported using the header: Range: bytes=<start>-<end>

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
token
string

The unique token that can be used to download the data using the show endpoint

filename
string

The suggested filename to use to save the file locally

Request samples

Content type
application/json
{
  • "download": {
    }
}

Response samples

Content type
application/json
{
  • "token": "8ed1bdf2bad52c4a95290e55e8b65c03",
  • "filename": "leannonhilll-mediagraph-download-#1046393414.zip",
  • "integration": null
}

Start Download

Use the token created in the create endpoint to start the streaming data download.

Authorizations:
Authorization
query Parameters
token
string

The token created in the Initiate Download call

Responses

Response Schema: application/zip
object

Filter Groups

Filter Groups allow organizations to save and organize search filter configurations. Users can create named filter groups to quickly apply common search criteria.

List Filter Groups

Returns all filter groups for the organization.

Authorizations:
Authorization

Responses

Response Schema: application/json
id
string

Filter Group ID

name
string

Filter group name

filters
string

Array of filter configurations

position
string

Display order position

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create Filter Group

Create a new filter group with saved filter configurations.

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
id
string

Created Filter Group ID

Request samples

Content type
application/json
{
  • "filter_group": {
    }
}

Response samples

Content type
application/json
{
  • "id": 643325380,
  • "organization_id": 1071574571,
  • "user_id": 1015820883,
  • "name": "My Saved Filters",
  • "filters": null,
  • "position": 3,
  • "created_at": "2026-05-28T20:04:34.159Z",
  • "updated_at": "2026-05-28T20:04:34.159Z"
}

Filter Group Details

Get details of a specific filter group.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 643325377,
  • "organization_id": 1071574570,
  • "user_id": 1015820874,
  • "name": "quos",
  • "position": 2,
  • "created_at": "2026-05-28T20:04:29.597Z",
  • "updated_at": "2026-05-28T20:04:29.597Z",
  • "filters": [ ]
}

Update Filter Group

Update a filter group configuration.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "filter_group": {
    }
}

Response samples

Content type
application/json
{
  • "organization_id": 1071574572,
  • "name": "Updated Filter Group",
  • "id": 643325382,
  • "user_id": 1015820892,
  • "filters": [ ],
  • "position": 2,
  • "created_at": "2026-05-28T20:04:38.529Z",
  • "updated_at": "2026-05-28T20:04:38.542Z"
}

Delete Filter Group

Delete a filter group.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Update Filter Visibility

Update the visibility of a specific filter within a filter group.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/x-www-form-urlencoded
name
required
string

Filter name

type
required
string

Visibility type (explore or manage)

visible
required
string
Enum: "true" "false"

Visibility status

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Ingestions

Ingestions track the status of asset uploads from external sources like cloud storage integrations (Google Drive, Dropbox, etc.).

List Ingestions

Returns all ingestions for the organization.

Authorizations:
Authorization

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

Ingestion ID

aasm_state
string

Ingestion state

source
string

Source of the ingestion

Response samples

Content type
application/json
[ ]

Invites

Invites allow organization administrators to invite new users to join their organization. Invites can specify role levels and user group memberships.

List Invites

Returns a paginated list of invites for the organization.

Authorizations:
Authorization
query Parameters
q
string

Search by email or role level

aasm_state
string
Enum: "pending" "accepted"

Filter by state

sortField
string
Enum: "email" "role_level" "created_at"

Sort field

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

Invite ID

email
string

Invitee email address

role_level
string

Assigned role level

aasm_state
string

Invite state

token
string

Unique invite token

user_group_ids
string

Assigned user group IDs

Response samples

Content type
application/json
[]

Create Invite

Create a new invite. Multiple email addresses can be provided separated by commas or semicolons.

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
invites
string

Array of created invites

Request samples

Content type
application/json
{
  • "invite": {
    }
}

Response samples

Content type
application/json
{
  • "invites": [
    ]
}

Invite Details

Get details of a specific invite.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{}

Update Invite

Update an existing invite before it's accepted.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "invite": {
    }
}

Response samples

Content type
application/json
{}

Delete Invite

Delete/revoke an invite.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Find Invite by Token

Find an invite by its unique token. Used during the accept flow.

Authorizations:
Authorization
query Parameters
token
required
string

Invite token

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 968520713,
  • "email": "[email protected]",
  • "note": null,
  • "created_at": "2026-05-28T20:05:05.625Z",
  • "updated_at": "2026-05-28T20:05:05.625Z",
  • "aasm_state": "pending",
  • "role_level": "general",
  • "role_level_name": "General",
  • "existing_user_id": null,
  • "join_link": "http://localhost:3000/casper-group/invites/beb05e5d37e9fb8e8bb373b8ddb69aec",
  • "user": {
    },
  • "user_email": "[email protected]",
  • "user_groups_count": 0,
  • "user_groups": [ ],
  • "user_group_ids": [ ],
  • "editable": true,
  • "token": "beb05e5d37e9fb8e8bb373b8ddb69aec",
  • "still_valid": true,
  • "organization": {
    }
}

Check Email Availability

Check if an email address is available for invitation (not already invited or a member).

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
email
required
string

Email address to check

Responses

Response Schema: application/json
ok
string

True if email is available

Response samples

Content type
application/json
{
  • "ok": true
}

Available Role Levels

Get the role levels that the current user can assign to invites.

Authorizations:
Authorization

Responses

Response Schema: application/json
role_levels
string

Array of assignable role levels

Response samples

Content type
application/json
[
  • "restricted",
  • "general",
  • "global_tagger",
  • "global_library",
  • "global_content",
  • "admin"
]

Resend Invite

Resend the invite notification email.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Lightboxes

Lightbox resources.

Lightboxes Index

Authorizations:
Authorization
query Parameters
user_id
integer

(Optional) User ID other than Current User. Only available to admins.

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Create Lightbox

Create a new lightbox for the current user.

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "lightbox": {
    }
}

Response samples

Content type
application/json
{
  • "name": "My New Lightbox",
  • "sub_type": null,
  • "description": null,
  • "created_at": "2026-05-28T20:06:13.543Z",
  • "organizer": false,
  • "type": "Lightbox",
  • "asset_group_id": 1073070604,
  • "has_workflow_steps": false,
  • "enable_contribution": false,
  • "project_id": null,
  • "commentable": true,
  • "comments_count": 0,
  • "commentable_id": 1073070604,
  • "sort_order": null,
  • "share_links_count": 0,
  • "sortable": true,
  • "folder_root_id": 1073070604,
  • "view_settings": null,
  • "always_create_lightroom_assets": false,
  • "last_lightroom_sync_at": null,
  • "reindexing_at": null,
  • "frame_project_id": null,
  • "frame_project_name": null,
  • "frame_team_id": null,
  • "frame_team_name": null,
  • "children_sort_order": null,
  • "organization_id": 1071574592,
  • "access_request_id": null,
  • "user": {
    },
  • "slug": "1073070604-my-new-lightbox",
  • "id": 1068742498,
  • "path_names": [
    ],
  • "path_slugs": [
    ],
  • "parent_id": null,
  • "ancestor_ids": [ ],
  • "visible_assets_count": null,
  • "archived": false,
  • "has_uploadable_descendants": false,
  • "editable": true,
  • "can_update_assets": true,
  • "has_children": false,
  • "contribution_id": false,
  • "lightbox_path_slugs": [
    ],
  • "workflow_steps": [ ],
  • "users": [
    ],
  • "links": [ ],
  • "webhooks": [ ]
}

Lightboxes Tree

For tree traversal. All children of the Parent folder specified by parent_id (or blank for root level) will be returned.

Authorizations:
Authorization
query Parameters
parent_id
integer

ID of parent Lightbox, blank for root level

sub_type
string
Value: "folder"

Set to folder when Parent is a Folder (aka "Bin")

Responses

Response Headers
total-entries
integer
Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Lightbox Details

Authorizations:
Authorization
query Parameters
id
integer

The ID of your membership to this Lightbox, or ID of a Folder.

sub_type
string
Value: "folder"

Set to folder when Lightbox ID is that of a Folder (aka "Bin")

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "name": "Pollock198",
  • "sub_type": null,
  • "description": "Similique aut quod. Temporibus sed porro. Doloremque tenetur dolore.",
  • "created_at": "2026-05-28T20:06:03.901Z",
  • "organizer": false,
  • "type": "Lightbox",
  • "asset_group_id": 1073070542,
  • "has_workflow_steps": false,
  • "enable_contribution": false,
  • "project_id": null,
  • "commentable": true,
  • "comments_count": 0,
  • "commentable_id": 1073070542,
  • "sort_order": null,
  • "share_links_count": 0,
  • "sortable": true,
  • "folder_root_id": 1073070542,
  • "view_settings": null,
  • "always_create_lightroom_assets": false,
  • "last_lightroom_sync_at": null,
  • "reindexing_at": null,
  • "frame_project_id": null,
  • "frame_project_name": null,
  • "frame_team_id": null,
  • "frame_team_name": null,
  • "children_sort_order": null,
  • "organization_id": 1071574590,
  • "access_request_id": null,
  • "user": {
    },
  • "slug": "1073070542-thirsty_corn198",
  • "id": 1068742466,
  • "path_names": [
    ],
  • "path_slugs": [
    ],
  • "parent_id": null,
  • "ancestor_ids": [ ],
  • "visible_assets_count": null,
  • "archived": false,
  • "has_uploadable_descendants": false,
  • "editable": true,
  • "can_update_assets": true,
  • "has_children": true,
  • "contribution_id": false,
  • "lightbox_path_slugs": [
    ],
  • "workflow_steps": [ ],
  • "users": [
    ],
  • "links": [ ],
  • "webhooks": [ ]
}

Update Lightbox

Update a lightbox name, description, or settings. The ID is the asset_group_membership ID for the current user.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "lightbox": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1068742514,
  • "name": "Updated Lightbox Name",
  • "sub_type": null,
  • "description": "Repellat ut soluta. Vero vitae voluptatibus. Et consectetur possimus.",
  • "created_at": "2026-05-28T20:06:18.365Z",
  • "organizer": false,
  • "type": "Lightbox",
  • "inherit_permissions": false,
  • "inherit_upload_ability": false,
  • "expires": false,
  • "expires_at": null,
  • "lock_on_expiration": false,
  • "remove_collaborators_on_expiration": false,
  • "image_and_video_permission": "small",
  • "other_permission": "none",
  • "watermark_all": false,
  • "allow_comments": true,
  • "allow_tagging": false,
  • "allow_edits": false,
  • "allow_invites": true,
  • "invite_link": null,
  • "require_auth": true,
  • "allow_uploads": false,
  • "upload_file_size_limit": null,
  • "enable_contribution": false,
  • "path_names": [
    ],
  • "asset_group_id": 1073070634,
  • "contribution_id": false,
  • "children_inherit_permissions": true,
  • "share_links_count": 0,
  • "override_permissions": false,
  • "frame_project_id": null,
  • "frame_project_name": null,
  • "frame_team_id": null,
  • "frame_team_name": null,
  • "sync_membership_to_all": true,
  • "sync_permissions_to_all": true,
  • "sync_upload_ability_to_all": true,
  • "inherit_project_members": false,
  • "user": {
    },
  • "slug": "1073070634-updated-lightbox-name",
  • "asset_group_memberships_attributes": [
    ],
  • "asset_group_invites_attributes": [ ],
  • "contribution_attributes": { },
  • "enable_toc": false,
  • "toc_copy": null,
  • "toc_contact": null,
  • "featured": false,
  • "enable_poster_image": true,
  • "poster_image": null
}

Delete Lightbox

Delete a lightbox. Assets in the lightbox are not deleted. The ID is the asset_group_membership ID for the current user. Only the owner can delete a lightbox.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Transfer Lightbox Ownership

Transfer ownership of a lightbox to another user. The new owner must already be a member of the lightbox.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/x-www-form-urlencoded
user_id
required
integer

New owner user ID (must be existing lightbox member)

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Memberships

Memberships resources. Admin role required.

Memberships Index

Authorizations:
Authorization

Responses

Response Headers
total-entries
integer
Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Membership Details

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1027394751,
  • "created_at": "2026-05-28T20:06:41.699Z",
  • "updated_at": "2026-05-28T20:06:41.699Z",
  • "aasm_state": "active",
  • "user_group_ids": [ ],
  • "user": {
    },
  • "role_level": "general",
  • "role_level_name": "General",
  • "initials": "F O",
  • "tester": false,
  • "username": "vicente",
  • "title": null,
  • "last_login_at": null,
  • "is_owner": false,
  • "otp_required_for_login": null,
  • "can_create_grants": false,
  • "can_use_cai": false,
  • "support": false,
  • "member_type": "normal",
  • "email": "[email protected]",
  • "name": "Franklyn Oberbrunner",
  • "avatar_url": null,
  • "user_groups_count": 0,
  • "user_groups": [ ],
  • "switchable": true
}

Update Membership

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "membership": {
    }
}

Response samples

Content type
application/json
{
  • "organization_id": 1071574598,
  • "id": 1027394757,
  • "user_id": 1015821140,
  • "invite_id": null,
  • "aasm_state": "active",
  • "created_at": "2026-05-28T20:06:46.949Z",
  • "updated_at": "2026-05-28T20:06:47.700Z",
  • "role_level": "global_library",
  • "username": "dorothea",
  • "title": null,
  • "last_login_at": null,
  • "box_token": null,
  • "box_token_set_at": null,
  • "single_use_token": null,
  • "box_user": null,
  • "grid_color": null,
  • "dropbox_token": null,
  • "dropbox_token_set_at": null,
  • "dropbox_user": null,
  • "google_drive_refresh_token": null,
  • "google_drive_access_token": null,
  • "google_drive_connected_at": null,
  • "google_drive_account": null,
  • "frame_token": null,
  • "frame_token_set_at": null,
  • "frame_account": null,
  • "lightroom_token": null,
  • "lightroom_token_set_at": null,
  • "lightroom_account": null,
  • "lightroom_catalog_id": null,
  • "created_via": null,
  • "rekognition_user_id": null,
  • "face_tag_id": null,
  • "notify_new_membership_requests": true,
  • "can_create_grants": false,
  • "can_use_cai": false,
  • "support": false,
  • "name": "Martin Grimes",
  • "initials": "M G",
  • "avatar_url": null,
  • "email": "[email protected]",
  • "user_group_ids": [ ]
}

Update Membership Status

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/x-www-form-urlencoded
status
string
Enum: "active" "deactivated"

Status

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "organization_id": 1071574599,
  • "id": 1027394763,
  • "user_id": 1015821150,
  • "invite_id": null,
  • "aasm_state": "deactivated",
  • "created_at": "2026-05-28T20:06:52.400Z",
  • "updated_at": "2026-05-28T20:06:53.074Z",
  • "role_level": "general",
  • "username": "jamika",
  • "title": null,
  • "last_login_at": null,
  • "box_token": null,
  • "box_token_set_at": null,
  • "single_use_token": null,
  • "box_user": null,
  • "grid_color": null,
  • "dropbox_token": null,
  • "dropbox_token_set_at": null,
  • "dropbox_user": null,
  • "google_drive_refresh_token": null,
  • "google_drive_access_token": null,
  • "google_drive_connected_at": null,
  • "google_drive_account": null,
  • "frame_token": null,
  • "frame_token_set_at": null,
  • "frame_account": null,
  • "lightroom_token": null,
  • "lightroom_token_set_at": null,
  • "lightroom_account": null,
  • "lightroom_catalog_id": null,
  • "created_via": null,
  • "rekognition_user_id": null,
  • "face_tag_id": null,
  • "notify_new_membership_requests": true,
  • "can_create_grants": false,
  • "can_use_cai": false,
  • "support": false,
  • "name": "Adela Ferry",
  • "initials": "A F",
  • "avatar_url": null,
  • "email": "[email protected]",
  • "user_group_ids": [ ]
}

Meta Downloads

Meta Downloads generate a CSV export of asset metadata. The download is processed in the background and progress is reported via WebSocket (metaDownloadProgress event on UserChannel). When complete, the CSV file can be downloaded via the GET /api/downloads/table_data endpoint using the S3 key. Optionally, the CSV can be emailed to the user when complete.

List Metadata Exports

Returns a paginated list of metadata CSV exports for the current organization. Supports sorting by created_at and total_assets, and filtering by date range and user.

Authorizations:
Authorization
query Parameters
sortField
string
Enum: "created_at" "total_assets"

Sort field

sortOrder
string
Enum: "ascend" "descend"

Sort order

dates
Array of strings

Date range filter (array of two ISO 8601 dates)

user_id
integer

Filter by user ID

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

Meta Download ID

guid
string

Unique identifier

created_at
string

Creation timestamp

aasm_state
string

Processing state: pending, processing, processed, errored

total_assets
string

Number of assets in the export

progress
string

Completion percentage (0-100)

s3_key
string

S3 object key for downloading the CSV via GET /api/downloads/table_data?key=

send_email
string

Whether the user requested email delivery

user
string

User who initiated the export

Response samples

Content type
application/json
[
  • {
    }
]

Request Metadata CSV Export

Creates a MetaDownload record and enqueues a background job to generate a CSV file containing the full indexed metadata for the specified assets.

Progress is reported via WebSocket at 5% intervals:

{ "type": "metaDownloadProgress", "guid": "...", "progress": 45 }

On completion:

{ "type": "metaDownloadProgress", "guid": "...", "progress": 100, "done": true, "key": "..." }

Use the key with GET /api/downloads/table_data?key= to download the file.

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
asset_ids
required
string

Comma-separated list of Asset IDs to include in the export

send_email
string

Set to 'true' to email the CSV to the requesting user when complete

column_preset
string
Enum: "basic" "all" "custom"

Column preset: 'basic' (common fields + custom meta), 'all' (everything), or 'custom' (specify columns)

columns
Array of strings

Array of column keys when column_preset is 'custom'

Responses

Response Schema: application/json
guid
string

Unique identifier for tracking progress via WebSocket

Response samples

Content type
application/json
{
  • "guid": "639aeb40-1db3-4825-a9ae-37c05c546379"
}

List Available Columns

Returns all available columns grouped by category, plus the basic column preset list.

Authorizations:
Authorization

Responses

Response Schema: application/json
columns
string

Array of column definitions with key, label, and group

basic
string

Array of column keys in the basic preset

Response samples

Content type
application/json
{
  • "columns": [
    ],
  • "basic": [
    ]
}

Update Metadata Export

Update the email preference on an in-progress metadata export.

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
id
required
string

Meta Download GUID

send_email
required
string

Set to 'true' to enable email delivery, 'false' to disable

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Meta Imports

Meta Imports allow bulk updating of asset metadata from CSV/Excel spreadsheets. Users can upload a spreadsheet, map columns to asset fields, and apply the metadata to matching assets.

List Meta Imports

Returns a paginated list of meta imports for the organization.

Authorizations:
Authorization
query Parameters
q
string

Search by note or filename

sortField
string
Enum: "created_at" "filename" "aasm_state"

Sort field

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

Meta Import ID

filename
string

Original filename

aasm_state
string

Processing state

rows
string

Number of rows in spreadsheet

matches
string

Number of matched assets

duplicates
string

Number of duplicate matches

Response samples

Content type
application/json
[
  • {
    }
]

Meta Import Details

Get details of a specific meta import including column mappings and match statistics.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
columns
string

Array of column configurations with mappings

match_column
string

Column used for matching assets

match_attribute
string

Asset attribute to match against (filename, guid, created_via_id)

unmatched_values
string

Values that didn't match any assets

Response samples

Content type
application/json
{
  • "id": 468021840,
  • "user": {
    },
  • "aasm_state": "analyzed",
  • "rows": 1,
  • "matches": 0,
  • "duplicates": 0,
  • "upload_id": null,
  • "asset_id": null,
  • "processed_at": null,
  • "create_unmatched_assets": false,
  • "created_at": "2026-05-28T20:08:11.021Z",
  • "updated_at": "2026-05-28T20:08:11.070Z",
  • "filename": "test_import.csv",
  • "match_column": "filename",
  • "match_attribute": "filename",
  • "partial_match": false,
  • "note": null,
  • "download_url": "http://example.com/test.csv",
  • "parse_error": null,
  • "unmatched_values_size": 0,
  • "columns": [
    ]
}

Update Meta Import

Update meta import settings like match column or partial matching options.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "meta_import": {
    }
}

Response samples

Content type
application/json
{
  • "id": 468021841,
  • "user": {
    },
  • "aasm_state": "analyzed",
  • "rows": 1,
  • "matches": 0,
  • "duplicates": 0,
  • "upload_id": null,
  • "asset_id": null,
  • "processed_at": null,
  • "create_unmatched_assets": false,
  • "created_at": "2026-05-28T20:08:15.747Z",
  • "updated_at": "2026-05-28T20:08:15.860Z",
  • "filename": "test_import.csv",
  • "match_column": "filename",
  • "match_attribute": "filename",
  • "partial_match": true,
  • "note": "Updated note",
  • "download_url": "http://example.com/test.csv",
  • "parse_error": null,
  • "unmatched_values_size": 0,
  • "columns": [
    ]
}

Delete Meta Import

Delete a meta import. Cannot delete imports that are currently processing or have been processed.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Update Column Mapping

Update the field mapping for a specific column in the meta import.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/x-www-form-urlencoded
column
required
object

Column mapping configuration

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 468021842,
  • "user": {
    },
  • "aasm_state": "analyzed",
  • "rows": 1,
  • "matches": 0,
  • "duplicates": 0,
  • "upload_id": null,
  • "asset_id": null,
  • "processed_at": null,
  • "create_unmatched_assets": false,
  • "created_at": "2026-05-28T20:08:20.561Z",
  • "updated_at": "2026-05-28T20:08:20.673Z",
  • "filename": "test_import.csv",
  • "match_column": "filename",
  • "match_attribute": "filename",
  • "partial_match": false,
  • "note": null,
  • "download_url": "http://example.com/test.csv",
  • "parse_error": null,
  • "unmatched_values_size": 0,
  • "columns": [
    ]
}

Start Processing

Start processing the meta import to apply metadata to matched assets. The import must be in 'analyzed' state.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Meta Import Assets

Get the list of assets that were updated by this meta import.

Authorizations:
Authorization
path Parameters
id
required
integer
query Parameters
sortField
string
Value: "filename"

Sort field

Responses

Response Headers
total-entries
integer
Response Schema: application/json
asset
string

Asset details

meta
string

Metadata that was applied from the spreadsheet row

Response samples

Content type
application/json
[ ]

Notifications

Notifications inform users about activity in their organization, such as comments, uploads, and workflow updates.

List Notifications

Returns all notifications for the current user in the organization.

Authorizations:
Authorization

Responses

Response Schema: application/json
id
string

Notification ID

seen_at
string

When the notification was marked as seen

created_at
string

When the notification was created

what
string

The notifiable object

Response samples

Content type
application/json
[ ]

Unseen Notification Count

Returns the count of unseen notifications for the current user.

Authorizations:
Authorization

Responses

Response Schema: application/json
unseen
string

Number of unseen notifications

Response samples

Content type
application/json
{
  • "unseen": 0
}

Organizations

Organization resources.

Find By Slug

Get details about the Organization and your Abilities (https://github.com/stalniy/casl) for it via its slug.

Authorizations:
Authorization
query Parameters
slug
string

The slug of the Organization

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "organization": {
    },
  • "abilities": [
    ]
}

Organization details.

Authorizations:
Authorization
query Parameters
id
integer
Example: id=1071574619

The ID of the Organization

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1071574619,
  • "title": "Block Group",
  • "domain": null,
  • "slug": "block-group",
  • "created_at": "2026-05-28T20:08:48.817Z",
  • "updated_at": "2026-05-28T20:08:52.752Z",
  • "logo_url": null,
  • "large_logo_url": null,
  • "watermark_url": null,
  • "last_login_at": null,
  • "public_headline": null,
  • "public_text": null,
  • "public_banner_asset_guids": [ ],
  • "login_background_asset_guid": null,
  • "current_role_level_name": null,
  • "lightbox_upload_role_level": "global_content",
  • "stripe_status": null,
  • "custom_pricing": false,
  • "watermark_format": "text",
  • "watermark_opacity": 0.75,
  • "watermark_scale": 1,
  • "watermark_advanced_params": null,
  • "enable_product_info": true,
  • "enable_artwork_or_object": true,
  • "enable_truncated_date_writing": false,
  • "enable_face_tagging": false,
  • "enable_membership_requests": true,
  • "enable_sso": false,
  • "sso_type": null,
  • "encrypt_saml": false,
  • "saml_email_attribute_name": "email",
  • "hide_password_login": false,
  • "stripe_product_code": "enterprise2",
  • "invoicing": false,
  • "minimum_usage": null,
  • "stripe_interval": "year",
  • "storage_tier": 0,
  • "cas_server_url": null,
  • "cas_login_url": null,
  • "sso_groups_field": null,
  • "use_path_for_sso": true,
  • "sso_token": "f7ec7b6b",
  • "plan_has_sso": true,
  • "plan_has_group_content_managers": true,
  • "plan_has_multiple_tag_trees": true,
  • "free": false,
  • "trial_ends_at": null,
  • "locked": false,
  • "view_settings": null,
  • "reindexing": false,
  • "reindexing_started_at": null,
  • "reindexing_eta": null,
  • "enable_ai": false,
  • "enable_rekognition": false,
  • "enable_general_member_auto_tags": false,
  • "auto_tag_confidence_threshold": 80,
  • "enable_nsfw_detection": false,
  • "omit_auto_tag_results": false,
  • "auto_tag_prompt": null,
  • "cai_enabled": false,
  • "default_timezone": null,
  • "download_filename_format": null,
  • "access_request_notification_emails": [],
  • "access_request_terms": null,
  • "contact_email": null,
  • "contact_address": null,
  • "contact_phone": null,
  • "company_name": null,
  • "overwrite_exif_date": false,
  • "include_taggers_in_admin": false,
  • "default_sort_order": "created_at-desc",
  • "default_landing_page": "explore",
  • "enable_transcription": true,
  • "share_download_role_level": "general",
  • "enable_face_training_mode": false,
  • "medium_download_size": 1200,
  • "sidebar_settings": [
    ],
  • "inactivity_timeout_minutes": 1440,
  • "alt_text_generation_prompt": null,
  • "alt_text_generation_mode": "on",
  • "rights_package_expiration_notify_days": 7,
  • "toc_default_enabled": true,
  • "toc_default_enable_poster_image": false,
  • "enable_help_menu_link": false,
  • "help_menu_link_text": null,
  • "help_menu_link_url": null,
  • "has_bedrock_credentials": false,
  • "member_grant_ids": [ ],
  • "member_cai_ids": [ ],
  • "user": {
    },
  • "default_asset_modal_layout": "vertical",
  • "is_owner": true,
  • "role_level": "admin",
  • "role_level_name": "Admin",
  • "user_group_names": [ ],
  • "can_use_cai": false,
  • "support": false,
  • "stripe_details": null,
  • "billing_email": null,
  • "stripe_coupon": null,
  • "stripe_customer_id": null,
  • "stripe_subscription_id": null,
  • "members_with_grant_permission": [ ],
  • "members_with_cai_permission": [ ],
  • "has_public_uploads": false,
  • "has_custom_meta_fields": true,
  • "enable_download_statement": false,
  • "header_background_color": "#000000",
  • "header_text_color": "#ffffff",
  • "header_highlight_color": "#1890ff",
  • "enable_access_requests": false,
  • "quick_info_settings": [
    ],
  • "sidebar_items": [
    ],
  • "banner_assets": [ ]
}

Join Organization as Support

Allows a user with the support capability flag (or a super admin) to create a Support membership in the given Organization. Idempotent — calling with an existing membership returns the existing record without creating a duplicate.

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
id
integer

The ID of the Organization

Responses

Response Schema: application/json
id
integer

The membership ID

role_level
string

Always 'admin' for support memberships

support
boolean

Always true for support memberships

Response samples

Content type
application/json
{
  • "id": 1027394887,
  • "user_id": 1015821385,
  • "organization_id": 1071574620,
  • "invite_id": null,
  • "aasm_state": "active",
  • "created_at": "2026-05-28T20:08:57.659Z",
  • "updated_at": "2026-05-28T20:08:57.659Z",
  • "role_level": "admin",
  • "username": "cyril",
  • "title": null,
  • "last_login_at": null,
  • "box_token": null,
  • "box_token_set_at": null,
  • "single_use_token": null,
  • "box_user": null,
  • "grid_color": null,
  • "dropbox_token": null,
  • "dropbox_token_set_at": null,
  • "dropbox_user": null,
  • "google_drive_refresh_token": null,
  • "google_drive_access_token": null,
  • "google_drive_connected_at": null,
  • "google_drive_account": null,
  • "frame_token": null,
  • "frame_token_set_at": null,
  • "frame_account": null,
  • "lightroom_token": null,
  • "lightroom_token_set_at": null,
  • "lightroom_account": null,
  • "lightroom_catalog_id": null,
  • "created_via": null,
  • "rekognition_user_id": null,
  • "face_tag_id": null,
  • "notify_new_membership_requests": false,
  • "can_create_grants": false,
  • "can_use_cai": false,
  • "support": true,
  • "name": "Cathi Yundt",
  • "initials": "C Y",
  • "avatar_url": null,
  • "email": "[email protected]",
  • "user_group_ids": [ ]
}

Permissions

Permissions define access levels for user groups to assets. They control what actions users can perform (view, download) and for which asset types (image, video, audio, other).

List Permissions

Returns a list of federation sharing permissions for the organization.

Authorizations:
Authorization

Responses

Response Schema: application/json
id
string

Permission ID

name
string

Permission name

enabled
string

Whether permission is active

image
string

Access level for images

video
string

Access level for videos

audio
string

Access level for audio

other
string

Access level for other files

watermark
string

Watermark setting

download
string

Download permission level

Response samples

Content type
application/json
[
  • {
    }
]

Create Permission

Create a new permission configuration.

Access Levels:

  • none - No access
  • view - View only
  • download_small - Download small size
  • download_large - Download large size
  • download_original - Download original
Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
id
string

Created Permission ID

Request samples

Content type
application/json
{
  • "permission": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1066712208,
  • "user_group_id": null,
  • "asset_group_id": null,
  • "user_id": null,
  • "name": "New Permission",
  • "image": "download_large",
  • "video": "view",
  • "audio": null,
  • "other": null,
  • "watermark": false,
  • "enabled": true,
  • "auto_permission": null,
  • "created_at": "2026-05-28T20:09:12.042Z",
  • "inherited": null,
  • "federated_organization_id": null
}

Permission Details

Get details of a specific permission.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1066712194,
  • "user_group_id": 1053904497,
  • "asset_group_id": null,
  • "user_id": 1015821403,
  • "name": "Jast, Ankunding and Maggio",
  • "image": "small",
  • "video": "small",
  • "audio": "listen",
  • "other": "view",
  • "watermark": false,
  • "enabled": true,
  • "auto_permission": null,
  • "created_at": "2026-05-28T20:09:07.560Z",
  • "inherited": null,
  • "federated_organization_id": null,
  • "user_group": {
    }
}

Update Permission

Update an existing permission configuration.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "permission": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1066712221,
  • "user_group_id": 1053904503,
  • "asset_group_id": null,
  • "user_id": 1015821421,
  • "name": "Updated Permission Name",
  • "image": "small",
  • "video": "small",
  • "audio": "listen",
  • "other": "view",
  • "watermark": false,
  • "enabled": true,
  • "auto_permission": null,
  • "created_at": "2026-05-28T20:09:16.723Z",
  • "inherited": null,
  • "federated_organization_id": null,
  • "user_group": {
    }
}

Delete Permission

Delete a permission. User groups using this permission will lose those access rights.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Personal Access Tokens

Personal Access Tokens allow users to authenticate API requests without using their session credentials. Tokens can be created for integrations like Lightroom.

Tokens can be revoked at staff discretion. Disabled tokens will fail authentication and the response will include X-PAT-Disabled: 1 and X-PAT-Disabled-Note headers indicating the reason.

List Personal Access Tokens

Returns all personal access tokens for the current user.

Authorizations:
Authorization

Responses

Response Schema: application/json
id
string

Token ID

name
string

Token name

last_used_at
string

Last usage timestamp

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create Personal Access Token

Create a new personal access token. The token value is only returned once upon creation.

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
token
string

The token value (only shown once)

Request samples

Content type
application/json
{
  • "personal_access_token": {
    }
}

Response samples

Content type
application/json
{
  • "id": 909709023,
  • "scopes": null,
  • "note": null,
  • "created_at": "2026-05-28T20:09:35.058Z",
  • "updated_at": "2026-05-28T20:09:35.058Z",
  • "last_used_at": null,
  • "source": null,
  • "organization": null,
  • "asset_group_id": null,
  • "membership_id": null,
  • "scope_list": [ ],
  • "token": "b1a3eed3da67b1cf4b6d593e948504d6"
}

Personal Access Token Details

Get details of a specific personal access token.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 909709020,
  • "scopes": null,
  • "note": null,
  • "created_at": "2026-05-28T20:09:30.452Z",
  • "updated_at": "2026-05-28T20:09:30.452Z",
  • "last_used_at": null,
  • "source": null,
  • "organization": null,
  • "asset_group_id": null,
  • "membership_id": null,
  • "scope_list": [ ]
}

Delete Personal Access Token

Revoke and delete a personal access token.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Rights Packages

Rights Packages define usage rights and licensing terms that can be assigned to assets. Each package has a rights class (e.g., Royalty Free, Rights Managed) and can include contracts.

List Rights Packages

Returns all rights packages for the organization.

Authorizations:
Authorization

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

Rights Package ID

rights_class
string

Rights classification

enabled
string

Whether package is active

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Create Rights Package

Create a new rights package for the organization.

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "rights_package": {
    }
}

Response samples

Content type
application/json
{
  • "id": 957291474,
  • "organization_id": 1071574632,
  • "user_id": 1015821493,
  • "name": "Editorial Use",
  • "description": null,
  • "rights_class": "editorial",
  • "summary": null,
  • "enabled": true,
  • "enable_long_form": false,
  • "long_form_url": null,
  • "long_form": null,
  • "replace_meta_field": false,
  • "meta_field_text": null,
  • "replace_empty_meta_field": false,
  • "reusable": true,
  • "allow_contract_upload": null,
  • "allow_model_release_upload": null,
  • "expires": false,
  • "expires_at": null,
  • "created_at": "2026-05-28T20:09:53.065Z",
  • "updated_at": "2026-05-28T20:09:53.065Z",
  • "watermark": false,
  • "personalize": false,
  • "other_party_name": null,
  • "long_form_type": null,
  • "prevent_download": false,
  • "external_contract_id": null,
  • "external_contract_location": null,
  • "contract_asset_id": null,
  • "default": false,
  • "block_level": 0,
  • "expiration_notification_sent_at": null
}

Rights Package Details

Get details of a specific rights package.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 957291464,
  • "name": null,
  • "rights_class": "owned",
  • "rights_class_name": "Owned by Organization",
  • "other_party_name": null,
  • "expires": false,
  • "expires_at": null,
  • "visible_assets_count": null,
  • "meta_field_text": null,
  • "summary": null,
  • "description": null,
  • "rights_class_description": "e.g. employee-created image done as part of job description, or commissioned work done under work for hire contract",
  • "enabled": true,
  • "enable_long_form": false,
  • "long_form_url": null,
  • "long_form": null,
  • "replace_meta_field": false,
  • "replace_empty_meta_field": false,
  • "reusable": true,
  • "allow_contract_upload": null,
  • "allow_model_release_upload": null,
  • "created_at": "2026-05-28T20:09:48.481Z",
  • "watermark": false,
  • "personalize": false,
  • "long_form_type": null,
  • "prevent_download": false,
  • "external_contract_id": null,
  • "external_contract_location": null,
  • "default": false,
  • "block_level": 0,
  • "user": {},
  • "editable": true
}

Update Rights Package

Update a rights package's settings.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "rights_package": {
    }
}

Response samples

Content type
application/json
{
  • "organization_id": 1071574633,
  • "enabled": false,
  • "id": 957291483,
  • "user_id": 1015821502,
  • "name": null,
  • "description": null,
  • "rights_class": "owned",
  • "summary": null,
  • "enable_long_form": false,
  • "long_form_url": null,
  • "long_form": null,
  • "replace_meta_field": false,
  • "meta_field_text": null,
  • "replace_empty_meta_field": false,
  • "reusable": true,
  • "allow_contract_upload": null,
  • "allow_model_release_upload": null,
  • "expires": false,
  • "expires_at": null,
  • "created_at": "2026-05-28T20:09:57.671Z",
  • "updated_at": "2026-05-28T20:09:57.681Z",
  • "watermark": false,
  • "personalize": false,
  • "other_party_name": null,
  • "long_form_type": null,
  • "prevent_download": false,
  • "external_contract_id": null,
  • "external_contract_location": null,
  • "contract_asset_id": null,
  • "default": false,
  • "block_level": 0,
  • "expiration_notification_sent_at": null
}

Delete Rights Package

Delete a rights package.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Bulk Find Rights Packages

Find multiple rights packages by their IDs at once.

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
ids
required
Array of integers

Array of rights package IDs

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    }
]

Search Queries

Search Queries allow users to save and reuse complex search filters. Saved searches can be quickly accessed and shared. The sql field uses Elasticsearch SQL syntax for the WHERE clause.

List Search Queries

Returns all saved search queries for the current user in the current organization.

Authorizations:
Authorization

Responses

Response Schema: application/json
id
string

Search Query ID

name
string

Search name

description
string

Search description

sql
string

SQL WHERE clause (Elasticsearch SQL syntax)

json_logic
string

JSON Logic representation of the query

user_id
string

Owner user ID

created_at
string

Creation timestamp

updated_at
string

Last update timestamp

Response samples

Content type
application/json
[
  • {
    }
]

Create Search Query

Save a new search query for future use. The sql field should contain an Elasticsearch SQL WHERE clause.

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "search_query": {
    }
}

Response samples

Content type
application/json
{
  • "id": 4,
  • "user_id": 1015821547,
  • "json_logic": null,
  • "name": "New Saved Search",
  • "description": "Find pending assets",
  • "sql": "aasm_state = 'pending'",
  • "created_at": "2026-05-28T20:10:20.616Z",
  • "updated_at": "2026-05-28T20:10:20.616Z"
}

Search Query Details

Get details of a specific saved search query.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 2,
  • "user_id": 1015821538,
  • "json_logic": null,
  • "name": "My Saved Search",
  • "description": "Find all processed images",
  • "sql": "aasm_state = 'processed'",
  • "created_at": "2026-05-28T20:10:16.023Z",
  • "updated_at": "2026-05-28T20:10:16.023Z"
}

Update Search Query

Update a saved search query's name or description. Note: The SQL query cannot be changed after creation.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "search_query": {
    }
}

Response samples

Content type
application/json
{
  • "id": 5,
  • "user_id": 1015821556,
  • "json_logic": null,
  • "name": "Updated Search Name",
  • "description": "Updated description",
  • "sql": "aasm_state = 'processed'",
  • "created_at": "2026-05-28T20:10:25.147Z",
  • "updated_at": "2026-05-28T20:10:25.167Z"
}

Delete Search Query

Delete a saved search query.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

List Share Links

Returns a paginated list of share links for the organization.

Authorizations:
Authorization
query Parameters
q
string

Search by asset group name or user email

dates
Array of strings

Filter by date range

image_and_video_permission
string

Filter by image/video permission level

other_permission
string

Filter by other file permission level

enabled
string
Enum: "true" "false"

Filter by enabled status

expired
string
Enum: "true" "false"

Filter by expired status

sortField
string
Enum: "created_at" "image_and_video_permission" "other_permission" "assets_count" "asset_views_count" "downloads_count"

Sort field

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

Share Link ID

code
string

Unique share link code

url
string

Public share link URL

enabled
string

Whether the share link is active

expires_at
string

Expiration date if set

image_and_video_permission
string

Permission level for images/videos

other_permission
string

Permission level for other file types

Response samples

Content type
application/json
[
  • {
    }
]

List Share Links for Asset Group

Returns share links for a specific Collection, Lightbox, or Storage Folder.

Authorizations:
Authorization
path Parameters
asset_group_id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    }
]

Create Share Link

Create a new share link for a Collection, Lightbox, or Storage Folder.

Permission Levels for Images/Videos:

  • view - View only (no download)
  • download_small - Allow small size downloads
  • download_large - Allow large size downloads
  • download_original - Allow original file downloads

Permission Levels for Other Files:

  • view - View only
  • download - Allow downloads
Authorizations:
Authorization
path Parameters
asset_group_id
required
integer

Responses

Response Schema: application/json
id
string

Created Share Link ID

code
string

Unique share link code

url
string

Public share link URL

Response samples

Content type
application/json
{
  • "id": 961852280,
  • "user_id": 1015821601,
  • "asset_group_id": 1073072275,
  • "enabled": true,
  • "code": "a4c32ffc2394b314",
  • "image_and_video_permission": "small",
  • "watermark_all": true,
  • "other_permission": "none",
  • "note": null,
  • "created_at": "2026-05-28T20:10:49.196Z",
  • "user": {
    },
  • "expires": false,
  • "expires_at": null,
  • "expired": false,
  • "downloads_count": null,
  • "asset_views_count": null,
  • "assets_count": null,
  • "url": "http://127.0.0.1:9887/cremin-llc/share-links/a4c32ffc2394b314"
}

Share Link Details

Get details of a specific share link.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
id
string

Share Link ID

code
string

Unique share link code

url
string

Public share link URL

enabled
string

Whether the share link is active

expires_at
string

Expiration date if set

expired
string

Whether the link has expired

image_and_video_permission
string

Permission for images/videos: view, download_small, download_large, download_original

other_permission
string

Permission for other files: view, download

watermark_all
string

Whether to watermark all downloads

note
string

Internal note

asset_group_id
string

Associated asset group ID

downloads_count
string

Number of times assets were downloaded

views_count
string

Number of times the link was viewed

Response samples

Content type
application/json
{
  • "id": 961852278,
  • "user_id": 1015821592,
  • "asset_group_id": 1073072245,
  • "enabled": true,
  • "code": "75f3f6bd10a103fa",
  • "image_and_video_permission": "small",
  • "watermark_all": true,
  • "other_permission": "none",
  • "note": null,
  • "created_at": "2026-05-28T20:10:44.252Z",
  • "user": {
    },
  • "expires": false,
  • "expires_at": null,
  • "expired": false,
  • "downloads_count": null,
  • "asset_views_count": null,
  • "assets_count": null,
  • "url": "http://127.0.0.1:9887/gerholdhoeger/share-links/75f3f6bd10a103fa",
  • "asset_group": {
    }
}

Update Share Link

Update an existing share link configuration.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "share_link": {
    }
}

Response samples

Content type
application/json
{
  • "id": 961852281,
  • "user_id": 1015821610,
  • "asset_group_id": 1073072305,
  • "enabled": false,
  • "code": "bfe68510ac1db3a6",
  • "image_and_video_permission": "small",
  • "watermark_all": true,
  • "other_permission": "none",
  • "note": "Updated note",
  • "created_at": "2026-05-28T20:10:54.192Z",
  • "user": {
    },
  • "expires": false,
  • "expires_at": null,
  • "expired": false,
  • "downloads_count": null,
  • "asset_views_count": null,
  • "assets_count": null,
  • "url": "http://127.0.0.1:9887/conroy-inc/share-links/bfe68510ac1db3a6",
  • "asset_group": {
    }
}

Delete Share Link

Permanently delete a share link.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Shares

Shares allow you to create public links to share assets or collections externally. Shares can be configured with different sizes, watermarks, and download permissions.

List Shares

Returns a paginated list of shares created in the organization.

Authorizations:
Authorization
query Parameters
q
string

Search by share name, asset filename, GUID, or user email

asset_id
integer

Filter by asset ID

asset_group_id
integer

Filter by asset group (Collection/Lightbox) ID

user_id
integer

Filter by user ID who created the share

sortField
string
Enum: "created_at" "aasm_state" "size" "watermarked" "assets_count"

Sort field

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

Share ID

code
string

Unique share code

name
string

Share name

url
string

Public share URL

enabled
string

Whether the share is active

enable_download
string

Whether download is enabled

size
string

Asset size for the share

watermarked
string

Whether assets are watermarked

assets_count
string

Number of assets in the share

Response samples

Content type
application/json
[
  • {
    }
]

Create Share

Create a new share with specified assets or from an asset group (Collection/Lightbox).

Size Options:

  • small - Small thumbnail
  • medium - Medium sized preview
  • full - Full resolution (no original metadata)
  • original - Original file with metadata
Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
id
string

Created Share ID

code
string

Unique share code

url
string

Public share URL

Request samples

Content type
application/json
{
  • "share": {
    }
}

Response samples

Content type
application/json
{
  • "id": 814948182,
  • "organization_id": 1071574648,
  • "user_id": 1015821640,
  • "asset_group_id": null,
  • "size": "full",
  • "watermarked": false,
  • "enabled": true,
  • "aasm_state": "pending",
  • "name": "My Share",
  • "note": null,
  • "code": "3796fabe951739a3",
  • "created_at": "2026-05-28T20:11:12.322Z",
  • "updated_at": "2026-05-28T20:11:12.322Z",
  • "gallery_type": null,
  • "crop_preset_id": null,
  • "message": null,
  • "enable_download": false,
  • "show_email": true,
  • "show_banner": true,
  • "direct_link": null
}

Update Share

Update an existing share configuration.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "share": {
    }
}

Response samples

Content type
application/json
{
  • "organization_id": 1071574649,
  • "id": 814948183,
  • "user_id": 1015821652,
  • "asset_group_id": null,
  • "size": "full",
  • "watermarked": false,
  • "enabled": false,
  • "aasm_state": "processed",
  • "name": "Updated Share Name",
  • "note": null,
  • "code": "85598f41dd436370",
  • "created_at": "2026-05-28T20:11:18.771Z",
  • "updated_at": "2026-05-28T20:11:18.784Z",
  • "gallery_type": null,
  • "crop_preset_id": null,
  • "message": null,
  • "enable_download": false,
  • "show_email": true,
  • "show_banner": true,
  • "direct_link": null
}

Delete Share

Permanently delete a share. The public URL will no longer work.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

StorageFolders

Storage Folders resources.

Storage Folders Index

Authorizations:
Authorization
query Parameters
publish_user_id
integer

Filter by Publish User ID; for Lightroom Publish Connections

publish_type
string
Value: "lightroom"

Filter by Publish Type

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Create Storage Folder

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "storage_folder": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1073072726,
  • "created_at": "2026-05-28T20:12:05.409Z",
  • "name": "Test Folder",
  • "description": null,
  • "slug": "test-folder",
  • "organizer": null,
  • "type": "StorageFolder",
  • "sub_type": null,
  • "has_children": false,
  • "path_names": [
    ],
  • "parent_id": 1073072725,
  • "ancestor_ids": [
    ],
  • "visible_assets_count": null,
  • "path_slugs": [
    ],
  • "asset_group_id": 1073072726,
  • "has_workflow_steps": false,
  • "contribution_id": 1025837805,
  • "enable_contribution": true,
  • "sort_order": null,
  • "box_folder_id": null,
  • "box_folder_name": null,
  • "publish_user_id": null,
  • "publish_user": null,
  • "publish_type": null,
  • "dropbox_folder_id": null,
  • "dropbox_folder_name": null,
  • "frame_project_id": null,
  • "frame_project_name": null,
  • "frame_team_id": null,
  • "frame_team_name": null,
  • "lightroom_publish_service_id": null,
  • "view_settings": null,
  • "last_lightroom_sync_at": null,
  • "created_via": null,
  • "created_via_id": null,
  • "reindexing_at": null,
  • "google_drive_folder_id": null,
  • "google_drive_folder_name": null,
  • "children_sort_order": null,
  • "user": {
    },
  • "editable": true,
  • "workflow_steps": [ ],
  • "block_destroy": false,
  • "total_file_size": 0,
  • "links": [ ],
  • "webhooks": [ ]
}

Storage Folders Tree

For tree traversal. All children of the Parent folder specified by parent_id (or blank for root level) will be returned.

Authorizations:
Authorization
query Parameters
parent_id
integer

ID of parent folder, blank for root level

updated_since
string

Timestamp filter for folders updated at or after this time. When parent_id is blank, returns matching folders across the whole tree.

Responses

Response Headers
total-entries
integer
Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Storage Folder Asset IDs

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • 1060943190,
  • 1060943191
]

Storage Folder Details

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1073072690,
  • "created_at": "2026-05-28T20:11:59.948Z",
  • "name": "Cassatt242",
  • "description": "Natus at perferendis. A provident doloremque. Aut et maxime.",
  • "slug": "wear-onion242",
  • "organizer": false,
  • "type": "StorageFolder",
  • "sub_type": null,
  • "has_children": false,
  • "path_names": [
    ],
  • "parent_id": null,
  • "ancestor_ids": [ ],
  • "visible_assets_count": null,
  • "path_slugs": [
    ],
  • "asset_group_id": 1073072690,
  • "has_workflow_steps": false,
  • "contribution_id": 1025837784,
  • "enable_contribution": true,
  • "sort_order": null,
  • "box_folder_id": null,
  • "box_folder_name": null,
  • "publish_user_id": null,
  • "publish_user": null,
  • "publish_type": null,
  • "dropbox_folder_id": null,
  • "dropbox_folder_name": null,
  • "frame_project_id": null,
  • "frame_project_name": null,
  • "frame_team_id": null,
  • "frame_team_name": null,
  • "lightroom_publish_service_id": null,
  • "view_settings": null,
  • "last_lightroom_sync_at": null,
  • "created_via": null,
  • "created_via_id": null,
  • "reindexing_at": null,
  • "google_drive_folder_id": null,
  • "google_drive_folder_name": null,
  • "children_sort_order": null,
  • "user": {
    },
  • "editable": true,
  • "workflow_steps": [ ],
  • "block_destroy": false,
  • "total_file_size": 0,
  • "links": [ ],
  • "webhooks": [ ]
}

Update Storage Folder

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "storage_folder": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1073072761,
  • "created_at": "2026-05-28T20:12:10.693Z",
  • "name": "Test Folder Edit",
  • "description": "Incidunt deserunt atque. Voluptas consectetur natus. Quibusdam consequatur quaerat.",
  • "slug": "test-folder-edit",
  • "organizer": false,
  • "type": "StorageFolder",
  • "sub_type": null,
  • "has_children": false,
  • "path_names": [
    ],
  • "parent_id": null,
  • "ancestor_ids": [ ],
  • "visible_assets_count": null,
  • "path_slugs": [
    ],
  • "asset_group_id": 1073072761,
  • "has_workflow_steps": false,
  • "contribution_id": 1025837825,
  • "enable_contribution": true,
  • "sort_order": null,
  • "box_folder_id": null,
  • "box_folder_name": null,
  • "publish_user_id": null,
  • "publish_user": null,
  • "publish_type": null,
  • "dropbox_folder_id": null,
  • "dropbox_folder_name": null,
  • "frame_project_id": null,
  • "frame_project_name": null,
  • "frame_team_id": null,
  • "frame_team_name": null,
  • "lightroom_publish_service_id": "lr-catalog-id",
  • "view_settings": null,
  • "last_lightroom_sync_at": null,
  • "created_via": null,
  • "created_via_id": null,
  • "reindexing_at": null,
  • "google_drive_folder_id": null,
  • "google_drive_folder_name": null,
  • "children_sort_order": null,
  • "user": {
    },
  • "editable": true,
  • "workflow_steps": [ ],
  • "block_destroy": false,
  • "total_file_size": 0,
  • "links": [ ],
  • "webhooks": [ ]
}

Delete Storage Folder

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Taggings

Taggings represent the association between tags and assets. They can also be associated with detected faces for person tagging.

Tagging Details

Get details of a specific tagging.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
id
string

Tagging ID

asset_id
string

Associated asset ID

tag_id
string

Associated tag ID

Response samples

Content type
application/json
{
  • "tagged_by": {
    },
  • "taxonomy_path_names": [ ]
}

Delete Tagging

Remove a tagging (untag an asset).

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Tags

Tag resources.

Tags Index

Authorizations:
Authorization
query Parameters
q
string

Search query

Responses

Response Headers
total-entries
integer
Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Create Tag

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "tag": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1070087257,
  • "list": "visible",
  • "name": "New Tag",
  • "created_at": "2026-05-28T20:12:46.312Z",
  • "sub_type": "keyword",
  • "user": {
    },
  • "in_taxonomy": false,
  • "taxonomy_path_names": [ ]
}

Tag Details

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "tag_id": 1070087255,
  • "id": 1070087255,
  • "list": "searchable",
  • "name": "jqpicgpyxe",
  • "description": null,
  • "created_at": "2026-05-28T20:12:41.311Z",
  • "in_taxonomy": false,
  • "taxonomy_path_names": [ ],
  • "visible_assets_count": null,
  • "sub_type": "keyword",
  • "date_start": null,
  • "date_end": null,
  • "location_country": null,
  • "location_country_code": null,
  • "location_state": null,
  • "location_city": null,
  • "location_name": null,
  • "related_tag_names": [ ],
  • "featured_organization_name": null,
  • "is_lead_tag": false,
  • "lead_tag_id": null,
  • "thumb_url": null,
  • "poster_image_guid": null,
  • "gtin": null,
  • "sku": null,
  • "artwork_creator": null,
  • "artwork_date_created": null,
  • "artwork_medium": null,
  • "artwork_style_period": null,
  • "artwork_source": null,
  • "artwork_inventory_number": null,
  • "artwork_copyright_notice": null,
  • "artwork_circa_date_created": null,
  • "artwork_content_description": null,
  • "artwork_contribution_description": null,
  • "artwork_creator_id": null,
  • "artwork_copyright_owner_id": null,
  • "artwork_licensor_id": null,
  • "artwork_licensor_name": null,
  • "artwork_physical_description": null,
  • "artwork_source_inventory_url": null,
  • "artwork_title": null,
  • "collection_management_system": null,
  • "cms_id": null,
  • "user": {
    },
  • "links": [ ],
  • "set_synonym_at": null,
  • "set_synonym_by_id": null
}

Update Tag

Accepts all parameters from Create endpoint.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "tag": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1070087258,
  • "name": "New Tag Edit",
  • "description": null,
  • "link": null,
  • "user_id": 1015821836,
  • "list": "searchable",
  • "content": null,
  • "created_at": "2026-05-28T20:12:51.098Z",
  • "updated_at": "2026-05-28T20:12:51.111Z",
  • "taxonomy_names": [ ],
  • "tag_id": 1070087258,
  • "visible_assets_count": null,
  • "sub_type": "keyword",
  • "date_start": null,
  • "date_end": null,
  • "location_country": null,
  • "location_country_code": null,
  • "location_state": null,
  • "location_city": null,
  • "location_name": null,
  • "related_tag_names": [ ],
  • "featured_organization_name": null,
  • "is_lead_tag": false,
  • "lead_tag_id": null,
  • "main_face_id": null,
  • "thumb_url": null,
  • "poster_image_guid": null,
  • "gtin": null,
  • "sku": null,
  • "artwork_creator": null,
  • "artwork_date_created": null,
  • "artwork_medium": null,
  • "artwork_style_period": null,
  • "artwork_source": null,
  • "artwork_inventory_number": null,
  • "artwork_copyright_notice": null,
  • "artwork_circa_date_created": null,
  • "artwork_content_description": null,
  • "artwork_contribution_description": null,
  • "artwork_creator_id": null,
  • "artwork_copyright_owner_id": null,
  • "artwork_licensor_id": null,
  • "artwork_licensor_name": null,
  • "artwork_physical_description": null,
  • "artwork_source_inventory_url": null,
  • "artwork_title": null,
  • "collection_management_system": null,
  • "cms_id": null,
  • "in_taxonomy": false,
  • "taggings_count": 0,
  • "editable": true,
  • "set_synonym_at": null,
  • "set_synonym_by_id": null
}

Delete tag

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Bulk Find Tags

Find multiple tags by their names at once.

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
names
required
Array of strings

Array of tag names to find

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[ ]

Tag Events

Get recent tag activity events for the organization.

Authorizations:
Authorization

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[ ]

Add Tag to Taxonomy

Add a tag to a taxonomy as a taxonomy tag.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/x-www-form-urlencoded
taxonomy_id
required
integer

Taxonomy ID to add tag to

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1070087262,
  • "list": "visible",
  • "name": "jsrjbrxmrd",
  • "created_at": "2026-05-28T20:13:10.489Z",
  • "sub_type": "keyword",
  • "user": {
    },
  • "in_taxonomy": true,
  • "taxonomy_path_names": [
    ]
}

Merge Tag Into Another

Merge this tag into another tag. All taggings will be moved to the target tag and this tag will be deleted.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/x-www-form-urlencoded
tag_2_id
required
integer

ID of the tag to merge into

set_synonym
boolean

Set source tag as synonym of target

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Taxonomies

Taxonomy resources.

Taxonomies Index

Authorizations:
Authorization

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Create Taxonomy

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "taxonomy": {
    }
}

Response samples

Content type
application/json
{
  • "id": 712306480,
  • "organization_id": 1071574672,
  • "name": "Main Taxonomy",
  • "description": null,
  • "user_id": 1015821912,
  • "created_at": "2026-05-28T20:13:31.512Z",
  • "updated_at": "2026-05-28T20:13:31.512Z",
  • "user": {
    },
  • "user_group_ids": [ ],
  • "taxonomy_tag_roots": [ ],
  • "editable": true,
  • "user_groups": [ ]
}

Taxonomy Details

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 712306477,
  • "organization_id": 1071574671,
  • "name": "non",
  • "description": null,
  • "user_id": 1015821911,
  • "created_at": "2026-05-28T20:13:26.465Z",
  • "updated_at": "2026-05-28T20:13:26.465Z",
  • "user": {
    },
  • "user_group_ids": [ ],
  • "taxonomy_tag_roots": [ ],
  • "editable": true,
  • "user_groups": [ ]
}

Update Taxonomy

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "taxonomy": {
    }
}

Response samples

Content type
application/json
{
  • "id": 712306482,
  • "organization_id": 1071574673,
  • "name": "Main Taxonomy Edit",
  • "description": null,
  • "user_id": 1015821931,
  • "created_at": "2026-05-28T20:13:36.575Z",
  • "updated_at": "2026-05-28T20:13:36.586Z",
  • "user": {
    },
  • "user_group_ids": [ ],
  • "taxonomy_tag_roots": [ ],
  • "editable": true,
  • "user_groups": [ ]
}

Delete Taxonomy

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

TaxonomyTags

Taxonomy Tag resources.

Taxonomy Tags Index

Authorizations:
Authorization
query Parameters
taxonomy_id
required
integer

Taxonomy ID

q
string

Search query

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create Taxonomy Tag

Authorizations:
Authorization
Request Body schema: application/json
taxonomy_id
required
integer

Taxonomy ID

object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "taxonomy_id": 0,
  • "taxonomy_tags": {
    }
}

Response samples

Content type
application/json
{
  • "id": 869964647,
  • "organization_id": 1071574678,
  • "created_at": "2026-05-28T20:14:05.254Z",
  • "has_children": false,
  • "ancestor_ids": [
    ],
  • "parent_id": 869964646,
  • "name": "Test Tag",
  • "path_names": [
    ],
  • "description": null,
  • "link": null,
  • "user": {
    },
  • "visible_assets_count": null,
  • "organizer": false,
  • "date_start": null,
  • "date_end": null,
  • "location_country": null,
  • "location_state": null,
  • "location_city": null,
  • "location_name": null,
  • "featured_organization_name": null,
  • "related_tag_names": [ ],
  • "is_lead_tag": false,
  • "lead_tag_id": null,
  • "gtin": null,
  • "sku": null,
  • "sub_type": "keyword",
  • "artwork_creator": null,
  • "artwork_date_created": null,
  • "artwork_medium": null,
  • "artwork_style_period": null,
  • "artwork_source": null,
  • "artwork_inventory_number": null,
  • "artwork_copyright_notice": null,
  • "poster_image_guid": null,
  • "thumb_url": null,
  • "slug": "Test Tag (#869964647)",
  • "tag": {
    }
}

Taxonomy Tags Tree

For tree traversal. All children of the Parent Taxonomy Tag specified by parent_id (or blank for root level) will be returned.

Authorizations:
Authorization
query Parameters
taxonomy_id
required
integer

Taxonomy ID

parent_id
integer

ID of parent Taxonomy Tag, blank for root level

Responses

Response Headers
total-entries
integer
Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Taxonomy Tag Details

Authorizations:
Authorization
path Parameters
id
required
integer
query Parameters
taxonomy_id
required
integer

Taxonomy ID

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 869964645,
  • "organization_id": 1071574677,
  • "created_at": "2026-05-28T20:13:58.981Z",
  • "has_children": false,
  • "ancestor_ids": [ ],
  • "parent_id": null,
  • "name": "ylvaxugwwd",
  • "path_names": [
    ],
  • "description": null,
  • "link": null,
  • "user": {
    },
  • "visible_assets_count": null,
  • "organizer": false,
  • "date_start": null,
  • "date_end": null,
  • "location_country": null,
  • "location_state": null,
  • "location_city": null,
  • "location_name": null,
  • "featured_organization_name": null,
  • "related_tag_names": [ ],
  • "is_lead_tag": false,
  • "lead_tag_id": null,
  • "gtin": null,
  • "sku": null,
  • "sub_type": "keyword",
  • "artwork_creator": null,
  • "artwork_date_created": null,
  • "artwork_medium": null,
  • "artwork_style_period": null,
  • "artwork_source": null,
  • "artwork_inventory_number": null,
  • "artwork_copyright_notice": null,
  • "poster_image_guid": null,
  • "thumb_url": null,
  • "slug": "ylvaxugwwd (#869964645)",
  • "tag": {
    }
}

Update Taxonomy Tag

Accepts all parameters from Create endpoint.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
taxonomy_id
required
integer

Taxonomy ID

object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "taxonomy_id": 0,
  • "taxonomy_tags": {
    }
}

Response samples

Content type
application/json
{
  • "id": 869964648,
  • "organization_id": 1071574679,
  • "created_at": "2026-05-28T20:14:09.913Z",
  • "has_children": false,
  • "ancestor_ids": [ ],
  • "parent_id": null,
  • "name": "Test Tag Edit",
  • "path_names": [
    ],
  • "description": null,
  • "link": null,
  • "user": {
    },
  • "visible_assets_count": null,
  • "organizer": false,
  • "date_start": null,
  • "date_end": null,
  • "location_country": null,
  • "location_state": null,
  • "location_city": null,
  • "location_name": null,
  • "featured_organization_name": null,
  • "related_tag_names": [ ],
  • "is_lead_tag": false,
  • "lead_tag_id": null,
  • "gtin": null,
  • "sku": null,
  • "sub_type": "keyword",
  • "artwork_creator": null,
  • "artwork_date_created": null,
  • "artwork_medium": null,
  • "artwork_style_period": null,
  • "artwork_source": null,
  • "artwork_inventory_number": null,
  • "artwork_copyright_notice": null,
  • "poster_image_guid": null,
  • "thumb_url": null,
  • "slug": "Test Tag Edit (#869964648)",
  • "tag": {
    }
}

Delete Taxonomy Tag

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/x-www-form-urlencoded
taxonomy_id
required
integer

Taxonomy ID

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Uploads

Uploading Assets.

Create Upload Session From Contribution

Create the Upload container within the Contribution that will receive the uploaded Assets.

Authorizations:
Authorization
Request Body schema: application/json
object
contribution_id
integer

Contribution ID these uploaded Assets will go into.

Responses

Response Schema: application/json
guid
string

The Upload GUID to be used when uploading Assets

Request samples

Content type
application/json
{
  • "upload": {
    },
  • "contribution_id": 0
}

Response samples

Content type
application/json
{
  • "id": 903046260,
  • "user_id": 1015822018,
  • "guid": "9fd3b728",
  • "name": "Test Upload",
  • "note": "API docs upload test",
  • "aasm_state": null,
  • "created_at": "2026-05-28T20:14:20.396Z",
  • "updated_at": "2026-05-28T20:14:20.396Z",
  • "current_assets_count": 0,
  • "assets_count": 0,
  • "tag_names": [ ],
  • "default_rights_package_id": null,
  • "done": false,
  • "done_at": null,
  • "standalone": true,
  • "contribution_id": 1025838234,
  • "agreed_at": null,
  • "creator": null,
  • "other_creator": null,
  • "upload_state": "active",
  • "paused_at": null,
  • "stalled_at": null,
  • "stalled_reason": null,
  • "cancelled_at": null,
  • "total_assets": 0,
  • "user": {
    },
  • "aws_key": "AKIATBO5XF4ER7OYZDV6",
  • "bucket": "tandemvault-asset-uploads-test",
  • "contribution": {
    },
  • "ftp_username": "[email protected]",
  • "ftp_password": "bb15c5a8",
  • "ftp_url": "sftp://bradford.labadie%40steuber-daugherty.example:bb15c5a8@//1071574681/7d42efe2"
}

Prepare Asset Upload

Prepare the Asset to be uploaded to S3. Use the signed_upload_url response attribute to then upload via PUT. E.g: curl -v --upload-file path/to/file.jpg "{signed_upload_url}". Then use the /set_uploaded endpoint once the data upload to S3 is complete. Note that the signed_upload_url is only valid for 1 hour.

Authorizations:
Authorization
path Parameters
guid
required
string

Upload GUID created in the prior step.

Request Body schema: application/json
object

Responses

Response Schema: application/json
signed_upload_url
string

Use this URL to PUT the file data on S3.

Request samples

Content type
application/json
{
  • "asset": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1060943194,
  • "filename": "test.jpg",
  • "file_size": 10000,
  • "guid": "577f990e-8b29-4524-a46e-e16f2cef62cf",
  • "short_guid": "577f990e",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "source_url": null,
  • "thumb_url": null,
  • "grid_url": null,
  • "small_url": null,
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "expired": null,
  • "expires_at": null,
  • "release": false,
  • "contract": false,
  • "released": false,
  • "has_people": null,
  • "headline": null,
  • "title": null,
  • "credit_line": null,
  • "event": null,
  • "city": null,
  • "state": null,
  • "country": null,
  • "sublocation": null,
  • "featured_organization_name": null,
  • "usage_terms": null,
  • "content_preview": null,
  • "has_transcript": false,
  • "transcription_job_status": null,
  • "creator": [ ],
  • "vote": null,
  • "nsfw_detected": false,
  • "data_version_number": 1,
  • "preview_type": "Image",
  • "downloadable_previews": false,
  • "block_level": 0,
  • "rights_package_block_level": null,
  • "max_block_level": 0,
  • "textract_retrieved_at": null,
  • "submitted": false,
  • "preview_image_url": null,
  • "checked_out_at": null,
  • "frame_asset_id": null,
  • "frame_status": null,
  • "alt_text": null,
  • "organization_id": 1071574682,
  • "has_alpha": false,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "has_document_url": false,
  • "has_pdf_url": false,
  • "rating": null,
  • "path": "",
  • "catalogue_number": null,
  • "upload_finished_at": null,
  • "upload_started_at": null,
  • "processing_started_at": null,
  • "upload_id": 903046261,
  • "user_id": 1015822028,
  • "aasm_state": "pending",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2026-05-28T20:14:25.446Z",
  • "updated_at": "2026-05-28T20:14:25.537Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "1071574682/bf2ec5a9/577f990e-8b29-4524-a46e-e16f2cef62cf-test.jpg",
  • "time_to_process": null,
  • "captured_at": null,
  • "captured_at_truncation": null,
  • "captured_at_offset": null,
  • "notes": null,
  • "created_via": "api",
  • "created_via_id": "external-file-id",
  • "vector": false,
  • "rights_package_id": null,
  • "submitted_at": null,
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": null,
  • "auto_tags_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "pending",
  • "faces_searched_at": null,
  • "bedrock_retrieved_at": null,
  • "custom_meta_values": [ ],
  • "user": {
    },
  • "creator_tag": null,
  • "storage_folder_path": "figure_widen249",
  • "tags": [ ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": null,
  • "preserved_filename": null,
  • "description_writer": null,
  • "country_code": null,
  • "iptc_event_id": null,
  • "organization_in_image_name": null,
  • "extended_description": null,
  • "iptc_job_id": null,
  • "intellectual_genre": null,
  • "scene": null,
  • "subject_code": null,
  • "instructions": null,
  • "iptc_rights": null,
  • "web_statement": null,
  • "model_release_status": null,
  • "property_release_status": null,
  • "authors_position": null,
  • "iptc_source": null,
  • "copyright_owner": null,
  • "iptc_dig_image_guid": null,
  • "image_supplier": null,
  • "iptc_image_supplier_image_id": null,
  • "licensor": null,
  • "addl_model_info": null,
  • "iptc_model_release_id": null,
  • "model_age": null,
  • "minor_model_age_disclosure": null,
  • "iptc_property_release_id": null,
  • "has_published_images": false,
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "bedrock_prompt": null,
  • "bedrock_data": null,
  • "downloads_count": 0,
  • "views_count": 0,
  • "up_votes_count": 0,
  • "down_votes_count": 0,
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": null,
  • "full_url": null,
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "upload": {
    },
  • "signed_upload_url": "https://tandemvault-asset-uploads-test.s3.amazonaws.com/1071574682/bf2ec5a9/577f990e-8b29-4524-a46e-e16f2cef62cf-test.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATBO5XF4ER7OYZDV6%2F20260528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260528T201425Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=329f36b4a4792cd54f992a2708d1163412659766433962596afea260cfde1548",
  • "collective_work_ids": [ ]
}

Set Upload Session Done

(Optional) Call once all Assets have been uploaded. Will submit each Asset in background.

Authorizations:
Authorization
path Parameters
id
required
integer

The Upload ID

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 903046262,
  • "assets_count": 0,
  • "unsubmitted_assets_count": 0,
  • "all_requirements_met": true,
  • "done": false,
  • "done_at": null,
  • "tag_suggesters_met": true,
  • "unmet_tag_suggester_ids": [ ],
  • "rights_packages_met": true,
  • "creator_tags_met": true
}

Create Upload Session Without Contribution

Create an Upload container in the default Storage Folder; only to be used when a Contribution is not available.

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
guid
string

The Upload GUID to be used when uploading Assets

Request samples

Content type
application/json
{
  • "upload": {
    }
}

Response samples

Content type
application/json
{
  • "id": 903046263,
  • "user_id": 1015822051,
  • "guid": "6a51af01",
  • "name": "Test Upload",
  • "note": "API docs upload test",
  • "aasm_state": null,
  • "created_at": "2026-05-28T20:14:35.483Z",
  • "updated_at": "2026-05-28T20:14:35.483Z",
  • "current_assets_count": 0,
  • "assets_count": 0,
  • "tag_names": [ ],
  • "default_rights_package_id": null,
  • "done": false,
  • "done_at": null,
  • "standalone": false,
  • "contribution_id": 1025838277,
  • "agreed_at": null,
  • "creator": null,
  • "other_creator": null,
  • "upload_state": "active",
  • "paused_at": null,
  • "stalled_at": null,
  • "stalled_reason": null,
  • "cancelled_at": null,
  • "total_assets": 0,
  • "user": {
    },
  • "aws_key": "AKIATBO5XF4ER7OYZDV6",
  • "bucket": "tandemvault-asset-uploads-test",
  • "contribution": {
    },
  • "ftp_username": "[email protected]",
  • "ftp_password": "ea72ff49",
  • "ftp_url": "sftp://cari%40fadel.example:ea72ff49@//1071574684/48b820ec"
}

User Groups

User Groups allow organizations to organize members into groups with shared permissions. Groups can have associated collections, storage folders, and contribution settings.

List User Groups

Returns a paginated list of user groups for the organization.

Authorizations:
Authorization
query Parameters
q
string

Search by name or invite domain

aasm_state
string

Filter by state

assignable
boolean

Only return assignable groups (no auto groups)

omit_public
boolean

Exclude public group

sortField
string
Enum: "name" "created_at" "members_count"

Sort field

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

User Group ID

name
string

Group name

description
string

Group description

is_open
string

Whether anyone can join

auto_group
string

Auto group type if system-generated

members_count
string

Number of members

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Create User Group

Create a new user group with specified settings and permissions.

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
id
string

Created User Group ID

Request samples

Content type
application/json
{
  • "user_group": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1053904634,
  • "name": "New Group",
  • "description": "A test group",
  • "is_open": false,
  • "invite_emails": null,
  • "invite_note": null,
  • "invite_domain": null,
  • "enable_home_collection": false,
  • "collection_id": null,
  • "storage_folder_id": null,
  • "enable_storage_folder_content_admin": false,
  • "enable_storage_folder": false,
  • "sandbox_collection_id": null,
  • "enable_sandbox_collection": false,
  • "sandbox_collection_admin_role_level": null,
  • "sandbox_collection_children_inherit": true,
  • "auto_add_approved_to_sandbox": false,
  • "auto_approve": false,
  • "require_rights_package": false,
  • "enable_contract_uploads": false,
  • "aasm_state": "active",
  • "created_at": "2026-05-28T20:14:49.595Z",
  • "updated_at": "2026-05-28T20:14:49.595Z",
  • "enable_contribution": false,
  • "contribution_id": null,
  • "auto_group": null,
  • "enable_content_managers": false,
  • "enable_library_managers": false,
  • "enable_taggers": false,
  • "home_collection_admin_role_level": null,
  • "home_collection_children_inherit": true,
  • "memberships_count": 0,
  • "permissions": [ ],
  • "sso_name": [ ],
  • "destroyable": true,
  • "user": {
    },
  • "permissions_attributes": [ ],
  • "home_collection_permission_ids": [ ],
  • "membership_ids": [ ],
  • "content_manager_ids": [ ],
  • "library_manager_ids": [ ],
  • "tagger_ids": [ ],
  • "invites_attributes": [ ]
}

User Group Details

Get details of a specific user group including permissions and settings.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
id
string

User Group ID

name
string

Group name

description
string

Group description

is_open
string

Whether open for joining

enable_contribution
string

Whether group has upload form

enable_home_collection
string

Whether home collection is enabled

collection_id
string

Home collection ID

enable_storage_folder
string

Whether storage folder access is enabled

storage_folder_id
string

Associated storage folder ID

permissions
string

Array of permissions

memberships
string

Array of group members

Response samples

Content type
application/json
{
  • "id": 1053904630,
  • "name": "Law Practice",
  • "description": null,
  • "is_open": false,
  • "invite_emails": null,
  • "invite_note": null,
  • "invite_domain": null,
  • "enable_home_collection": false,
  • "collection_id": null,
  • "storage_folder_id": 1073073652,
  • "enable_storage_folder_content_admin": false,
  • "enable_storage_folder": true,
  • "sandbox_collection_id": null,
  • "enable_sandbox_collection": false,
  • "sandbox_collection_admin_role_level": null,
  • "sandbox_collection_children_inherit": true,
  • "auto_add_approved_to_sandbox": false,
  • "auto_approve": false,
  • "require_rights_package": false,
  • "enable_contract_uploads": false,
  • "aasm_state": "active",
  • "created_at": "2026-05-28T20:14:45.259Z",
  • "updated_at": "2026-05-28T20:14:45.259Z",
  • "enable_contribution": false,
  • "contribution_id": null,
  • "auto_group": null,
  • "enable_content_managers": false,
  • "enable_library_managers": false,
  • "enable_taggers": false,
  • "home_collection_admin_role_level": null,
  • "home_collection_children_inherit": true,
  • "memberships_count": 0,
  • "permissions": [ ],
  • "sso_name": [ ],
  • "destroyable": true,
  • "user": {
    },
  • "storage_folder": {
    },
  • "group_memberships": [ ]
}

Update User Group

Update an existing user group configuration.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "user_group": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1053904637,
  • "name": "Updated Group Name",
  • "description": "Updated description",
  • "is_open": false,
  • "invite_emails": null,
  • "invite_note": null,
  • "invite_domain": null,
  • "enable_home_collection": false,
  • "collection_id": null,
  • "storage_folder_id": 1073073714,
  • "enable_storage_folder_content_admin": false,
  • "enable_storage_folder": true,
  • "sandbox_collection_id": null,
  • "enable_sandbox_collection": false,
  • "sandbox_collection_admin_role_level": null,
  • "sandbox_collection_children_inherit": true,
  • "auto_add_approved_to_sandbox": false,
  • "auto_approve": false,
  • "require_rights_package": false,
  • "enable_contract_uploads": false,
  • "aasm_state": "active",
  • "created_at": "2026-05-28T20:14:53.817Z",
  • "updated_at": "2026-05-28T20:14:53.844Z",
  • "enable_contribution": false,
  • "contribution_id": null,
  • "auto_group": null,
  • "enable_content_managers": false,
  • "enable_library_managers": false,
  • "enable_taggers": false,
  • "home_collection_admin_role_level": null,
  • "home_collection_children_inherit": true,
  • "memberships_count": 0,
  • "permissions": [ ],
  • "sso_name": [ ],
  • "destroyable": true,
  • "user": {
    },
  • "storage_folder": {
    },
  • "permissions_attributes": [ ],
  • "home_collection_permission_ids": [ ],
  • "membership_ids": [ ],
  • "content_manager_ids": [ ],
  • "library_manager_ids": [ ],
  • "tagger_ids": [ ],
  • "invites_attributes": [ ]
}

Delete User Group

Delete a user group. Members are not deleted but lose group-based permissions.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Current User

Who Am I

Get your User details from your Personal Access Token or OAuth Access Token.

Authorizations:
Authorization

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1015822105,
  • "first_name": "Alex",
  • "last_name": "McDermott",
  • "email": "[email protected]",
  • "created_at": "2026-05-28T20:14:57.925Z",
  • "can_create_orgs": false,
  • "confirmed_at": "2026-05-28T20:14:57.924Z",
  • "default_username": "tashia",
  • "otp_required_for_login": null,
  • "timezone": null,
  • "guest": null,
  • "guest_email": null,
  • "lang": null,
  • "enable_lightroom": true,
  • "support": false,
  • "avatar_url": null,
  • "name": "Alex McDermott",
  • "initials": "A M",
  • "user_group_ids": [ ],
  • "last_organization": null,
  • "title": null,
  • "user_id": 1015822105,
  • "oauth_token": null,
  • "membership": null,
  • "organization": null
}

Can I Upload?

Check if the User is able to upload assets and create Storage Folders.

Authorizations:
Authorization

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "can_upload": true,
  • "can_create_storage_folders": true,
  • "can_view_storage_folders": true
}

Webhooks

Webhooks allow you to receive real-time HTTP notifications when events occur in Mediagraph, such as asset uploads, metadata changes, or collection updates.

List Webhooks

Returns a paginated list of webhooks configured for the organization.

Authorizations:
Authorization
query Parameters
q
string

Search by webhook name, URL, or asset group name

enabled
Array of strings

Filter by enabled status

sortField
string
Enum: "created_at" "name" "url"

Sort field

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

Webhook ID

name
string

Webhook name

url
string

Destination URL

enabled
string

Whether the webhook is active

events
string

Events that trigger this webhook

Response samples

Content type
application/json
[
  • {
    }
]

Create Webhook

Create a new webhook to receive event notifications.

Available Events:

  • asset.created - Asset uploaded
  • asset.updated - Asset metadata changed
  • asset.deleted - Asset moved to trash
  • asset.restored - Asset restored from trash
  • collection.updated - Collection modified
Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
id
string

Created Webhook ID

Request samples

Content type
application/json
{
  • "webhook": {
    }
}

Response samples

Content type
application/json
{
  • "id": 955336216,
  • "organization_id": 1071574694,
  • "user_id": 1015822143,
  • "name": "My Integration Webhook",
  • "note": null,
  • "asset_group_id": 1073073908,
  • "events": "asset.created,asset.updated",
  • "url": "https://example.com/webhook",
  • "include_download_url": false,
  • "created_at": "2026-05-28T20:15:20.829Z",
  • "updated_at": "2026-05-28T20:15:20.829Z",
  • "enabled": true,
  • "group_assets": true,
  • "trash": false
}

Webhook Details

Get details of a specific webhook.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
id
string

Webhook ID

name
string

Webhook name

url
string

Destination URL

enabled
string

Whether the webhook is active

events
string

Events that trigger this webhook

asset_group_id
string

Asset group ID if scoped to a specific collection/folder

include_download_url
string

Whether to include download URL in payload

group_assets
string

Whether to group assets in batch notifications

note
string

Internal notes

Response samples

Content type
application/json
{
  • "id": 955336214,
  • "user": {
    },
  • "name": "Faker::Appliance",
  • "note": null,
  • "asset_group_id": 1073073873,
  • "events": null,
  • "url": "https://example.com/webhook",
  • "include_download_url": false,
  • "enabled": true,
  • "created_at": "2026-05-28T20:15:16.123Z",
  • "updated_at": "2026-05-28T20:15:16.123Z",
  • "asset_group_type": "StorageFolder",
  • "asset_group_slug": "1073073873",
  • "asset_group_path_names": [
    ],
  • "requests_count": 0,
  • "group_assets": true,
  • "trash": false,
  • "asset_group": {
    }
}

Update Webhook

Update an existing webhook configuration.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "webhook": {
    }
}

Response samples

Content type
application/json
{
  • "organization_id": 1071574696,
  • "enabled": false,
  • "name": "Updated Webhook Name",
  • "id": 955336219,
  • "user_id": 1015822163,
  • "note": null,
  • "asset_group_id": 1073073978,
  • "events": null,
  • "url": "https://example.com/webhook",
  • "include_download_url": false,
  • "created_at": "2026-05-28T20:15:30.249Z",
  • "updated_at": "2026-05-28T20:15:30.258Z",
  • "group_assets": true,
  • "trash": false
}

Delete Webhook

Permanently delete a webhook.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Test Webhook URL

Send a test POST request to verify webhook URL is reachable. Returns success if the URL responds with a 2xx status code.

Authorizations:
Authorization
Request Body schema: application/x-www-form-urlencoded
url
required
string

URL to test

Responses

Response Schema: application/json
message
string

Success message if URL is reachable

error
string

Error message if URL is not reachable

Response samples

Content type
application/json
{
  • "message": "Success"
}

Webhook Request Logs

Returns a paginated list of webhook request logs showing delivery history.

Authorizations:
Authorization
path Parameters
id
required
integer
query Parameters
sortField
string
Enum: "created_at" "status"

Sort field

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

Request log ID

status
string

HTTP response status

created_at
string

Request timestamp

Response samples

Content type
application/json
[ ]

Webhook Request Payload

Get the JSON payload that was sent for a specific webhook request.

Authorizations:
Authorization
query Parameters
webhook_request_id
required
integer

Webhook Request ID

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "test": "data"
}

Webhook Response Data

Get the response received from the webhook endpoint for a specific request.

Authorizations:
Authorization
query Parameters
webhook_request_id
required
integer

Webhook Request ID

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "received": true
}

Workflow Steps

Workflow Steps are individual stages within a workflow. Each step can have assigned reviewers and approval requirements.

List Workflow Steps

Returns all workflow steps for the organization.

Authorizations:
Authorization

Responses

Response Schema: application/json
id
string

Workflow Step ID

name
string

Step name

workflow_id
string

Parent workflow ID

Response samples

Content type
application/json
[
  • {
    }
]

Workflow Step Details

Get details of a specific workflow step.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 975327008,
  • "name": "sapiente",
  • "description": null,
  • "aasm_state": "active",
  • "position": 1,
  • "asset_group_id": 1073074213,
  • "auto_approval": true,
  • "manual_approval_type": null,
  • "approval_user_id": null,
  • "created_at": "2026-05-28T20:16:02.613Z",
  • "approval_user": null,
  • "send_to_lightroom": false,
  • "lightroom_user": null,
  • "approve_on_frame": false,
  • "set_in_progress_on_frame": false,
  • "workflow_id": 1014085961,
  • "lightroom_user_id": null,
  • "enable_descendants": true,
  • "preserve_subfolders": true,
  • "editable": true,
  • "asset_group": {
    },
  • "workflow": {
    },
  • "approvals": [ ],
  • "approved_count": 0,
  • "pending_count": 0,
  • "rejected_count": 0,
  • "picked_count": 0
}

Update Workflow Step

Update a workflow step's settings.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "workflow_step": {
    }
}

Response samples

Content type
application/json
{
  • "id": 975327009,
  • "name": "Updated Step",
  • "description": null,
  • "aasm_state": "active",
  • "position": 1,
  • "asset_group_id": 1073074243,
  • "auto_approval": true,
  • "manual_approval_type": null,
  • "approval_user_id": null,
  • "created_at": "2026-05-28T20:16:06.552Z",
  • "approval_user": null,
  • "send_to_lightroom": false,
  • "lightroom_user": null,
  • "approve_on_frame": false,
  • "set_in_progress_on_frame": false,
  • "workflow_id": 1014085962,
  • "lightroom_user_id": null,
  • "enable_descendants": true,
  • "preserve_subfolders": true,
  • "editable": true,
  • "asset_group": {
    }
}

Delete Workflow Step

Delete a workflow step.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Approve Workflow Step

Approve selected assets in a workflow step, moving them to the next step.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/x-www-form-urlencoded
asset_ids
required
Array of integers

Array of asset IDs to approve

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
[
  • {
    }
]

Workflows

Workflows define multi-step approval processes for assets. Each workflow contains steps that can require approvals before assets proceed.

List Workflows

Returns all workflows for the organization.

Authorizations:
Authorization

Responses

Response Headers
total-entries
integer
Response Schema: application/json
id
string

Workflow ID

name
string

Workflow name

Response samples

Content type
application/json
[
  • {
    }
]

Create Workflow

Create a new workflow for the organization.

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "workflow": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1014085968,
  • "organization_id": 1071574709,
  • "user_id": 1015822290,
  • "name": "Review Workflow",
  • "description": null,
  • "aasm_state": null,
  • "created_at": "2026-05-28T20:16:28.791Z",
  • "updated_at": "2026-05-28T20:16:28.791Z",
  • "auto": false,
  • "access_request_id": null
}

Workflow Details

Get details of a specific workflow.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "id": 1014085966,
  • "name": "odit",
  • "description": null,
  • "aasm_state": null,
  • "created_at": "2026-05-28T20:16:24.732Z",
  • "updated_at": "2026-05-28T20:16:24.732Z",
  • "user": {
    },
  • "steps": [ ],
  • "editable": true
}

Update Workflow

Update a workflow's settings.

Authorizations:
Authorization
path Parameters
id
required
integer
Request Body schema: application/json
object

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "workflow": {
    }
}

Response samples

Content type
application/json
{
  • "name": "Updated Workflow",
  • "id": 1014085969,
  • "organization_id": 1071574710,
  • "user_id": 1015822299,
  • "description": null,
  • "aasm_state": null,
  • "created_at": "2026-05-28T20:16:32.884Z",
  • "updated_at": "2026-05-28T20:16:32.893Z",
  • "auto": false,
  • "access_request_id": null
}

Delete Workflow

Delete a workflow.

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }