This document provides a general description of Media Pocket API. Please setup API keys in UI under your profile settings. In case of problems email support@mediapocket.io
Resource | Description |
---|---|
POST /api/v2/admin/field_groups | Create field group |
POST /api/v2/admin/field_groups/:field_group_id | Update field group |
POST /api/v2/admin/field_groups/:field_group_id/fields | Add field to field group |
DELETE /api/v2/admin/field_groups/:field_group_id | Delete field group |
DELETE /api/v2/admin/field_groups/:field_group_id/fields/:field_id | Delete field from field group |
POST /api/v2/admin/field_groups/:field_group_id/fields/:field_id | Update field |
Resource | Description |
---|---|
POST /api/v2/admin/publishing_channels/aspera | Create aspera publishing channel |
POST /api/v2/admin/publishing_channels/ftp | Create FTP publishing channel |
POST /api/v2/admin/publishing_channels/scp | Create SCP publishing channel |
POST /api/v2/admin/publishing_channels/vimeo | Create Vimeo publishing channel |
POST /api/v2/admin/publishing_channels/youtube | Create Youtube publishing channel |
POST /api/v2/admin/publishing_channels/aws_s3 | Create AWS S3 publishing channel |
POST /api/v2/admin/publishing_channels/:publishing_channel_id | Update publishing channel |
DELETE /api/v2/admin/publishing_channels/:publishing_channel_id | Delete publishing channel |
Resource | Description |
---|---|
GET /api/v2/assets/:asset_id | Get asset |
GET /api/v2/assets/:asset_id/file_metadata | Get file metadata for assets original file. Includes EXIF/IPTC/XMP metadata and mediainfo. |
GET /api/v2/assets/:asset_id/media | Get asset media and download URLs |
POST /api/v2/assets/:asset_id/media | Add media to asset |
POST /api/v2/assets | Create asset |
PUT /api/v2/assets/:asset_id | Update asset |
POST /api/v2/assets/:asset_id/trash_bin | Move asset to trash bin from where it will be deleted after 14 days |
POST /api/v2/assets/:asset_id/restore | Restores asset from trash bin |
DELETE /api/v2/assets/:asset_id | Permanently delete asset |
POST /api/v2/assets/:asset_id/assign | Assign asset to project |
DELETE /api/v2/assets/:asset_id/unassign | Unassign asset from project |
DELETE /api/v2/assets/:asset_id/media | Remove media from asset |
Resource | Description |
---|---|
GET /api/v2/assets/:asset_id/attachments | Get attachments for an asset |
POST /api/v2/assets/:asset_id/attachments | Create attachment for an asset |
GET /api/v2/projects/:project_id/attachments | Get attachments for project |
POST /api/v2/projects/:project_id/attachments | Create attachment for a project |
Resource | Description |
---|---|
GET /api/v2/assets/:asset_id/comments | Get comments for asset |
POST /api/v2/assets/:asset_id/comments | Create comment for asset |
DELETE /api/v2/assets/:asset_id/comments/:comment_id | Delete comment from asset |
POST /api/v2/assets/:asset_id/comments/:comment_id | Update comment for asset |
GET /api/v2/projects/:project_id/comments | Get comments for project |
POST /api/v2/projects/:project_id/comments | Create comment for project |
DELETE /api/v2/projects/:project_id/comments/:comment_id | Delete comment from project |
POST /api/v2/projects/:project_id/comments/:comment_id | Update comment for project |
Resource | Description |
---|---|
GET /api/v2/assets/:asset_id/custom_fields | Returns custom fields for asset |
POST /api/v2/assets/:asset_id/custom_fields/:field_group_id | Update field group for asset, Including fields |
DELETE /api/v2/assets/:asset_id/custom_fields/:field_group_id | Remove field group from asset |
DELETE /api/v2/assets/:asset_id/custom_fields/:field_group_id/:complex_field_group_id | Delete complex field group from asset |
GET /api/v2/projects/:project_id/custom_fields | Returns custom fields for project |
POST /api/v2/projects/:project_id/custom_fields/:field_group_id | Update field group for project, Including fields |
DELETE /api/v2/projects/:project_id/custom_fields/:field_group_id | Remove field group from project |
DELETE /api/v2/projects/:project_id/custom_fields/:field_group_id/:complex_field_group_id | Delete complex field group from project |
Resource | Description |
---|---|
GET /api/v2/external_ids/:external_id | Get asset or project by external ID |
GET /api/v2/external_ids | Get all assets and projects which contain external ID |
Resource | Description |
---|---|
GET /api/v2/field_groups | Get all field groups |
GET /api/v2/field_groups/:field_group_id | Get field group by id |
Resource | Description |
---|---|
GET /api/v2/assets/:asset_id/history | Get asset history |
GET /api/v2/projects/:project_id/history | Get project history |
GET /api/v2/assets/history | Get all assets history in a given timeframe |
GET /api/v2/projects/history | Get all projects history in a given timeframe |
GET /api/v2/history | Get all events in a given timeframe |
Resource | Description |
---|---|
GET /api/v2/assets/:asset_id/image_crops | Get image asset crops |
POST /api/v2/assets/:asset_id/image_crops | Create new image asset crop |
POST /api/v2/assets/:asset_id/image_crops/:image_crop_id | Update image asset crop |
DELETE /api/v2/assets/:asset_id/image_crops/:image_crop_id | Delete image asset crop |
Resource | Description |
---|---|
GET /api/v2/health | Check health of all services |
GET /api/v2/ping | Ping service |
Resource | Description |
---|---|
GET /api/v2/plugins | Get all plugins |
Resource | Description |
---|---|
GET /api/v2/projects | List project IDs for current user |
GET /api/v2/projects/:project_id | Get project |
GET /api/v2/projects/:project_id/members | Get project members |
POST /api/v2/projects/:project_id/members | Add user to project |
DELETE /api/v2/projects/:project_id/members | Remove user from project |
GET /api/v2/projects/:project_id/assets | Get assets and subproject for a project |
POST /api/v2/projects | Create project |
PUT /api/v2/projects/:project_id | Update project |
POST /api/v2/projects/:project_id/trash_bin | Move project and all related projects and assets to trash bin from where it will be deleted after 14 days |
POST /api/v2/projects/:project_id/restore | Restores project and all related projects and assets from trash bin |
DELETE /api/v2/projects/:project_id | Permanently delete project and all related projects and assets |
POST /api/v2/projects/:project_id/assign | Assign subproject to project |
DELETE /api/v2/projects/:project_id/unassign | Unassign subproject from project |
GET /api/v2/projects/:project_id/tags | Get tags and ai tags for project including all subprojects and assets |
PUT /api/v2/projects/:project_id/thumbnail | Set project thumbnail |
DELETE /api/v2/projects/:project_id/thumbnail | Delete project thumbnail |
Resource | Description |
---|---|
GET /api/v2/publishing_channels | Returns publishing channels for current user |
POST /api/v2/publishing_channels/:publishing_channel_id/share | Share to publishing channel |
Resource | Description |
---|---|
POST /api/v2/assets/:asset_id/review/approve | Set assets status to approved |
POST /api/v2/assets/:asset_id/review/reject | Set assets status to rejected |
POST /api/v2/assets/:asset_id/review | Set assets status to review |
Resource | Description |
---|---|
GET /api/v2/search | Search assets and projects |
Resource | Description |
---|---|
GET /api/v2/settings | Get settings |