tebarDocs
GuideDevelopersAPI ReferenceChangelog
Media

Update a media file

PATCH
/v1/media/{id}

Alt text, and whether it stays in the library.

Requires the write scope.

Authorization

bearer
headerAuthorizationBearer <token>

An API key (tb_live_...) from the dashboard, or an OAuth access token.

Path Parameters

id*string
Formatuuid

Header Parameters

Tebar-Profile?string

Limits an owner key to one profile (id or external_id). Unknown: 404 profile_not_found.

Request Body

application/json
  1. body
alt_text?|null
keep?boolean

Response Body

The media.

application/json
  1. response
id*string
Formatuuid
profile_id*string
Formatuuid
type*string
Value in"image""video"
mime_type*string
size_bytes*integer|null
width*|

Display width (video rotation applied).

height*integer|null
duration_ms*integer|null
frame_rate*|

Average frames per second of a video.

status*string
Value in"pending""ready""failed""expired"
public_url*string|null
poster_url*|

Videos: a small JPEG still, ready shortly after upload.

alt_text*string|null
keep*boolean

Kept in the media library. Otherwise removed 30 days after the last post using it finished, or 7 days after upload if unused.

created_at*string
Formatdate-time
Example Request
curl -X PATCH 'https://api.tebar.app/v1/media/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
  "type": "image",
  "mime_type": "string",
  "size_bytes": 0,
  "width": 0,
  "height": 0,
  "duration_ms": 0,
  "frame_rate": 0,
  "status": "pending",
  "public_url": "string",
  "poster_url": "string",
  "alt_text": "string",
  "keep": true,
  "created_at": "2019-08-24T14:15:22Z"
}

Get a media file GET

Requires the read scope.

Delete a media file DELETE

Used by an unfinished post (draft, scheduled, publishing): 409 media_in_use. Used by finished posts: the file is removed and the media becomes expired. Requires the write scope.