Skip to main content
POST
/
assets
/
Upload an asset from URL
curl --request POST \
  --url https://api.journeybee.io/v1/assets/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "file_name": "<string>",
  "description": "<string>"
}
'
{
  "uuid": "<string>",
  "file_name": "<string>",
  "file_url": "<string>",
  "mime_type": "<string>",
  "size": 123,
  "width": 123,
  "height": 123,
  "resource_type": "<string>",
  "description": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json
​
url
string<uri>
required

Public URL of the file to upload. The file will be fetched and stored in Journeybee's CDN.

Maximum string length: 2000
​
category
enum<string>
required

Asset category: 'resource' for use in resources and certifications, 'room' for use in rooms and partner portal

Available options:
resource,
room
​
file_name
string

Override the file name. If not provided, the original filename is used.

Maximum string length: 500
​
description
string

Description of the asset

Maximum string length: 2000
​
resource_type
enum<string>

Resource visibility type. Only used when category is 'resource'. Defaults to 'partner'.

Available options:
partner,
internal,
campaigns

Response

201 - application/json

Default Response

​
uuid
string
required
​
file_name
string | null
required
​
file_url
string | null
required
​
mime_type
string | null
required
​
size
number | null
required
​
width
number | null
required
​
height
number | null
required
​
category
enum<string>
required

Asset category

Available options:
resource,
room
​
resource_type
string | null
required
​
description
string | null
required
​
created_at
string
required
​
updated_at
string
required