Sites & Organisation

Media

A Media represents a file uploaded to Trybe.

The Media object

Attributes

iduuidrequired
Unique identifier of the uploaded media item, returned from createMedia. Pass this ID into any field that accepts a media reference (logos, hero images, product images, etc.).
file_namestringrequired
Original filename of the uploaded asset, preserved as provided at upload time. Used for display in the media library and as a hint when serving downloads.
mime_typestringrequired
The mime type of the media item.
original_urlstringrequired
The url of the media resource.
sizeintegerrequired
The size of the media item in bytes.
urlstringrequired
The url of the converted media resource.

{
  "id": "00000000-0000-0000-0000-000000000000",
  "file_name": "super-cool-photo.jpg",
  "mime_type": "image/jpeg",
  "original_url": "https://example.com/media/super-cool-photo.jpg",
  "size": 84256,
  "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
}

post/shop/media

Stores a media object

createMedia

Uploads some Media and returns a Media object.

Request body

filebinaryoptional
The binary of the uploaded asset.
imagebinaryoptional
The binary of the uploaded asset.
organisation_iduuidoptional
Identifier of the organisation to upload this media item against. Media is scoped per organisation so each customer's library is isolated. The caller's API key must have access to this organisation.
collectionstringoptional
The collection which this media should be categorised under.
Possible values:library

Responses

200
The media was successfully uploaded.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/media" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: multipart/form-data"

const response = await fetch('https://api.playground.try.be/shop/media', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'multipart/form-data',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/media",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "multipart/form-data",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/media', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'multipart/form-data',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/media", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "multipart/form-data")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The media was successfully uploaded.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "file_name": "super-cool-photo.jpg",
    "mime_type": "image/jpeg",
    "original_url": "https://example.com/media/super-cool-photo.jpg",
    "size": 84256,
    "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/media/{mediaId}

Retrieve a media object

getMedia

Retrieves details about the given Media object

Path parameters

mediaIduuidrequired
The ID of the Media resource

Responses

200
The media was successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/media/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/media/00000000-0000-0000-0000-000000000000', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/media/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/media/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/media/00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The media was successfully retrieved

{
  "id": "00000000-0000-0000-0000-000000000000",
  "file_name": "super-cool-photo.jpg",
  "mime_type": "image/jpeg",
  "original_url": "https://example.com/media/super-cool-photo.jpg",
  "size": 84256,
  "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}