API docs by Redocly

Mediagraph API Documentation (1.1.0)

Download OpenAPI specification:Download

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

Using your Mediagraph account via API with a Personal Access Token or OAuth Access Token:
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.
Example: curl -u :8b5913aea36379a098fb4187d8a5face -H "OrganizationId: 100" "https://api.mediagraph.io/api/assets/search?q=sunset"

OAuth Access Tokens use the Authorization header and are implicitly associated with the authorized Organization:
Example: curl -H "Authorization: Bearer 098fb4187d8a5face" "https://api.mediagraph.io/api/assets/search?q=sunset"



OAuth Handshake URLs:
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=...`

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=132

Asset ID

include_renditions
boolean
Example: include_renditions=true

Include list of downloadable sizes and formats

Responses

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=133

Asset ID

number
integer
Example: number=2

Asset Data Version Number

Responses

Response samples

Content type
application/json
{
  • "id": 135,
  • "asset_id": 133,
  • "user_id": 1245,
  • "number": 2,
  • "file_size": null,
  • "width": null,
  • "height": null,
  • "filename": "praesentium.mov",
  • "ppi": null,
  • "captured_at": null,
  • "meta": null,
  • "duration": null,
  • "frame_rate": null,
  • "md5": null,
  • "ext": "mov",
  • "created_via": null,
  • "previews_generated_at": null,
  • "thumbs_count": null,
  • "created_at": "2024-04-17T16:30:45.434Z",
  • "updated_at": "2024-04-17T16:30:45.434Z",
  • "thumb_url": null,
  • "is_head": true,
  • "aasm_state": "pending",
  • "user": {
    },
  • "grid_url": null,
  • "type": "Video",
  • "mime_type": "video/quicktime",
  • "created_via_id": null,
  • "created_via_meta": null,
  • "is_version": true,
  • "storage_folder_path": "facilis_ut2",
  • "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
page
integer
Example: page=1

Current page of assets

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

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

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 order, add '-asc' or '-desc' for direction

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 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 samples

Content type
application/json
{
  • "id": 147,
  • "filename": "eos.jpg",
  • "file_size": null,
  • "guid": "4da556d1-98ce-4e8b-9e76-94b9455aea35",
  • "short_guid": "4da556d1",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "thumb_url": "https://d1r3imgd1iwr6l.cloudfront.net/113/4da556d1-98ce-4e8b-9e76-94b9455aea35/1/1713371482/4da556d1-thumb.jpg?Expires=1713400283&Signature=eZgvTWJPupD-2Xdmad2CYQ9fJZQFTV8JRWYehQJktDxu87F~5ZnLgITR8ojCq5malSEmfeRbrTD6Bt5y27QROt64hM0ANBKWA7F5ATEEWIe05tdUZcMXwaFQ0JfG7JkZ~ra52r4Jx3mP8ND-f2KXeqhECLkgQGz5pLcQ1EpwHWJlQLZmji2swQIw2wxDpaI8LwbVd8-2zZsChXoP~d7ccExr1FmXs4w57H1nMD87BHjlWcfhLfxQKqtxE5tFs2iHlAQpnRqdBCU4MQFnC6bVamHJYazwQGL7zVTK2NRhdyulcHUGhXfmtVM0vqWYJbaKGkNDG5d3Nj-yemqE5MZLSw__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "grid_url": "https://d1r3imgd1iwr6l.cloudfront.net/113/4da556d1-98ce-4e8b-9e76-94b9455aea35/1/1713371482/4da556d1-grid.jpg?Expires=1713400283&Signature=LYt6hiR-x3sC2eljWiqIsJSfMx~BeSuzpT~Z3u0WZHzfSmsf5JuGHHrI5yT8VBuHx1atSZYAJ1fbDzY9arLm9Y8hREMfSV3pMXfaleuaDqrpn9TatqW5LxDwnVtHudYZKj3pSLpfhZF085A~glMzxI~rbe~1mdVtdVJ~7MAn61FFTkSsGXINUXni3YkayMOS4FAhOdf4HU~N2~k52i0PNKIjJRlmsftcTMoqGoO0EfNviZnAbSxO~H6~SRPz3BtFB9UE0MhtYAHIQgnLB-qcJEAdp0Hinxjm4~0Y5okUvdt4icigVa6JtsSIOPClA3kyTLPxUFGGW~z3FY3oMNToNA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "small_url": "https://d1r3imgd1iwr6l.cloudfront.net/113/4da556d1-98ce-4e8b-9e76-94b9455aea35/1/1713371482/4da556d1-small.jpg?Expires=1713400283&Signature=UzNrr6G1q1ZVDuVI5oapy8DDX1BSj4b7EY1j3oB~mtl1Rquy9n5dWb3q2bXe2Y~Muo77DAqCzyv6tfYkFzuSJaODXm02Sn8KDZGfOdIUjYdPiEq~73tRDEw4wzCUFVbqs6HZh-WdjwCsyKSdfVfEqLiKqKLHeFY5KBXN5-P-EAnc0f0SCHO~tOrXui8Hn65lU~KqaAHjeATe9vg9RhdDMqqNjEA9XF4wa7ACJZOzeEn~MGPtpC4NNCgKTeW8JpChGu3Bs0E4nWaSUtl8K9qbzZ8m7K3XAb35Z3V8y9QobYBfVFrMieVsYFcpLTfoakv6P3MtIodSxb7WEFfDCMxTsg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "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,
  • "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": 147,
  • "user_id": 1477,
  • "aasm_state": "processed",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2024-04-17T16:31:22.151Z",
  • "updated_at": "2024-04-17T16:31:22.164Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "113/1fd04e3f/4da556d1-98ce-4e8b-9e76-94b9455aea35-eos.jpg",
  • "time_to_process": 0,
  • "captured_at": "2024-04-16T16:31:22.149Z",
  • "captured_at_truncation": null,
  • "captured_at_offset": null,
  • "notes": null,
  • "created_via": null,
  • "created_via_id": null,
  • "vector": false,
  • "rights_package_id": 897,
  • "submitted_at": "2024-04-17T04:31:22.149Z",
  • "downloads_count": 0,
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": "2024-04-17T16:31:23.848Z",
  • "rekognition_labels_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "not_requested",
  • "faces_searched_at": null,
  • "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": "vel-dolorem18",
  • "tags": [ ],
  • "renditions": [
    ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": 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,
  • "product_in_image": null,
  • "artwork_or_object": null,
  • "user": {
    },
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "moderation_labels": null,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "rekognition_faces": null,
  • "ignored_face_ids": null,
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": "https://d1r3imgd1iwr6l.cloudfront.net/113/4da556d1-98ce-4e8b-9e76-94b9455aea35/1/1713371482/4da556d1-permalink.jpg?Expires=1713400283&Signature=SVRgNxY4SaR5p6WVoLq~qrKTs7AtKX2KZhBzL1uSQzCwf8R8wUJbLPJy6~OAYQWzy0o5t6s6bxStMZERxnPRID6HE~SHFUH3mPJax9EnIpsT-bxYS6v3klwEfAtWlHXMUi9oN-7nikeC61l-MP1q6sqTSPN7JneT0UHhWe9CxrFUZOV42pX6QQI2PplnjpVAZVdlRiVtCiVCZlJqwgAQfNyVjz8P0fw3L14GRzxTEcgEz7ufWIANsHQ8wgLEii~t1m5CWk1C0Gv7h8Ix-lV2H992Dx4gnH-G9vQCs0AZH3uaY0JSm-bLO90JgQeysivx~8vNZw9a~QpulwVQmwqIVg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "custom_meta_values": [ ],
  • "full_url": "https://d1r3imgd1iwr6l.cloudfront.net/113/4da556d1-98ce-4e8b-9e76-94b9455aea35/1/1713371482/4da556d1-full.jpg?Expires=1713400283&Signature=Q2tqQNfrpHex0ip5td8nPMrLv2xkI~zzCWrNMhkq9pAenvjOtLdIPoQP2wyUCAtm-CgLPnGkXEvyeMainCo-YkH-JpqWcK~7CrQPv-oXY1EV7XQBK8TzTX65CNzNqa48LbReCaB8Oue~aA2OKC-vc2r5xo58SxrmTl374Ts-bc7hkpwaJGhU13CrLC7k40OnkRtxgH5MPmrTBcY6LuM5OVWViCU2b89u7bLnkiLMXUB3rYQZCr5UmhC1s6y3V0eXEidbpR3lqIy-SaXODlqR3yqOwi73IeCVXsaj6CMNmU9bZ9k7KKcYOsI3sCNlr0t9DO4QUuGwoHIRb~5UIirF7g__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "rights_package": {
    },
  • "upload": {
    },
  • "all_requirements_met": true,
  • "tag_suggesters_met": true,
  • "rights_package_met": true,
  • "creator_tag_met": true,
  • "unmet_tag_suggester_ids": [ ],
  • "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

Request samples

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

Response samples

Content type
application/json
{
  • "id": 159,
  • "filename": "quis.jpg",
  • "file_size": null,
  • "guid": "048356d4-1ab1-4f1e-9a0a-33a64b63a39c",
  • "short_guid": "048356d4",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "thumb_url": "https://d1r3imgd1iwr6l.cloudfront.net/125/048356d4-1ab1-4f1e-9a0a-33a64b63a39c/1/1713371502/048356d4-thumb.jpg?Expires=1713400305&Signature=NBbhf9BYSREt7vODbLVDWolhiAldeClN3DwOoWdyeT8InQBJzvakUpRMp4~2CtpR2iP4zTZrjv~0ZVdsNv3MuI-y8eaVHFugKpFH-7V0OMCjx6L5VCQXcVdAyLVcHbepV0-WU0drzXwJjhX6Yn2BJDGhjvM705NEb1Zyi8ddpR4i98SNeuF29Bhf2vXJonDrCbXFyG2h6iVsCrcjy11CAblEc~W530oNLBC50s5NfLF-u8UQhOWmvZiI~Cw2IkmaxwQsESSxR5Yv4BfmlkW2QFlwsUrq1zitJhVaWL~tStUkjBg27jO2YsWoGS8s9aPxcZwkbGTNttHHXQ3N1IUZIA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "grid_url": "https://d1r3imgd1iwr6l.cloudfront.net/125/048356d4-1ab1-4f1e-9a0a-33a64b63a39c/1/1713371502/048356d4-grid.jpg?Expires=1713400305&Signature=J-yfn4PN0Rh-QEHTpJpq6WW-VaqUKCkXCaxi9YVBSeu3yJD26wQGIon4j4b~K6DP0OJ8kMLOYAgngJtZ9fwBLnLnRgENR63aGnJguizYMMQIxi40OzsnlheBnsEgrktF3v28AcJqA4lWmNGFEdv3hbHS4FJlfqhsTWxtLPixVbsmLzQy59tgEY8IL6ZnzAWZ~af4rYM4rm5JUtgIHfx7-8LgnglwoYfsBtwviTC72fJWMjk3sI4SwAdI1mEXx4MC1AdRWu~GElOsv4uyIZM33MQYVQUmUyNYauhYzNxRYi3GXfE0wtjSRh8HscEn97VhjoWnX6exG1KTzoWtMTjt0w__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "small_url": "https://d1r3imgd1iwr6l.cloudfront.net/125/048356d4-1ab1-4f1e-9a0a-33a64b63a39c/1/1713371502/048356d4-small.jpg?Expires=1713400305&Signature=C~OpJIoYd9-8CZ9MeNAQgTNMKopHNqGN~-GkF8iN31VQEppCZx9fira3-EJkLdSDbm2JAP1XCGvWjZBTv1uhV~A6vjQASS-S~5Wp983Gsnj0zXfOTN2lEQDqpkvf5DOBMODP1pmEsvWuXm0vQ7kvhR4anIV6XWLao9YnrDL36Bj~txhpY-ePAa0-apf44xXj987XMDbC8hKcIT3XU45X~VKzZBbEZDf1rm6BdQF3W1qdmu5WenlJaKttoaEJ0vOKOzKdQTeVeX-qCdO-dE205zLB~u2ulMXkhwdkdMdfRTajcNbWDal4tzuH1EauNy0COVfAOS~A2KtQBIlRSFWwEg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "description": "Updated Description.",
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "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,
  • "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": 159,
  • "user_id": 1617,
  • "aasm_state": "processed",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2024-04-17T16:31:42.589Z",
  • "updated_at": "2024-04-17T16:31:44.633Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "125/b47617ea/048356d4-1ab1-4f1e-9a0a-33a64b63a39c-quis.jpg",
  • "time_to_process": 0,
  • "captured_at": "2024-04-16T16:31:42.586Z",
  • "captured_at_truncation": null,
  • "captured_at_offset": null,
  • "notes": null,
  • "created_via": null,
  • "created_via_id": null,
  • "vector": false,
  • "rights_package_id": 993,
  • "submitted_at": "2024-04-17T04:31:42.586Z",
  • "downloads_count": 0,
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": "2024-04-17T16:31:45.207Z",
  • "rekognition_labels_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "not_requested",
  • "faces_searched_at": null,
  • "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": "doloremque-ea30",
  • "tags": [
    ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": 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,
  • "product_in_image": null,
  • "artwork_or_object": null,
  • "user": {
    },
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "moderation_labels": null,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "rekognition_faces": null,
  • "ignored_face_ids": null,
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [],
  • "permalink_url": "https://d1r3imgd1iwr6l.cloudfront.net/125/048356d4-1ab1-4f1e-9a0a-33a64b63a39c/1/1713371502/048356d4-permalink.jpg?Expires=1713400305&Signature=b-1SytYk79bsG9Q2wbFhaaS2xp1KDH4~e9-cx2D-pinVo~hyWk9Ln6ysAZVi9zuq1Nia9LJAShfinlP6Y3J52rp5S0RUt9knMiQnWcNbvO33fchjKGNBmCwIcI0mN1uECRgxqbpI7MG2vTUaBm9uWlHlAjt9GQHlWuQPtVxNevV4QnSX1yg83u4wci8F0qyiqMdUDk3HVuCXNBSVQcVwEpGfjEWXqfMb3vNfRsK12-Q7thvSvj-WcJ~nPggmpRD0h9ufqDyfyUL9rCD0zaCnlJOLfqZrS~bYnvaa3ptNRxT-CGcXqgHoa8MzXrh3ApVegmc89lUHQPwrkzfLMpVDvg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "custom_meta_values": [
    ],
  • "full_url": "https://d1r3imgd1iwr6l.cloudfront.net/125/048356d4-1ab1-4f1e-9a0a-33a64b63a39c/1/1713371502/048356d4-full.jpg?Expires=1713400305&Signature=amstqtwKA0ktAzfrRQeMsIBor3B6XM8d7kTHBkBz5DftpjMpIzWwkYuxhdDUb6Z4NZJgwDZwAl91klgzKOU26wTPX5BMOgHrBmjmPSHJQUGBcjkL3yaus96TP9crJ3vKgduSwCBEja3J3JhVKhmCQ8KQ6fObDRFqRWd8laLKXV-aQInfISf7kiweaIUNdBgbYsOqEP2wLEaOTskDu462seCRhiSDAAi5TuGRQrEFWRkF6zmWl~lYutZWvxLXx8KgM-MDvmUxrc5MFD5~Dp2CDot3rnB0NnE5IMKJZJda9XyMZx-9flV8Ci1EsYC3PfWWENkXfmK0jStRK0CxJkouQQ__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "rights_package": {
    },
  • "upload": {
    },
  • "all_requirements_met": true,
  • "tag_suggesters_met": true,
  • "rights_package_met": true,
  • "creator_tag_met": true,
  • "unmet_tag_suggester_ids": [ ],
  • "collective_work_ids": [ ]
}

Delete Asset

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

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" "permalink" "full" "original"

The maximum size requested for assets in the download (default original)

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

Download Asset

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

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

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

Request samples

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

Request Asset Optimization

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 165,
  • "filename": "nam.jpg",
  • "file_size": null,
  • "guid": "82dbbae7-da03-4f0b-a7d8-90de8c8fc004",
  • "short_guid": "82dbbae7",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "thumb_url": "https://d1r3imgd1iwr6l.cloudfront.net/131/82dbbae7-da03-4f0b-a7d8-90de8c8fc004/1/1713371513/82dbbae7-thumb.jpg?Expires=1713400315&Signature=VL2zbABBseGibQNpWyZYPAjwyFGNc77NE3nKvJROHsYbRManw6~AOF2Hte3DBxqT14mFgwicmllG7JiXqEw4DX9PctlqBjFohtbE0FRze5CRz-MX16EsLhJD-Uh-t9SKmjDn0kQ0yQ6rAMSMVpWgHU7EBuXXB38dedo5c4ln46XNWwIaLlqf8aQiDyXMcj9iJMdXDtvBphw7lqLnLv91dbW-xMQp1GnhbuVACvt5ZDp5FSh5dowxNKsJFSbuWl9susuK~4u9Kt6xHXNRj1IkW7mlDNTO5ohWjx1XloEYl3FoRXiZ9FJ3BLSRMN0xF1tLrUCKjTBMlaLWdOWJnUZnBw__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "grid_url": "https://d1r3imgd1iwr6l.cloudfront.net/131/82dbbae7-da03-4f0b-a7d8-90de8c8fc004/1/1713371513/82dbbae7-grid.jpg?Expires=1713400315&Signature=NC4kKyrd9xMgD5lXve6xFe0xBV4atlYFLYSEJi2n4mQR3OQxP~DsMTYJdgDlnFicb721RWStYZZdl49Elog3mvQqEPm9MPy-dqXPRHud72Pq6nDvrP9vNIfT3ZTbmvuXxl4ONmIGVxOH6EsAirWVg8kjiXYn5MqCIFIYbAhF2B7Dh4WQVdGlYb4oAYQWZDOOSvlIJbeulzJNq0IytiEBJTK1hpcRTD5~Cc3J7qfAsdKQraxrMR6vwXzoelMhJv~FgYpa2tgjoUlpNhe-u-7-A2dJsZCCbZD3MqoI0zV6nq01e68NL9IagN5VpR2kWPnRbjnQunluAY0sy-v5HnxLcg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "small_url": "https://d1r3imgd1iwr6l.cloudfront.net/131/82dbbae7-da03-4f0b-a7d8-90de8c8fc004/1/1713371513/82dbbae7-small.jpg?Expires=1713400315&Signature=OMqGplPBdyDCEPWu2fvtPwhNql66dDDwAo~1adnRy3C9whei45gZ12IxhNxW-9yGoch3gzb4G7Q2EAzAn5QzMwOipWb5VL7BVa7ftVt1wv9N7nKw7Cq40CfKk~-5QwCbDWRH1JBRTNshDECtafIBWdCoidj98oCapx3uFAEhIDbzvHWgoIlYwOYOPwQs9NzqYKNEbqBu73jynZuhpPR4HhpKgzxOl7-572j-f9xeoA6hYSnfKhDV5v~oAHAnj2J2DhxC8DSbzBMyKNXO-ZvlelCYq8lIOO2jet9NFOGzhqnweQBDUlCL2QorF4ywoMApEc3fAGYcKeM3ntJWklY~zg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "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,
  • "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": 165,
  • "user_id": 1687,
  • "aasm_state": "processed",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2024-04-17T16:31:53.590Z",
  • "updated_at": "2024-04-17T16:31:55.213Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "131/8bd9913f/82dbbae7-da03-4f0b-a7d8-90de8c8fc004-nam.jpg",
  • "time_to_process": 0,
  • "captured_at": "2024-04-16T16:31:53.588Z",
  • "captured_at_truncation": null,
  • "captured_at_offset": null,
  • "notes": null,
  • "created_via": null,
  • "created_via_id": null,
  • "vector": false,
  • "rights_package_id": 1041,
  • "submitted_at": "2024-04-17T04:31:53.589Z",
  • "downloads_count": 0,
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": "2024-04-17T16:31:55.210Z",
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": null,
  • "rekognition_labels_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "not_requested",
  • "faces_searched_at": null,
  • "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": "quas_et36",
  • "tags": [ ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": 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,
  • "product_in_image": null,
  • "artwork_or_object": null,
  • "user": {
    },
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "moderation_labels": null,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "rekognition_faces": null,
  • "ignored_face_ids": null,
  • "optimization_requested_by": {
    },
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": "https://d1r3imgd1iwr6l.cloudfront.net/131/82dbbae7-da03-4f0b-a7d8-90de8c8fc004/1/1713371513/82dbbae7-permalink.jpg?Expires=1713400315&Signature=O7dBk4fZDvctdziDQPOXtVlVzcmookVetGbddM-lcEHho7RjMb9TY9bLVKln3-wkl2I-FpUjsVJ02GeZPkC6g2oXzP4Gtt~yjOqwv4yhy6tgaJ9y1lIAd1f3CkBKzB5Hp3yttp6J14AlTiqISMn-OdhJ75Yz7gaEduSYhPE0Y3pUBf8TQmVulkTsj51gG7FJ32e5PMffCwEtCRmj0TyWcO40JZG3dIQiYpB~-Bfsf1fZMKPdl07VnJ431-gvDLz3YPHvM9T7GjbPLLUFQZBypiCf946Z6YONvrhqrqTMSiIP0hgruqxWXSyJ7fDJ9ltGWQtYQgNfO92hPsJWR9fuhg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "custom_meta_values": [ ],
  • "full_url": "https://d1r3imgd1iwr6l.cloudfront.net/131/82dbbae7-da03-4f0b-a7d8-90de8c8fc004/1/1713371513/82dbbae7-full.jpg?Expires=1713400315&Signature=Q4kijaR~YBjdZff3iIguXeUX2MfhTj4bbmpTQBdiMoIIOl6xyb72XovEQRS2Ryu5ELQ1IMI3782B6lsAgDo6QY3Ea8Gaypylx3BV448snk4kb~suDTm4Sr50CuYV4SLkXNU16-sxh-ZxZ22TYKYVpDN500u6IM22u8W9Y3JulYP8AmFeCodlZkieTuc~temkdGj~kR1-hXFw6lO7T1kQauZy2ZJNuNv-CIWHQ6RkC57hB2dm2ELsSI3KiD1~13zoS0IcnLZDcIJHMexjPVJ-dXNnnaljk-nQGHjnCD-qVheMHakgHEVq8unEmGrH46CxokgPN1N4YHgO2G1AtK5Q4g__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "rights_package": {
    },
  • "upload": {
    },
  • "all_requirements_met": true,
  • "tag_suggesters_met": true,
  • "rights_package_met": true,
  • "creator_tag_met": true,
  • "unmet_tag_suggester_ids": [ ],
  • "collective_work_ids": [ ]
}

Complete Asset Optimization

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 168,
  • "filename": "quia.jpg",
  • "file_size": null,
  • "guid": "7239f50a-380e-451f-94bb-1614f27ed069",
  • "short_guid": "7239f50a",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "thumb_url": "https://d1r3imgd1iwr6l.cloudfront.net/134/7239f50a-380e-451f-94bb-1614f27ed069/1/1713371518/7239f50a-thumb.jpg?Expires=1713400320&Signature=Gz2Fj0a1wuWYnrdLsq5nhAOJZLCsAmIA3CGOUrXbOt8E~X-SRp9nUxcyI2Iv4wf6pghRA41WxvjEFlcbn~-nxcajIsizD8JTu72BGRwlSOkOISTCnjlfVAWQ5J4yyiQOJn2XITDdAsxZH4CuIw0N7S~aqvHb3Ea~XIa8F2pMTxmnpMSkC4rV6MeX97811rfSt5FpHwKp2ZQwvzQRduPFPIqAmIy2pTWmn-W-wkC-V9XWKBRzkAz2s1xEHbpw0R5mR4EpDZXlrjUL99ESbCGh2N9BgEAFKj4KaPTWSKcX6-yBR-q1sPiNFbpkrj02UabX65i8v9P12Zuo-~ARHQtVYg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "grid_url": "https://d1r3imgd1iwr6l.cloudfront.net/134/7239f50a-380e-451f-94bb-1614f27ed069/1/1713371518/7239f50a-grid.jpg?Expires=1713400320&Signature=C0t0IeJRbxm6KrtGMjMMIYMuA398yP9k3hOuEQWzzW8foP5VuEx-mmOoTJu0j4eItMYCYmEJ5OGLxXQRNlzs6EZCqeKh-Lcw-x1k8re28eXh6wULF8mwxOy2Vp9KSh6EjG9K8Npz5vEVvTUkDAfxCQxkKpXfNTRegwI8ciY~QYIV3oBw3kziGEJclYRlvBhWYUK2G~N7gSs1IaPpQeUn4f2guqJusF-dkxvi7ePBwdBPSFJ8PM96PCt9KDFok2xl~uSV6FxDUmuqkdQhfNCO1hnOe3hay2puJEXYbwV--c4LSB77u~webzgOM3xFq04j7sAviyxQ7Lv0qNauTz~LcQ__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "small_url": "https://d1r3imgd1iwr6l.cloudfront.net/134/7239f50a-380e-451f-94bb-1614f27ed069/1/1713371518/7239f50a-small.jpg?Expires=1713400320&Signature=ZXrl~wlYZFs0xJW-2F7kycpGmKyxaDxK6GIK74vrzvjDvltjcjnnNV3xG64knnU6J3Tf-JgqyVH79V7e9PedjNNpucahDfyyIEcCi4lDVPlOClQ9RaVUjWUB3AO69H~jPtpHv7nNmWKQOhirR7DOvdu8zP85msGEvPY-n1ZEMRSrvYajHXpeSrTgfYWZdchoc~Z7eRBNswp3AEK1DKGIz-wXzqavhaDCMYHqyFDXZKeC6hRfFBirbGX2mZgoBKZH4eLyxMmtPRM733boSDoS-d7GQt~-hwKYNsPkZLu8aXqkdlmpBPa7j87OXle1tnNGZVU8tdJJgOmtR~FpiMUiFA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "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,
  • "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": 168,
  • "user_id": 1722,
  • "aasm_state": "processed",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2024-04-17T16:31:58.634Z",
  • "updated_at": "2024-04-17T16:32:00.340Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "134/adc50400/7239f50a-380e-451f-94bb-1614f27ed069-quia.jpg",
  • "time_to_process": 0,
  • "captured_at": "2024-04-16T16:31:58.632Z",
  • "captured_at_truncation": null,
  • "captured_at_offset": null,
  • "notes": null,
  • "created_via": null,
  • "created_via_id": null,
  • "vector": false,
  • "rights_package_id": 1065,
  • "submitted_at": "2024-04-17T04:31:58.632Z",
  • "downloads_count": 0,
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": "2024-04-17T16:32:00.333Z",
  • "trashed_at": null,
  • "last_external_sync_at": null,
  • "rekognition_labels_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "not_requested",
  • "faces_searched_at": null,
  • "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": "error_accusamus39",
  • "tags": [ ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": 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,
  • "product_in_image": null,
  • "artwork_or_object": null,
  • "user": {
    },
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "moderation_labels": null,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "rekognition_faces": null,
  • "ignored_face_ids": null,
  • "optimization_completed_by": {
    },
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": "https://d1r3imgd1iwr6l.cloudfront.net/134/7239f50a-380e-451f-94bb-1614f27ed069/1/1713371518/7239f50a-permalink.jpg?Expires=1713400320&Signature=Gn~-wG5dlSPrTTSMIQj6XThbq0QksIp8nTbw6Sw7ZsM7pPiKoyzQUVx0g~F3jSYfya8bXiPGCOJULWfv3CJW56k7by2pO16CdiBJ5nqbpp12Yh8o3ZNb8Ud~qvQffgXOykd91sh9ubzeqyvXQ15nKE7hgL7wSMGt3~KSjuGfi~g17gVLnHcipbdoJNUiwfZshwjHGhJlUl-rKaF6x5FbBPjlDylA3BDevBixECauzvSB4wlmlSmV7vW8QaiqqQdmU4aX-bMGdHSahtYGPXpjkkVHGRpk2AHYxpzOqtlpIvBXkSJo3D19bFkelzLFoB9~QmcmIz6vSkg0T93UeAP7~Q__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "custom_meta_values": [ ],
  • "full_url": "https://d1r3imgd1iwr6l.cloudfront.net/134/7239f50a-380e-451f-94bb-1614f27ed069/1/1713371518/7239f50a-full.jpg?Expires=1713400320&Signature=PVlHIr67-o2R19w~obTrUwVucgsx~ttSa5SZ6DdfK4vQNujZehHzsWU3BtJ3DJ2Yg7D8UX8MUqglqtECsdZDr9PFiNX0cV6Mq5Drd~3WIv9G5-NghanI3SUYlkAbHKDQBs8ypvVBIGTbA51a3X0vKh0MR1mu9A8qOg3nY7HSwSZy-dSsMfsgJ71PXdTDZWSIZfqtXEy7Enpxvev36v78DqgzJxuJyBA2UhxR64xzUyIOromU49h2YnLhRUZUuH~FKTD75Z3Hh06yMnmNbDG7KV9LRCqPjufBnF5PF0jdgN-xcvARlb8nNAI1GMLvwBLbNmFj0g6xmghBkvdWtPhzCQ__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "rights_package": {
    },
  • "upload": {
    },
  • "all_requirements_met": true,
  • "tag_suggesters_met": true,
  • "rights_package_met": true,
  • "creator_tag_met": true,
  • "unmet_tag_suggester_ids": [ ],
  • "collective_work_ids": [ ]
}

Remove Asset Optimization Request

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 171,
  • "filename": "vel.jpg",
  • "file_size": null,
  • "guid": "76f58bf1-74d4-4321-a8ce-0d867fff98cc",
  • "short_guid": "76f58bf1",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "thumb_url": "https://d1r3imgd1iwr6l.cloudfront.net/137/76f58bf1-74d4-4321-a8ce-0d867fff98cc/1/1713371523/76f58bf1-thumb.jpg?Expires=1713400325&Signature=LfLj2JCPbKNnFI5SbHBWgET8JYr3NqXKYs8jBQH3FocCPihLGv07422sQZQ1UyhK-CHE~t-QfR0hbCmuHPAFjcMCLhq6L7sjFUzp8L9EFhfabpsH89xCKgs09AwgZhFL~paGSBgbke0xYiGvaBZA5HEqNorSgXnGQ2uQZNmYJx7wPaSyvZeWyC37bT7kA~7iCJ-4K5sJIzG8QovyI4Jx2wpCwPU6dztr3XDpGyINs1zNCg2cArQKx~ZxeyVraxhoKQhHyBFoRq28VztuCmPtJSQ2QNTd-M61~TeB5M8uDMeA4~ox67UmbhHBCBjHDaJbe9FM3Y0b2texPj-tLDQUGw__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "grid_url": "https://d1r3imgd1iwr6l.cloudfront.net/137/76f58bf1-74d4-4321-a8ce-0d867fff98cc/1/1713371523/76f58bf1-grid.jpg?Expires=1713400325&Signature=WtN583As6yPcoYoTMBrAYgA5iadtLxNeKSc8u3MzeyayeBDyRuViFpuRM3Mz9BvFdbbQENgyO4yic9i8bpdF71JCsn~GB7OsIAnotK-UUBHEnFVQBz8xbjH33CiBOrOEAewuhoz8UMeyemNNYIufmjxmfxKqATfTdoBorcWHxIDFyUIKqd-RQITWvhZ8H9jRQhqOGQDRZ0igQeNOXoTJhcmxV0l1WFbPby8rGfQXLMf6EMvJp8kQCc22fc7wjxOGd91U--8kouV2swoWizcCvKVqj4wefzsef9~qMjlrxvL~8rSMrYwfW9yGgLmccCD7wOj11cHXRhQLt9BsmM4WTQ__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "small_url": "https://d1r3imgd1iwr6l.cloudfront.net/137/76f58bf1-74d4-4321-a8ce-0d867fff98cc/1/1713371523/76f58bf1-small.jpg?Expires=1713400325&Signature=HJOj445Z7KDhUna7JROezuI-Szt0grVu9ZBVALB2ThCjr1LATPv8BgwURyiHP1FeY9ix-6KaZyrNtHXVlTgxnM8QfhqrS-21DIBD48r4HUqgVjs0rBGz0lafuV5rIADoW8jGm5z~fH4x20ppQ~LdOdLCuuzAH2itKfJr3OSIia8VH4CEJOH1BJ6Va9y7QBRGBHwAPje7niyUj8zQkWpVO-XyDgleivj7t2tadBmA0Mg3MIz7hTaXgr68-kgTmlIYYMRcWF5ICzMGknXZH4GcmOQvz5hWELv6IoOcZEFlERZYYLQPHQkdp-nP6Wi2ONiKS95BYCBte5Kk7TM~mruSsQ__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "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,
  • "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": 171,
  • "user_id": 1757,
  • "aasm_state": "processed",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2024-04-17T16:32:03.701Z",
  • "updated_at": "2024-04-17T16:32:03.715Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "137/9380773b/76f58bf1-74d4-4321-a8ce-0d867fff98cc-vel.jpg",
  • "time_to_process": 0,
  • "captured_at": "2024-04-16T16:32:03.698Z",
  • "captured_at_truncation": null,
  • "captured_at_offset": null,
  • "notes": null,
  • "created_via": null,
  • "created_via_id": null,
  • "vector": false,
  • "rights_package_id": 1089,
  • "submitted_at": "2024-04-17T04:32:03.698Z",
  • "downloads_count": 0,
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": null,
  • "rekognition_labels_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "not_requested",
  • "faces_searched_at": null,
  • "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": "commodi-deleniti42",
  • "tags": [ ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": 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,
  • "product_in_image": null,
  • "artwork_or_object": null,
  • "user": {
    },
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "moderation_labels": null,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "rekognition_faces": null,
  • "ignored_face_ids": null,
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": "https://d1r3imgd1iwr6l.cloudfront.net/137/76f58bf1-74d4-4321-a8ce-0d867fff98cc/1/1713371523/76f58bf1-permalink.jpg?Expires=1713400325&Signature=f24oNdFB6k3eKtF2QIYUZztf7zrh~YN6bqH8bEQCRdmWHNujJjcX7Un5xowODzbDW8ijbweO6O6TAdwvVDhEkzC2Pl31MrUK1t8Gsu27i4xtS27CF27qlESSNHJXxdQXYge1bfNOD8ZQkwqaY6tEjTPzWT2zujnzXMxfKVtLz9TYTtFgT7FYm5g6INNYTRAxCUaJ2ovKfC5e-soPmvFBgwzd77cX-jFIFCreUbFHPQrFOENkI4I4Upesd3I7AHC-GMa6CCsQL3KpgiRNM-LWZIrDLlrUoQXSnuxQ3-JGTdJQs9b6hZMLB1S3zTZ~MDk8kXI0TPYvi-hF3goxrUhEAw__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "custom_meta_values": [ ],
  • "full_url": "https://d1r3imgd1iwr6l.cloudfront.net/137/76f58bf1-74d4-4321-a8ce-0d867fff98cc/1/1713371523/76f58bf1-full.jpg?Expires=1713400325&Signature=QXrCmvZlpmGgODNgEo-hZ2-kwqq3mStTa143h5BF4rN2bWMGELMLCFMFPymTfzzvHyTQn2Ck-hOE5HlNtVU7vmplrFhTNIlztnehOjO1t6eak4vBW9SoPR6mDEm7TvxqBcnEEE~DXea1u28cNuG91WAKtKnnMMag4MKcEGG-LQgZeRvWp~-2omKuKMN1v-3Mg6R-9bcp8-T37BqCGKTRKP4s6RSD2vSq~zkX24M4g9Tkwqc~BaE6Lhdc8Vtg06Y8dJ0sS6whUt-QpluXAPfSp7b-e4Ks5-StZa7qdcHWu7of6b~LSxjhlJn15cJKu-YG7SEDIQ3iH8HO4GyG6nlIAA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "rights_package": {
    },
  • "upload": {
    },
  • "all_requirements_met": true,
  • "tag_suggesters_met": true,
  • "rights_package_met": true,
  • "creator_tag_met": true,
  • "unmet_tag_suggester_ids": [ ],
  • "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 samples

Content type
application/json
{
  • "id": 177,
  • "filename": "facere.jpg",
  • "file_size": null,
  • "guid": "ea15ce8b-ab9a-4635-b71f-e36fe15540e2",
  • "short_guid": "ea15ce8b",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "thumb_url": "https://d1r3imgd1iwr6l.cloudfront.net/140/ea15ce8b-ab9a-4635-b71f-e36fe15540e2/1/1713371530/ea15ce8b-thumb.jpg?Expires=1713400331&Signature=fc7iCJ32SqndsMwZ6H1kFgQTcqq52UPL4oY-~iIedzCkyjEFz6YCZGPxtjirldcMb6PPIrkcO14IZobxUMHPURVhhVZZ01cn8ntY5CDfHanfK42WAbWJstKGbcsGhJvqxLwk9-GTlodMLu7z~LBi8s~bdCw5lC5rpMh8oQhHPFN7YhkakLPyMeNf2PM4Hk5X26qCJWaVTpCVL5cuAsWUSVQz2IwPnmztcVmodNrnVb1CSu0dVhJoBRiLIFPfV~cIJB0JRWcHOUDk-je1eaB~qnd9afrYZCUZMp9XY3~6~-x8yAFRJfkI0vG5AYYVDk-9YcCyEoHP2CT5QzxtUwoWMw__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "grid_url": "https://d1r3imgd1iwr6l.cloudfront.net/140/ea15ce8b-ab9a-4635-b71f-e36fe15540e2/1/1713371530/ea15ce8b-grid.jpg?Expires=1713400331&Signature=MHl8UVHN5HEsq1X9133SeGhAJK594KTre-UF~6zgMWVRfD3QYXHplBRiJj0dgR4SM9HxEZdS9aWBdUiKWmUqf76xkeJ0kX2VxhjTuwN-0UY~8HiDtjognn1PMveIxkGRt3-HRnq69LXRcqXOVlgmsNLAhMRU4IjzpmDPr5E2JOrTCQ5H09DJOb1QliQIH7EDK13BoIkP08LVjhqvHU20RRAKBA~sH4ACMExGXL8tPRuGO478nwxhhfvX2p7pJ4Xn0L6M8bAR3RLkc7Pu~KC~Q5Axdtsn01YiBIbeWolOeqXuCguPbBpf7uBCqOECNXSS-mzqDNRc8Z26PRap19C8cg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "small_url": "https://d1r3imgd1iwr6l.cloudfront.net/140/ea15ce8b-ab9a-4635-b71f-e36fe15540e2/1/1713371530/ea15ce8b-small.jpg?Expires=1713400331&Signature=Qi5qCr8EgL~KdO4c259MN6yyf~oEL7SHjtBwM61E3aKuxYc0eQ3BT4jmFemUAIEr8kE6p-Ea4DNWt31RheJIUAcnUSljeGTFEaaa~47HbjZj54k97VfhUJHG7G-ekXN~NjfhfhuIBa6gD8pTbaUYukdrtuiFyfdC3E68YP92pmY96JABHwPDAxsXoUrxi9KKDFYz6uwtag8tOmx8pMW5iXmMpqc1E9OEI00bbNhH3WcZgLzTBbxsR996o2gQY9fK89X35kwyPtmNIJoKM1CoagZHHVk6W3dDmVYpDijhHYORKV1z8h8FvwZUjePm~GzClMVQmDugamTgDv54ofBxyg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "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,
  • "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": 177,
  • "user_id": 1804,
  • "aasm_state": "processed",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2024-04-17T16:32:10.795Z",
  • "updated_at": "2024-04-17T16:32:11.209Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "140/2d7ca702/ea15ce8b-ab9a-4635-b71f-e36fe15540e2-facere.jpg",
  • "time_to_process": 0,
  • "captured_at": "2024-04-16T16:32:10.793Z",
  • "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": "2024-04-17T04:32:10.793Z",
  • "downloads_count": 0,
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": null,
  • "rekognition_labels_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "not_requested",
  • "faces_searched_at": null,
  • "creator_tag": null,
  • "storage_folder_path": "repellendus_dolorem48",
  • "tags": [ ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": 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,
  • "product_in_image": null,
  • "artwork_or_object": null,
  • "user": {
    },
  • "data_versions_count": 2,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "moderation_labels": null,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "rekognition_faces": null,
  • "ignored_face_ids": null,
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": "https://d1r3imgd1iwr6l.cloudfront.net/140/ea15ce8b-ab9a-4635-b71f-e36fe15540e2/1/1713371530/ea15ce8b-permalink.jpg?Expires=1713400331&Signature=An5H3w~yErwgbhSbMe7KCeHFkHssWDnAcxvmLwXBOh~fwxv-Twk4QVdzNde~DNcHUQ3i6yoBRKCvforR4hyAjOViKUOVnRoEC9c9L5MhyTdly8ymLjHyCKDWyMVw8pp7D76YQOLLvEk-m3KnJC5-HYiipiv-FLpGDWMBsQoWjraqIqrBfyfSL5ymtoRQakNiW~D9jxQWBmsfHeuRmta7PsRMrbKuquEeJZvyBdQtNmYCT4DPUGBE52875s8EMCBe-ndyqp37osamzebNx60o1WU9Qpfz9KX6IaLznaSZ0TXaP8DhCeVKoM4IerO5rfq0iBnHfER9CDrF9ntthHzKeg__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "custom_meta_values": [ ],
  • "full_url": "https://d1r3imgd1iwr6l.cloudfront.net/140/ea15ce8b-ab9a-4635-b71f-e36fe15540e2/1/1713371530/ea15ce8b-full.jpg?Expires=1713400331&Signature=TnyOA~8SKc3zE0-xLPyIjeT8qn~Rird3afdCD6w5slSuMMtJIjOzBW7~AG4DK2yp0slNwMvs6CQUlKYZDNy6Ekxjr7uPVNuOc2JuSX4KIw2XYyzVQwMIC5Lub6cF39Agaofek4E8kdbXq0iEHxmRHmCHfZ2H~BvZSmxDCsVXoaQmTB3LCLeioOIlUeMyfOFvHZkfb8Eodme6280zQXmd4majODYlVAW0DtWao-qWUWbg1rTCvJjq6eP5yYNQEpStG4ScGxjWYwN9Yj1OEEAr~8AGv3YDt4NtCxmeWxP6YNdG6AVi3hj12taew2~AM6QpXSxOXKSrvY9ZMDXAfY7PTQ__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "upload": {
    },
  • "all_requirements_met": true,
  • "tag_suggesters_met": true,
  • "rights_package_met": true,
  • "creator_tag_met": true,
  • "unmet_tag_suggester_ids": [ ],
  • "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 samples

Content type
application/json
{
  • "id": 178,
  • "filename": "maxime.jpg",
  • "file_size": null,
  • "guid": "a3831462-16e9-485e-80a7-e1983a35d0af",
  • "short_guid": "a3831462",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "thumb_url": "https://d1r3imgd1iwr6l.cloudfront.net/143/7694d0b6-c96c-4ce6-aab0-d201e3e9699e/1/1713371535/7694d0b6-thumb.jpg?Expires=1713400336&Signature=a8CAwgomPEPdpBh10o1gC1ceH-hTmP0AGO1joRZXhaJDMqRdTwETy-05F4NuIZVzrVjvP0QHSFpCjHWvHBWqf9E6JZf7rZMjBRbOMTTy~cai~cRxJ691A1StHVbYFs6M86xecbIyz3bNMjaHQ1ydeaSLNiccoxtJWYskyhTe7onl5o5FS-1-XXRysWKxVWXCS9WV-wbPmDdtoxbTLAYJ~sZegHJrs2D348E5F93qA3m09w~1M8WNStXVFW6Lgtw-UmyV8LuPBvF~uYafWAZ0I19Ce82q9HyPbxyQ1SHvghNFwlAcJo6lKNL9Jwqkt2Y4e-84rRsfbkGSUEhv15XZlQ__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "grid_url": "https://d1r3imgd1iwr6l.cloudfront.net/143/7694d0b6-c96c-4ce6-aab0-d201e3e9699e/1/1713371535/7694d0b6-grid.jpg?Expires=1713400336&Signature=cCHw0hc5FXUQLRkkEUT2h7DBL2ND9y4d-5DEafDd8ucItEA5941BQQlAJ5EVUCU9EQk0uQu3I63K7Ii~CljDoXILF0JdJgtJknjVskZojXXP58dDdPY3tWhvAXFmgtmLMpgw8iYdiqxU5NEsfvqJ2ny0EfHvi3WBmqJ~Y7sqdiIRlAeooWuNzo1X7Ts2r6dVEYD~b1nFyWuQiTqt50VMHv740bbK~GMRkQFIVK5O7IHdWNRNFGF0CQZ0YwiEOMo-q2FOTkKHumR~leHJ3p33lMHHVGAeLWKUUGbb~Ww6D5RR9DCfEFo~LBJiItQD3MuXgErISnkniHZAcapwCNAPSw__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "small_url": "https://d1r3imgd1iwr6l.cloudfront.net/143/7694d0b6-c96c-4ce6-aab0-d201e3e9699e/1/1713371535/7694d0b6-small.jpg?Expires=1713400336&Signature=azAnBJNAIkjzr8FQWOqivyVaUpQ1pvn2xEAnlXPuocIYWgUZ1ZqubS5iNdPlIwTqBtUt85YYQVMrBBe8C4oSf9~Uo-XXqgVjyY4Jz195~adGdaTEt6h1sKxE1horJVWOtOLdcIsS~kfyUCEMNPvPxQsPF2nm8~ain244xrP0tsdCHOltk0gBHN6reIzLrMaWyAcZFkBMJK002AD-HWvWM0~IyL2YpZAmt6WnnlI6sWOfhFK1EpFnLyWbAjbXIVAMb19sI0E0ztyKzMP0iURqR1Q8I6vlmgWD2jjeDHAhhkMIehlHqPc7bid9-yspCC61dglmDSeorgnLsEyiNyasog__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "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,
  • "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": 178,
  • "user_id": 1831,
  • "aasm_state": "processed",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2024-04-17T16:32:14.340Z",
  • "updated_at": "2024-04-17T16:32:16.321Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "143/3f911f4a/a3831462-16e9-485e-80a7-e1983a35d0af-maxime.jpg",
  • "time_to_process": 0,
  • "captured_at": "2024-04-16T16:32:14.336Z",
  • "captured_at_truncation": null,
  • "captured_at_offset": null,
  • "notes": null,
  • "created_via": null,
  • "created_via_id": null,
  • "vector": false,
  • "rights_package_id": 1137,
  • "submitted_at": "2024-04-17T04:32:14.336Z",
  • "downloads_count": 0,
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": null,
  • "rekognition_labels_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "not_requested",
  • "faces_searched_at": null,
  • "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": "earum-tempora49",
  • "tags": [ ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": 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,
  • "product_in_image": null,
  • "artwork_or_object": null,
  • "user": {
    },
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "moderation_labels": null,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "rekognition_faces": null,
  • "ignored_face_ids": null,
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": "https://d1r3imgd1iwr6l.cloudfront.net/143/7694d0b6-c96c-4ce6-aab0-d201e3e9699e/1/1713371535/7694d0b6-permalink.jpg?Expires=1713400336&Signature=eg21407sxoyReAE29hGZ4AQnNRDN4Sno8K4w45vkeP~SALGHaVN48vfUokuegVkWiu5vYi6ty93ttf2B47z3aNR2KTOejzhKDYgPiK~~KWiy1X2MHnO3SyqjpyCmn-wYyOI2yb16Y2nhfTU9uczHN67mg-NrLxrNxDVTe7kQaJDl7RbnSll0uXL4EAKZM0nFzFhzG~r7LAbjVv8lGlT~7poxrG0~yDsxhfPAddef4Hs2ABijuu4-O4HYf3dgEFUYAZC8UZ3wvDicPzJF7m-237Z6IYFgWYHFqf5idjVWC9Heti5PKxyTdjyQyoP3hEVzah8sb5NHnSYIzn0srveONA__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "custom_meta_values": [ ],
  • "full_url": "https://d1r3imgd1iwr6l.cloudfront.net/143/7694d0b6-c96c-4ce6-aab0-d201e3e9699e/1/1713371535/7694d0b6-full.jpg?Expires=1713400336&Signature=XmRljMNmYxO0~o-1Ptd52mFjJCPAEBUSxFd2PMdXMS6UOR2wHw5uB8ZQtZT9R0IQsdQjkyDhCKx2IXO6n4GwkTZ1RRoVwrcc3knbze1m5DkjO2OFdoizZkDpjQV2IJ1O03CS6iyPeowXL1WIGkZy-bmN~Zx2-587EP5cn8Qp7qFEGzNkXD5~2HqQYukqB7xr6TskXdMwXMN4R~4rDrwxTpzAdgV6CNbUXaDPVPuu5n8N3sP4zgcmN5xybJKo57SaysNZqFqGYyOnin5Iszcotyn~6RGfX1D4tJ7x4PYfH5N878u~sbzySB5NVYi14lGQ7LuGOMDzJeN9QGKIcvob-w__&Key-Pair-Id=APKAJMR5FJVY6XYNWMHA",
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "rights_package": {
    },
  • "upload": {
    },
  • "all_requirements_met": true,
  • "tag_suggesters_met": true,
  • "rights_package_met": true,
  • "creator_tag_met": true,
  • "unmet_tag_suggester_ids": [ ],
  • "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'

Responses

Response samples

Content type
application/json
[
  • 190
]

Upload One or More Assets From URLs

Multiple assets will be created and uploaded using the from_url parameter, comma-delimited. Contribution ID required, which can be created beforehand in the Manage panel. If the Asset filename is not supplied, the content-disposition response header of the URL will be used, e.g. "content-disposition: attachment; filename=the-filename.jpg"

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

URL of file(s) to upload from, comma delimited

contribution_id
integer

Contribution ID, leave black to upload into Default Storage Folder

object

Responses

Request samples

Content type
application/json
{
  • "from_url": "https://picsum.photos/200, https://picsum.photos/300",
  • "contribution_id": 4253,
  • "asset": {
    }
}

Response samples

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

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 samples

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

Collections

Collection resources.

Collections Index

Authorizations:
Authorization
query Parameters
q
string

Search by name

parent_id
integer

Parent Collection ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Collection

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 7714,
  • "created_at": "2024-04-17T16:33:22.113Z",
  • "name": "Test Collection",
  • "description": null,
  • "path_names": [
    ],
  • "path_slugs": [
    ],
  • "slug": "test-collection",
  • "sandbox": false,
  • "organizer": null,
  • "type": "Collection",
  • "has_children": false,
  • "parent_id": 7713,
  • "ancestor_ids": [
    ],
  • "permission_ids": [ ],
  • "visible_assets_count": null,
  • "asset_group_id": 7714,
  • "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,
  • "position": 1,
  • "last_lightroom_sync_at": null,
  • "created_via": null,
  • "created_via_id": null,
  • "reindexing_at": null,
  • "user": {
    },
  • "editable": true,
  • "can_update_assets": true,
  • "permissions": [ ],
  • "workflow_steps": [ ],
  • "enable_toc": false,
  • "toc_copy": null,
  • "toc_contact": null,
  • "enable_poster_image": true,
  • "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 samples

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

Collections Details

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 7620,
  • "created_at": "2024-04-17T16:33:19.312Z",
  • "name": "Paul Klee77",
  • "description": "Iure et iste. Aspernatur ipsum debitis. Facere eius earum.",
  • "path_names": [
    ],
  • "path_slugs": [
    ],
  • "slug": "quia-optio77",
  • "sandbox": false,
  • "organizer": false,
  • "type": "Collection",
  • "has_children": false,
  • "parent_id": null,
  • "ancestor_ids": [ ],
  • "permission_ids": [ ],
  • "visible_assets_count": 0,
  • "asset_group_id": 7620,
  • "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,
  • "position": 58,
  • "last_lightroom_sync_at": null,
  • "created_via": null,
  • "created_via_id": null,
  • "reindexing_at": null,
  • "user": {
    },
  • "editable": true,
  • "can_update_assets": true,
  • "permissions": [ ],
  • "workflow_steps": [ ],
  • "enable_toc": false,
  • "toc_copy": null,
  • "toc_contact": null,
  • "enable_poster_image": true,
  • "poster_image": null,
  • "links": [ ],
  • "asset_group_admins": [ ],
  • "webhooks": [ ]
}

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 samples

Content type
application/json
{
  • "id": 47,
  • "asset_group_id": 7807,
  • "asset_id": 204,
  • "user_id": 2158,
  • "created_at": "2024-04-17T16:33:25.578Z",
  • "updated_at": "2024-04-17T16:33:25.578Z",
  • "approval_id": null,
  • "position": 1,
  • "last_lightroom_sync_at": null,
  • "workflow_step_id": null
}

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

Request samples

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

Response samples

Content type
application/json
{
  • "token": "d863abcac20fa631ee54a79b75d1487c",
  • "filename": "oreillykihn-mediagraph-download-#3.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

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 samples

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

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 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 samples

Content type
application/json
{
  • "name": "Caravaggio98",
  • "sub_type": null,
  • "description": "Rem et non. Magni sapiente doloremque. Sit aliquam aperiam.",
  • "created_at": "2024-04-17T16:33:48.672Z",
  • "organizer": false,
  • "type": "Lightbox",
  • "asset_group_id": 8485,
  • "has_workflow_steps": false,
  • "enable_contribution": false,
  • "project_id": null,
  • "commentable": true,
  • "comments_count": 0,
  • "commentable_id": 8485,
  • "sort_order": null,
  • "share_links_count": 0,
  • "sortable": true,
  • "folder_root_id": 8485,
  • "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,
  • "user": {
    },
  • "slug": "8485-ad-laudantium98",
  • "id": 4430,
  • "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,
  • "total_file_size": 0,
  • "enable_toc": false,
  • "toc_copy": null,
  • "toc_contact": null,
  • "featured": false,
  • "enable_poster_image": true,
  • "poster_image": null,
  • "lightbox_path_slugs": [
    ],
  • "workflow_steps": [ ],
  • "users": [
    ],
  • "links": [ ],
  • "webhooks": [ ]
}

Memberships

Memberships resources. Admin role required.

Memberships Index

Authorizations:
Authorization

Responses

Response samples

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

Membership Details

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 1507,
  • "created_at": "2024-04-17T16:33:57.364Z",
  • "updated_at": "2024-04-17T16:33:57.364Z",
  • "aasm_state": "active",
  • "user_group_ids": [ ],
  • "user": {
    },
  • "role_level": "general",
  • "role_level_name": "General",
  • "initials": "M M",
  • "tester": false,
  • "username": "willow_wisoky",
  • "title": null,
  • "last_login_at": null,
  • "is_owner": false,
  • "otp_required_for_login": null,
  • "email": "[email protected]",
  • "name": "Magen Medhurst",
  • "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

Request samples

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

Response samples

Content type
application/json
{
  • "organization_id": 209,
  • "id": 1523,
  • "user_id": 2459,
  • "invite_id": null,
  • "aasm_state": "active",
  • "created_at": "2024-04-17T16:34:00.130Z",
  • "updated_at": "2024-04-17T16:34:00.255Z",
  • "role_level": "global_library",
  • "username": "palmabailey",
  • "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,
  • "name": "Pinkie Corkery",
  • "initials": "P C",
  • "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 samples

Content type
application/json
{
  • "organization_id": 212,
  • "id": 1539,
  • "user_id": 2483,
  • "invite_id": null,
  • "aasm_state": "deactivated",
  • "created_at": "2024-04-17T16:34:02.831Z",
  • "updated_at": "2024-04-17T16:34:02.955Z",
  • "role_level": "general",
  • "username": "carey",
  • "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,
  • "name": "Monserrate Hirthe",
  • "initials": "M H",
  • "avatar_url": null,
  • "email": "[email protected]",
  • "user_group_ids": [ ]
}

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 samples

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

Organization details.

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

The ID of the Organization

Responses

Response samples

Content type
application/json
{
  • "id": 218,
  • "title": "Christiansen LLC",
  • "domain": null,
  • "slug": "christiansen-llc",
  • "created_at": "2024-04-17T16:34:05.963Z",
  • "updated_at": "2024-04-17T16:34:06.664Z",
  • "logo_url": null,
  • "large_logo_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": "trialing",
  • "custom_pricing": false,
  • "enable_product_info": true,
  • "enable_artwork_or_object": true,
  • "enable_truncated_date_writing": false,
  • "enable_face_tagging": true,
  • "enable_sso": false,
  • "sso_type": null,
  • "encrypt_saml": false,
  • "saml_email_attribute_name": "email",
  • "hide_password_login": false,
  • "stripe_product_code": "workgroup",
  • "invoicing": false,
  • "minimum_usage": null,
  • "stripe_interval": "month",
  • "storage_tier": 0,
  • "cas_server_url": null,
  • "cas_login_url": null,
  • "plan_has_sso": true,
  • "plan_has_group_content_managers": true,
  • "plan_has_multiple_tag_trees": true,
  • "free": false,
  • "trial_ends_at": "2024-05-17T16:34:06.000Z",
  • "locked": false,
  • "view_settings": null,
  • "reindexing": false,
  • "reindexing_started_at": null,
  • "reindexing_eta": null,
  • "enable_ai": true,
  • "enable_rekognition": true,
  • "enable_general_member_auto_tags": false,
  • "auto_tag_confidence_threshold": 80,
  • "enable_nsfw_detection": true,
  • "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": true,
  • "medium_download_size": 1200,
  • "sidebar_settings": [
    ],
  • "inactivity_timeout_minutes": 1440,
  • "sso_token": "e254dbf8a721fa1b4ac7105bb3081a34",
  • "user": {
    },
  • "default_asset_modal_layout": "vertical",
  • "featured_collections": [ ],
  • "role_level": "admin",
  • "role_level_name": "Admin",
  • "is_owner": true,
  • "stripe_details": null,
  • "billing_email": null,
  • "stripe_coupon": null,
  • "stripe_customer_id": "test_cus_29",
  • "stripe_subscription_id": "test_su_30",
  • "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,
  • "sidebar_items": [
    ],
  • "public_collections": [ ],
  • "banner_assets": [ ]
}

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 samples

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

Create Storage Folder

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 9621,
  • "created_at": "2024-04-17T16:34:23.545Z",
  • "name": "Test Folder",
  • "description": null,
  • "slug": "test-folder",
  • "organizer": null,
  • "type": "StorageFolder",
  • "sub_type": null,
  • "has_children": false,
  • "path_names": [
    ],
  • "parent_id": 9620,
  • "ancestor_ids": [
    ],
  • "visible_assets_count": null,
  • "path_slugs": [
    ],
  • "asset_group_id": 9621,
  • "has_workflow_steps": false,
  • "contribution_id": 5674,
  • "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,
  • "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

Responses

Response samples

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

Storage Folder Asset IDs

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
[
  • 209,
  • 210
]

Storage Folder Details

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 9527,
  • "created_at": "2024-04-17T16:34:20.819Z",
  • "name": "Joan Miro108",
  • "description": "Corporis et soluta. Occaecati tempora maiores. Molestiae natus sapiente.",
  • "slug": "facilis-modi108",
  • "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": 9527,
  • "has_workflow_steps": false,
  • "contribution_id": 5621,
  • "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,
  • "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

Request samples

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

Response samples

Content type
application/json
{
  • "id": 9714,
  • "created_at": "2024-04-17T16:34:26.330Z",
  • "name": "Test Folder Edit",
  • "description": "Quidem occaecati blanditiis. Dolores ut aut. Corrupti aut occaecati.",
  • "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": 9714,
  • "has_workflow_steps": false,
  • "contribution_id": 5726,
  • "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,
  • "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 samples

Content type
application/json
{ }

Tags

Tag resources.

Tags Index

Authorizations:
Authorization
query Parameters
q
string

Search query

page
integer

Page

Responses

Response samples

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

Create Tag

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 53,
  • "name": "New Tag",
  • "list": "visible",
  • "created_at": "2024-04-17T16:34:37.214Z",
  • "sub_type": "keyword",
  • "user": {
    },
  • "in_taxonomy": false,
  • "taxonomy_path_names": [ ]
}

Tag Details

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "tag_id": 51,
  • "id": 51,
  • "list": "searchable",
  • "name": "nwugfqqjsh",
  • "created_at": "2024-04-17T16:34:34.584Z",
  • "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,
  • "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

Request samples

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

Response samples

Content type
application/json
{
  • "id": 54,
  • "name": "New Tag Edit",
  • "description": null,
  • "link": null,
  • "user_id": 2804,
  • "list": "searchable",
  • "content": null,
  • "created_at": "2024-04-17T16:34:39.699Z",
  • "updated_at": "2024-04-17T16:34:39.707Z",
  • "taxonomy_names": [ ],
  • "tag_id": 54,
  • "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,
  • "in_taxonomy": false,
  • "editable": true,
  • "set_synonym_at": null,
  • "set_synonym_by_id": null
}

Delete tag

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{ }

Taxonomies

Taxonomy resources.

Taxonomies Index

Authorizations:
Authorization

Responses

Response samples

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

Create Taxonomy

Authorizations:
Authorization
Request Body schema: application/json
object

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 278,
  • "organization_id": 263,
  • "name": "Main Taxonomy",
  • "description": null,
  • "user_id": 2879,
  • "created_at": "2024-04-17T16:34:50.474Z",
  • "updated_at": "2024-04-17T16:34:50.474Z",
  • "user": {
    },
  • "user_group_ids": [ ],
  • "taxonomy_tag_roots": [ ],
  • "editable": true,
  • "user_groups": [ ]
}

Taxonomy Details

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 273,
  • "organization_id": 260,
  • "name": "sint",
  • "description": null,
  • "user_id": 2878,
  • "created_at": "2024-04-17T16:34:47.572Z",
  • "updated_at": "2024-04-17T16:34:47.572Z",
  • "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

Request samples

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

Response samples

Content type
application/json
{
  • "id": 282,
  • "organization_id": 266,
  • "name": "Main Taxonomy Edit",
  • "description": null,
  • "user_id": 2926,
  • "created_at": "2024-04-17T16:34:53.025Z",
  • "updated_at": "2024-04-17T16:34:53.036Z",
  • "user": {
    },
  • "user_group_ids": [ ],
  • "taxonomy_tag_roots": [ ],
  • "editable": true,
  • "user_groups": [ ]
}

Delete Taxonomy

Authorizations:
Authorization
path Parameters
id
required
integer

Responses

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

page
integer

Page

Responses

Response samples

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

Create Taxonomy Tag

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

Taxonomy ID

object

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 21,
  • "organization_id": 281,
  • "created_at": "2024-04-17T16:35:06.773Z",
  • "has_children": false,
  • "ancestor_ids": [
    ],
  • "parent_id": 20,
  • "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",
  • "poster_image_guid": null,
  • "thumb_url": null,
  • "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

page
integer

Page

Responses

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 samples

Content type
application/json
{
  • "id": 19,
  • "organization_id": 278,
  • "created_at": "2024-04-17T16:35:04.120Z",
  • "has_children": false,
  • "ancestor_ids": [ ],
  • "parent_id": null,
  • "name": "jlcfdoaeml",
  • "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",
  • "poster_image_guid": null,
  • "thumb_url": null,
  • "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

Request samples

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

Response samples

Content type
application/json
{
  • "id": 22,
  • "organization_id": 284,
  • "created_at": "2024-04-17T16:35:09.417Z",
  • "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",
  • "poster_image_guid": null,
  • "thumb_url": null,
  • "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 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

Request samples

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

Response samples

Content type
application/json
{
  • "id": 209,
  • "user_id": 3111,
  • "guid": "d9347934",
  • "name": "Test Upload",
  • "note": "API docs upload test",
  • "aasm_state": null,
  • "created_at": "2024-04-17T16:35:15.039Z",
  • "updated_at": "2024-04-17T16:35:15.039Z",
  • "assets_count": 0,
  • "tag_names": [ ],
  • "default_rights_package_id": null,
  • "done": false,
  • "done_at": null,
  • "standalone": true,
  • "contribution_id": 6599,
  • "all_requirements_met": false,
  • "tag_suggesters_met": true,
  • "rights_packages_met": true,
  • "creator_tags_met": true,
  • "unmet_tag_suggester_ids": [ ],
  • "contribution": {
    },
  • "tag_suggesters": [ ],
  • "aws_key": "AKIAIZNM36WWPGMCYN4Q",
  • "bucket": "tandemvault-asset-uploads-development",
  • "user": {
    },
  • "ftp_username": "[email protected]",
  • "ftp_password": "531cc818",
  • "ftp_url": "sftp://carmelo.johnston%40lubowitz-heidenreich.biz:[email protected]/mediagraph-ftp-dev-2/290/584b7c6d"
}

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

Request samples

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

Response samples

Content type
application/json
{
  • "id": 211,
  • "filename": "test.jpg",
  • "file_size": 10000,
  • "guid": "39cd27e3-6207-4e95-b2b7-36d636b4ab82",
  • "short_guid": "39cd27e3",
  • "type": "Image",
  • "ext": "jpg",
  • "duration": null,
  • "md5": null,
  • "mime_type": "image/jpeg",
  • "thumb_url": null,
  • "grid_url": null,
  • "small_url": null,
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "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,
  • "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": 210,
  • "user_id": 3135,
  • "aasm_state": "pending",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2024-04-17T16:35:18.010Z",
  • "updated_at": "2024-04-17T16:35:18.029Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "293/134aa9b7/39cd27e3-6207-4e95-b2b7-36d636b4ab82-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,
  • "downloads_count": 0,
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": null,
  • "rekognition_labels_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "pending",
  • "faces_searched_at": null,
  • "creator_tag": null,
  • "storage_folder_path": "consectetur-aspernatur113",
  • "tags": [ ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": 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,
  • "product_in_image": null,
  • "artwork_or_object": null,
  • "user": {
    },
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "moderation_labels": null,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "rekognition_faces": null,
  • "ignored_face_ids": null,
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": null,
  • "custom_meta_values": [ ],
  • "full_url": null,
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "upload": {
    },
  • "all_requirements_met": true,
  • "tag_suggesters_met": true,
  • "rights_package_met": true,
  • "creator_tag_met": true,
  • "unmet_tag_suggester_ids": [ ],
  • "signed_upload_url": "https://tandemvault-asset-uploads-development.s3.amazonaws.com/293/134aa9b7/39cd27e3-6207-4e95-b2b7-36d636b4ab82-test.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIZNM36WWPGMCYN4Q%2F20240417%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240417T163518Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=758bb4e521feb000abc62d04604368b088df2f91ef2125a3f3c92ff04fb67529",
  • "collective_work_ids": [ ]
}

Set Asset Upload Complete

Call once the data has been fully uploaded to S3; this will start background processing of the Asset.

Authorizations:
Authorization
path Parameters
guid
required
string

The Asset GUID

query Parameters
skip_meta
boolean

Do not set description, tags, location, captured, by the new metadata. Useful when adding a new version.

Responses

Response samples

Content type
application/json
{
  • "id": 212,
  • "filename": "alias.js",
  • "file_size": null,
  • "guid": "57aa0dd8-ba4c-4d12-ac66-3d5bc4ff6a11",
  • "short_guid": "57aa0dd8",
  • "type": "Document",
  • "ext": "js",
  • "duration": null,
  • "md5": null,
  • "mime_type": "text/javascript",
  • "thumb_url": null,
  • "grid_url": null,
  • "small_url": null,
  • "description": null,
  • "width": null,
  • "height": null,
  • "ppi": null,
  • "downloadable": true,
  • "original_downloadable": true,
  • "editable": true,
  • "manageable": true,
  • "rights_editable": true,
  • "rights_manageable": true,
  • "taggable": true,
  • "description_editable": true,
  • "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": "Document",
  • "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,
  • "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": 211,
  • "user_id": 3160,
  • "aasm_state": "uploaded",
  • "processing_finished_at": null,
  • "processing_error": null,
  • "processing_progress": null,
  • "file_type": null,
  • "created_at": "2024-04-17T16:35:21.144Z",
  • "updated_at": "2024-04-17T16:35:21.157Z",
  • "s3_upload_id": null,
  • "s3_upload_key": "296/a0c3137b/57aa0dd8-ba4c-4d12-ac66-3d5bc4ff6a11-alias.js",
  • "time_to_process": null,
  • "captured_at": "2024-04-16T16:35:21.141Z",
  • "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": null,
  • "downloads_count": 0,
  • "latitude": null,
  • "longitude": null,
  • "optimization_requested_at": null,
  • "optimization_completed_at": null,
  • "trashed_at": null,
  • "last_external_sync_at": null,
  • "rekognition_labels_retrieved_at": null,
  • "rekognition_faces_requested_at": null,
  • "rekognition_faces_retrieved_at": null,
  • "face_indexing_state": "pending",
  • "faces_searched_at": null,
  • "creator_tag": null,
  • "storage_folder_path": "quod_ipsum114",
  • "tags": [ ],
  • "aspect": null,
  • "transcript": null,
  • "transcript_version": null,
  • "vtt_url": null,
  • "transcript_output_json_url": null,
  • "has_ocr_content": 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,
  • "product_in_image": null,
  • "artwork_or_object": null,
  • "user": {
    },
  • "data_versions_count": 1,
  • "trashed_by": null,
  • "creator_contact_info": null,
  • "auto_tags_count": 0,
  • "moderation_labels": null,
  • "checked_in_at": null,
  • "checkout_integration": null,
  • "rekognition_faces": null,
  • "ignored_face_ids": null,
  • "pdf_url": false,
  • "meta_structs": [ ],
  • "links": [ ],
  • "permalink_url": null,
  • "custom_meta_values": [ ],
  • "full_url": null,
  • "download_sizes": [
    ],
  • "storage_folder": {
    },
  • "collections": [ ],
  • "lightboxes": [ ],
  • "available_rights_packages": [
    ],
  • "upload": {
    },
  • "all_requirements_met": true,
  • "tag_suggesters_met": true,
  • "rights_package_met": true,
  • "creator_tag_met": true,
  • "unmet_tag_suggester_ids": [ ],
  • "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 samples

Content type
application/json
{
  • "id": 212,
  • "assets_count": 1,
  • "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

Request samples

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

Response samples

Content type
application/json
{
  • "id": 213,
  • "user_id": 3212,
  • "guid": "a6e21ff1",
  • "name": "Test Upload",
  • "note": "API docs upload test",
  • "aasm_state": null,
  • "created_at": "2024-04-17T16:35:27.655Z",
  • "updated_at": "2024-04-17T16:35:27.655Z",
  • "assets_count": 0,
  • "tag_names": [ ],
  • "default_rights_package_id": null,
  • "done": false,
  • "done_at": null,
  • "standalone": false,
  • "contribution_id": 6759,
  • "all_requirements_met": false,
  • "tag_suggesters_met": true,
  • "rights_packages_met": true,
  • "creator_tags_met": true,
  • "unmet_tag_suggester_ids": [ ],
  • "contribution": {
    },
  • "tag_suggesters": [ ],
  • "aws_key": "AKIAIZNM36WWPGMCYN4Q",
  • "bucket": "tandemvault-asset-uploads-development",
  • "user": {
    },
  • "ftp_username": "[email protected]",
  • "ftp_password": "76b10f27",
  • "ftp_url": "sftp://myrta_hodkiewicz%40johnston.biz:[email protected]/mediagraph-ftp-dev-2/302/4bfd7b0f"
}

Current User

Who Am I

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

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
{
  • "id": 3235,
  • "first_name": "Chasidy",
  • "last_name": "Prosacco",
  • "default_username": "stacey",
  • "email": "[email protected]",
  • "confirmed_at": "2024-04-17T16:35:28.022Z",
  • "created_at": "2024-04-17T16:35:28.024Z",
  • "otp_required_for_login": null,
  • "can_create_orgs": false,
  • "timezone": null,
  • "guest": null,
  • "guest_email": null,
  • "lang": null,
  • "enable_lightroom": true,
  • "avatar_url": null,
  • "name": "Chasidy Prosacco",
  • "initials": "C P",
  • "user_group_ids": [ ],
  • "last_organization": null,
  • "username": null,
  • "title": null,
  • "user_id": 3235,
  • "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 samples

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