Skip to content

Instantly share code, notes, and snippets.

@kylenstone

kylenstone/oas3-latest.json

Created October 21, 2020 01:59
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save kylenstone/d7c43322643220901f25c5a80698faea to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save kylenstone/d7c43322643220901f25c5a80698faea to your computer and use it in GitHub Desktop.
Download ZIP
oas3-latest
Raw
oas3-latest.json
{
"components": {
"requestBodies": {
"ActionRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"allow_collaborators": {
"default": false,
"type": "boolean"
},
"description": {
"description": "Description of the custom Action",
"type": "string"
},
"event": {
"description": "Arbitrary event name to include in custom Action webhook payloads",
"type": "string"
},
"include": {
"description": "Any associations to include in the response",
"type": "string"
},
"name": {
"description": "Name of the custom Action",
"type": "string"
},
"url": {
"description": "HTTPS endpoint to deliver Action events to",
"type": "string"
}
},
"required": [
"url",
"name",
"event",
"description"
],
"type": "object"
}
}
},
"description": "Action to create or update"
},
"AssetCopyRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "Identifier of the asset to be copied",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
}
},
"description": "Asset copy request"
},
"AssetCreateRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"description": {
"description": "Brief description of the Asset",
"type": "string"
},
"filesize": {
"description": "The file size in bytes",
"type": "integer"
},
"filetype": {
"type": "string"
},
"name": {
"description": "Name of the Asset",
"type": "string"
},
"properties": {
"description": "Custom key-value data",
"type": "object"
},
"source": {
"$ref": "#/components/schemas/AssetSource"
},
"type": {
"enum": [
"file",
"folder"
],
"type": "string"
}
},
"required": [
"type",
"name",
"filesize"
],
"type": "object"
}
}
},
"description": "Asset to create"
},
"AssetSearchRequest": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssetSearch"
}
}
},
"description": "Asset search"
},
"AssetUpdateRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"description": {
"description": "Brief description of the Asset",
"type": "string"
},
"name": {
"description": "Name of the Asset",
"type": "string"
},
"properties": {
"description": "Custom key-value data",
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
}
}
},
"description": "Asset to update"
},
"BatchAssetCopyRequest": {
"content": {
"application/json": {
"examples": {
"batch_copy_asset_example": {
"value": {
"batch": [
{
"id": 1
},
{
"id": 2
}
],
"copy_comments": "none"
}
}
},
"schema": {
"properties": {
"batch": {
"items": {
"properties": {
"id": {
"description": "Identifier of an asset to be copied",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"copy_comments": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "An array of batch operations"
},
"BatchCollaboratorCreateRequest": {
"content": {
"application/json": {
"examples": {
"request_with_default_message": {
"value": {
"batch": [
{
"message": "Please review this!",
"user_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
},
{
"user_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
{
"user_group_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"email": "[email protected]"
}
],
"default_message": "Welcome!"
}
},
"request_without_default_message": {
"value": {
"batch": [
{
"message": "Please review this!",
"user_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
},
{
"user_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
{
"user_group_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"email": "[email protected]"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/BatchInviteParams"
}
}
},
"description": "An array of batch operations"
},
"CollaboratorRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"email": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Collaborator to create or update"
},
"CommentRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"annotation": {
"description": "Serialized list of geometry and/or drawing data.",
"type": "string"
},
"page": {
"description": "Page number for a comment (documents only).",
"type": "integer"
},
"pitch": {
"description": "Pitch measurement for the comment (360deg video only).",
"type": "integer"
},
"text": {
"description": "The body of the comment.",
"type": "string"
},
"timestamp": {
"description": "Timestamp for the comment, in frames.",
"type": "integer"
},
"yaw": {
"description": "Yaw measurement for the comment (360deg video only).",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Comment to create or update"
},
"LibrarySearchRequest": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LibrarySearch"
}
}
},
"description": "Advanced asset search"
},
"PresentationCreateRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"access_control": {
"$ref": "#/components/schemas/ShareableEntityAccessControl"
},
"asset_id": {
"format": "uuid",
"type": "string"
},
"autoplay": {
"type": "boolean"
},
"background_color": {
"type": "string"
},
"can_download": {
"type": "boolean"
},
"color": {
"type": "string"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"expires_at": {
"format": "date-time",
"type": "string"
},
"format": {
"type": "string"
},
"include_ext": {
"type": "boolean"
},
"include_upload_date": {
"type": "boolean"
},
"layout": {
"enum": [
"blog",
"reel"
],
"type": "string"
},
"name": {
"type": "string"
},
"owner_id": {
"format": "uuid",
"type": "string"
},
"password": {
"type": "string"
},
"project_id": {
"format": "uuid",
"type": "string"
},
"secure": {
"type": "boolean"
},
"style": {
"type": "string"
},
"text_color": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"project_id",
"owner_id",
"asset_id"
],
"type": "object"
}
}
},
"description": "Presentation to create"
},
"PresentationUpdateRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"access_control": {
"$ref": "#/components/schemas/ShareableEntityAccessControl"
},
"asset_id": {
"format": "uuid",
"type": "string"
},
"autoplay": {
"type": "boolean"
},
"background_color": {
"type": "string"
},
"can_download": {
"type": "boolean"
},
"color": {
"type": "string"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"expires_at": {
"format": "date-time",
"type": "string"
},
"format": {
"type": "string"
},
"include_ext": {
"type": "boolean"
},
"include_upload_date": {
"type": "boolean"
},
"layout": {
"enum": [
"blog",
"reel"
],
"type": "string"
},
"name": {
"type": "string"
},
"owner_id": {
"format": "uuid",
"type": "string"
},
"password": {
"type": "string"
},
"project_id": {
"format": "uuid",
"type": "string"
},
"secure": {
"type": "boolean"
},
"style": {
"type": "string"
},
"text_color": {
"type": "string"
},
"title": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Presentation to update"
},
"ProjectRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"name": {
"description": "Project name",
"type": "string"
},
"private": {
"description": "If true, the project is private to the creating user",
"type": "boolean"
},
"project_preferences": {
"$ref": "#/components/schemas/ProjectPreferences"
}
},
"type": "object"
}
}
},
"description": "Project to create or update"
},
"ReviewLinkCreateRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"access_control": {
"$ref": "#/components/schemas/ShareableEntityAccessControl"
},
"allow_approvals": {
"type": "boolean"
},
"current_version_only": {
"type": "boolean"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"enable_downloading": {
"type": "boolean"
},
"expires_at": {
"format": "date-time",
"type": "string"
},
"is_active": {
"type": "boolean"
},
"name": {
"type": "string"
},
"notify_on_view": {
"type": "boolean"
},
"owner_id": {
"format": "uuid",
"type": "string"
},
"password": {
"type": "string"
},
"project_id": {
"format": "uuid",
"type": "string"
},
"secure": {
"type": "boolean"
},
"view_count": {
"type": "integer"
}
},
"required": [
"project_id",
"owner_id",
"name"
],
"type": "object"
}
}
},
"description": "ReviewLink to create"
},
"ReviewLinkItemCreateRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"asset_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "ReviewLinkItem to create"
},
"ReviewLinkUpdateRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"access_control": {
"$ref": "#/components/schemas/ShareableEntityAccessControl"
},
"allow_approvals": {
"type": "boolean"
},
"current_version_only": {
"type": "boolean"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"enable_downloading": {
"type": "boolean"
},
"expires_at": {
"format": "date-time",
"type": "string"
},
"is_active": {
"type": "boolean"
},
"name": {
"type": "string"
},
"notify_on_view": {
"type": "boolean"
},
"owner_id": {
"format": "uuid",
"type": "string"
},
"password": {
"type": "string"
},
"project_id": {
"format": "uuid",
"type": "string"
},
"secure": {
"type": "boolean"
},
"view_count": {
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "ReviewLink to update"
},
"TeamMemberRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"email": {
"type": "string"
},
"role": {
"default": "member",
"enum": [
"member",
"team_manager"
],
"type": "string"
},
"user_id": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Team member to create or update"
},
"TeamRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"access": {
"enum": [
"private",
"public",
"restricted"
],
"type": "string"
},
"account_id": {
"format": "uuid",
"type": "string"
},
"admin_only_actions": {
"$ref": "#/components/schemas/AdminOnlyAction"
},
"background_color": {
"type": "string"
},
"bio": {
"type": "string"
},
"color": {
"type": "string"
},
"colors": {
"items": {
"type": "string"
},
"type": "array"
},
"dark_theme": {
"default": false,
"type": "boolean"
},
"default_session_watermark_template_id": {
"format": "uuid",
"type": "string"
},
"email_branding": {
"$ref": "#/components/schemas/EmailBranding"
},
"font_color": {
"type": "string"
},
"image": {
"$ref": "#/components/schemas/Image"
},
"link": {
"type": "string"
},
"location": {
"type": "string"
},
"member_limit": {
"type": "integer"
},
"name": {
"type": "string"
},
"slack_webhook": {
"type": "object"
},
"solo": {
"default": false,
"type": "boolean"
},
"storage_limit": {
"type": "integer"
},
"watermark": {
"$ref": "#/components/schemas/Watermark"
}
},
"type": "object"
}
}
},
"description": "Team create or update request"
},
"WebhookRequest": {
"content": {
"application/json": {
"schema": {
"properties": {
"events": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Name of the Webhook",
"type": "string"
},
"url": {
"description": "HTTPS endpoint to delivery events to",
"type": "string"
}
},
"required": [
"url",
"name"
],
"type": "object"
}
}
},
"description": "Webhook to create or update"
}
},
"responses": {
"BatchCollaboratorCreateResponse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"error": {
"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa": "Something went wrong!"
},
"success": {
"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb": {
"_type": "collaborator"
},
"[email protected]": {
"_type": "pending_collaborator"
}
}
}
}
},
"schema": {
"properties": {
"error": {
"type": "object"
},
"success": {
"properties": {
"uuid_or_email": {
"oneOf": [
{
"$ref": "#/components/schemas/Collaborator"
},
{
"$ref": "#/components/schemas/PendingCollaborator"
}
]
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"description": "Batch create success response"
},
"ReviewLinkItemsResponse": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ReviewLinkItem"
},
"type": "array"
}
}
},
"description": "ReviewLinkItems success response",
"headers": {
"link": {
"description": "Pagination links",
"schema": {
"type": "string"
}
},
"page-number": {
"description": "Current page of results",
"schema": {
"type": "integer"
}
},
"per-page": {
"description": "Number of entries per page",
"schema": {
"type": "integer"
}
},
"total": {
"description": "Total entries across all pages",
"schema": {
"type": "integer"
}
},
"total-pages": {
"description": "Number of pages",
"schema": {
"type": "integer"
}
}
}
},
"TeamMemberResonse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"role": "team_manager",
"user_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
}
},
"schema": {
"properties": {
"role": {
"type": "string"
},
"user_id": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Team member success response"
},
"InstallationResponse": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Installation"
}
}
},
"description": "Installation success response"
},
"PresentationsResponse": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/Presentation"
},
"type": "array"
}
}
},
"description": "Presentations success response",
"headers": {
"link": {
"description": "Pagination links",
"schema": {
"type": "string"
}
},
"page-number": {
"description": "Current page of results",
"schema": {
"type": "integer"
}
},
"per-page": {
"description": "Number of entries per page",
"schema": {
"type": "integer"
}
},
"total": {
"description": "Total entries across all pages",
"schema": {
"type": "integer"
}
},
"total-pages": {
"description": "Number of pages",
"schema": {
"type": "integer"
}
}
}
},
"UserResponse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"account_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"email": "[email protected]",
"id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"name": "Jane Doe"
}
}
},
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": "User success response"
},
"AssetsResponse": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/Asset"
},
"type": "array"
}
}
},
"description": "Assets success response",
"headers": {
"link": {
"description": "Pagination links",
"schema": {
"type": "string"
}
},
"page-number": {
"description": "Current page of results",
"schema": {
"type": "integer"
}
},
"per-page": {
"description": "Number of entries per page",
"schema": {
"type": "integer"
}
},
"total": {
"description": "Total entries across all pages",
"schema": {
"type": "integer"
}
},
"total-pages": {
"description": "Number of pages",
"schema": {
"type": "integer"
}
}
}
},
"WebhooksResponse": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/Webhook"
},
"type": "array"
}
}
},
"description": "Webhook success response",
"headers": {
"link": {
"description": "Pagination links",
"schema": {
"type": "string"
}
},
"page-number": {
"description": "Current page of results",
"schema": {
"type": "integer"
}
},
"per-page": {
"description": "Number of entries per page",
"schema": {
"type": "integer"
}
},
"total": {
"description": "Total entries across all pages",
"schema": {
"type": "integer"
}
},
"total-pages": {
"description": "Number of pages",
"schema": {
"type": "integer"
}
}
}
},
"ProjectMembershipResonse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"collaborator": true,
"owner": true,
"team_member": true,
"team_role": "team_manager"
}
}
},
"schema": {
"$ref": "#/components/schemas/ProjectMembership"
}
}
},
"description": "Project membership success response"
},
"BatchAssetCopyResponse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"error": {
"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa": "Something went wrong!"
},
"success": {
"1": {
"_type": "asset"
},
"2": {
"_type": "asset"
}
}
}
}
},
"schema": {
"properties": {
"error": {
"type": "object"
},
"success": {
"properties": {
"string": {
"oneOf": [
{
"$ref": "#/components/schemas/Asset"
}
]
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"description": "Batch copy success response"
},
"TeamsResponse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"access": "public",
"collaborator_count": 3,
"file_count": 1,
"id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"name": "My Team",
"project_count": 2,
"storage": 123456
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/Team"
},
"type": "array"
}
}
},
"description": "Paginated teams success response",
"headers": {
"link": {
"description": "Pagination links",
"schema": {
"type": "string"
}
},
"page-number": {
"description": "Current page of results",
"schema": {
"type": "integer"
}
},
"per-page": {
"description": "Number of entries per page",
"schema": {
"type": "integer"
}
},
"total": {
"description": "Total entries across all pages",
"schema": {
"type": "integer"
}
},
"total-pages": {
"description": "Number of pages",
"schema": {
"type": "integer"
}
}
}
},
"ReviewLinksResponse": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ReviewLink"
},
"type": "array"
}
}
},
"description": "ReviewLink success response",
"headers": {
"link": {
"description": "Pagination links",
"schema": {
"type": "string"
}
},
"page-number": {
"description": "Current page of results",
"schema": {
"type": "integer"
}
},
"per-page": {
"description": "Number of entries per page",
"schema": {
"type": "integer"
}
},
"total": {
"description": "Total entries across all pages",
"schema": {
"type": "integer"
}
},
"total-pages": {
"description": "Number of pages",
"schema": {
"type": "integer"
}
}
}
},
"AuditsResponse": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/Audit"
},
"type": "array"
}
}
},
"description": "Audit logs list response",
"headers": {
"link": {
"description": "Pagination links",
"schema": {
"type": "string"
}
},
"page-number": {
"description": "Current page of results",
"schema": {
"type": "integer"
}
},
"per-page": {
"description": "Number of entries per page",
"schema": {
"type": "integer"
}
},
"total": {
"description": "Total entries across all pages",
"schema": {
"type": "integer"
}
},
"total-pages": {
"description": "Number of pages",
"schema": {
"type": "integer"
}
}
}
},
"BatchAssetDeleteResponse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"error": {
"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa": "Something went wrong!"
},
"success": {
"1": {
"_type": "asset"
},
"2": {
"_type": "asset"
}
}
}
}
},
"schema": {
"properties": {
"error": {
"type": "object"
},
"success": {
"properties": {
"string": {
"oneOf": [
{
"$ref": "#/components/schemas/Asset"
}
]
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"description": "Batch delete success response"
},
"AssetAudioResponse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"_type": "asset_audio",
"audio_tracks": [
"https://frameio-app.com/audio_track/2mgz5-tj39md",
"https://frameio-app.com/audio_track/5masj-135md"
],
"id": "123"
}
}
},
"schema": {
"$ref": "#/components/schemas/AssetAudio"
}
}
},
"description": "Asset audio response"
},
"TeamResponse": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Team"
}
}
},
"description": "Team success response"
},
"ActionsResponse": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/Action"
},
"type": "array"
}
}
},
"description": "Action success response",
"headers": {
"link": {
"description": "Pagination links",
"schema": {
"type": "string"
}
},
"page-number": {
"description": "Current page of results",
"schema": {
"type": "integer"
}
},
"per-page": {
"description": "Number of entries per page",
"schema": {
"type": "integer"
}
},
"total": {
"description": "Total entries across all pages",
"schema": {
"type": "integer"
}
},
"total-pages": {
"description": "Number of pages",
"schema": {
"type": "integer"
}
}
}
},
"PresentationResponse": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Presentation"
}
}
},
"description": "Presentation success response"
},
"AccountsResponse": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/Account"
},
"type": "array"
}
}
},
"description": "Paginated accounts success response",
"headers": {
"link": {
"description": "Pagination links",
"schema": {
"type": "string"
}
},
"page-number": {
"description": "Current page of results",
"schema": {
"type": "integer"
}
},
"per-page": {
"description": "Number of entries per page",
"schema": {
"type": "integer"
}
},
"total": {
"description": "Total entries across all pages",
"schema": {
"type": "integer"
}
},
"total-pages": {
"description": "Number of pages",
"schema": {
"type": "integer"
}
}
}
},
"CollaboratorResponse": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Collaborator"
}
}
},
"description": "Collaborator success response"
},
"AssetResponse": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Asset"
}
}
},
"description": "Asset success response"
},
"ReviewLinkResponse": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewLink"
}
}
},
"description": "ReviewLink success response"
},
"BatchCollaboratorDeleteResponse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"error": {
"[email protected]": "Something went wrong!"
},
"success": {
"[email protected]": {
"_type": "pending_collaborator"
}
}
}
}
},
"schema": {
"properties": {
"error": {
"type": "object"
},
"success": {
"properties": {
"email": {
"oneOf": [
{
"$ref": "#/components/schemas/Collaborator"
},
{
"$ref": "#/components/schemas/PendingCollaborator"
}
]
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"description": "Batch Delete success response"
},
"AccountResponse": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Account"
}
}
},
"description": "Account success response"
},
"ProjectResponse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"name": "My Project",
"owner_id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
"private": false,
"project_preferences": {},
"root_asset_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
"team_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
}
}
},
"schema": {
"$ref": "#/components/schemas/Project"
}
}
},
"description": "Project success response"
},
"Unauthorized": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"code": 401,
"errors": [
{
"code": 401,
"detail": "You are not allowed to access that resource",
"status": 401,
"title": "Not Authorized"
}
],
"message": "Not Authorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/HTTPError"
}
}
},
"description": "Unauthorized response"
},
"ProjectsResponse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"name": "My Project",
"owner_id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
"private": false,
"project_preferences": {},
"root_asset_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
"team_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/Project"
},
"type": "array"
}
}
},
"description": "Paginated projects success response",
"headers": {
"link": {
"description": "Pagination links",
"schema": {
"type": "string"
}
},
"page-number": {
"description": "Current page of results",
"schema": {
"type": "integer"
}
},
"per-page": {
"description": "Number of entries per page",
"schema": {
"type": "integer"
}
},
"total": {
"description": "Total entries across all pages",
"schema": {
"type": "integer"
}
},
"total-pages": {
"description": "Number of pages",
"schema": {
"type": "integer"
}
}
}
},
"CommentsResponse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"annotation": "[...]",
"completed": false,
"completed_at": null,
"completer_id": null,
"has_replies": true,
"id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"like_count": 10,
"owner": "Elixir.User",
"owner_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"text": "This is a comment.",
"timestamp": 60
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/Comment"
},
"type": "array"
}
}
},
"description": "Comments success response",
"headers": {
"link": {
"description": "Pagination links",
"schema": {
"type": "string"
}
},
"page-number": {
"description": "Current page of results",
"schema": {
"type": "integer"
}
},
"per-page": {
"description": "Number of entries per page",
"schema": {
"type": "integer"
}
},
"total": {
"description": "Total entries across all pages",
"schema": {
"type": "integer"
}
},
"total-pages": {
"description": "Number of pages",
"schema": {
"type": "integer"
}
}
}
},
"ActionResponse": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Action"
}
}
},
"description": "Action success response"
},
"AccountMembershipResponse": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountMembership"
}
}
},
"description": "Account membership success response"
},
"TeamMembershipResonse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"role": "team_manager"
}
}
},
"schema": {
"properties": {
"role": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Team membership success response"
},
"AssetSubtitleResponse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"_type": "asset_subtitle",
"id": "123",
"subtitle_tracks": [
"https://frameio-app.com/subtitle_track/3gsa-3456aa",
"https://frameio-app.com/subtitle_track/fms2-amfng4"
]
}
}
},
"schema": {
"$ref": "#/components/schemas/AssetSubtitle"
}
}
},
"description": "Asset subtitle response"
},
"CommentResponse": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"annotation": "[...]",
"completed": false,
"completed_at": null,
"completer_id": null,
"has_replies": true,
"id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"like_count": 10,
"owner": "Elixir.API.Docs.Schemas.User",
"owner_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"text": "This is a comment.",
"timestamp": 60
}
}
},
"schema": {
"$ref": "#/components/schemas/Comment"
}
}
},
"description": "Comment success response"
},
"WebhookResponse": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook"
}
}
},
"description": "Webhook success response"
}
},
"schemas": {
"LibrarySearch": {
"properties": {
"account_id": {
"format": "uuid",
"type": "string"
},
"custom_fields": {
"description": "Custom fields to filter records on (currently only for assets)",
"type": "object"
},
"filter": {
"description": "Custom ES filters to apply to your query",
"type": "object"
},
"include_deleted": {
"description": "Flag to include soft-deleted records in results",
"type": "boolean"
},
"opts": {
"description": "Additional request options",
"type": "object"
},
"page": {
"description": "The page to retrieve",
"type": "integer"
},
"page_size": {
"description": "The number of results to include in the page",
"type": "integer"
},
"q": {
"description": "Search text",
"type": "string"
},
"query": {
"description": "Search text",
"type": "string"
},
"sort": {
"description": "Sorting parameters",
"type": "string"
}
},
"type": "object"
},
"AnonymousUser": {
"properties": {
"deleted_at": {
"format": "date-time",
"type": "string"
},
"email": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"name": {
"type": "string"
},
"notification_preferences": {
"$ref": "#/components/schemas/ProjectPreferences"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"user_default_color": {
"type": "string"
}
},
"type": "object"
},
"Webhook": {
"properties": {
"account_id": {
"format": "uuid",
"type": "string"
},
"active": {
"type": "boolean"
},
"app_id": {
"format": "uuid",
"type": "string"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"events": {
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"format": "uuid",
"type": "string"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"name": {
"type": "string"
},
"project_id": {
"format": "uuid",
"type": "string"
},
"secret": {
"type": "string"
},
"team": {
"$ref": "#/components/schemas/Team"
},
"team_id": {
"format": "uuid",
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"User": {
"properties": {
"account_id": {
"type": "string"
},
"email": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"Asset": {
"properties": {
"account_id": {
"format": "uuid",
"type": "string"
},
"asset_type": {
"enum": [
"stream",
"image",
"document"
],
"type": "string"
},
"bundle": {
"type": "boolean"
},
"bundle_view": {
"type": "string"
},
"creator": {
"$ref": "#/components/schemas/User"
},
"id": {
"format": "uuid",
"type": "string"
},
"is_bundle_child": {
"type": "boolean"
},
"is_hls_required": {
"type": "boolean"
},
"is_session_watermarked": {
"type": "boolean"
},
"label": {
"enum": [
"approved",
"needs_review",
"in_progress"
],
"type": "string"
},
"metadata": {
"type": "object"
},
"name": {
"type": "string"
},
"original": {
"type": "string"
},
"project_id": {
"format": "uuid",
"type": "string"
},
"properties": {
"type": "object"
},
"required_transcodes": {
"$ref": "#/components/schemas/RequiredTranscodes"
},
"team_id": {
"format": "uuid",
"type": "string"
},
"type": {
"enum": [
"file",
"folder"
],
"type": "string"
},
"view_count": {
"type": "integer"
}
},
"type": "object"
},
"Installation": {
"properties": {
"account_id": {
"format": "uuid",
"type": "string"
},
"app_id": {
"format": "uuid",
"type": "string"
},
"app_version": {
"type": "integer"
},
"bot_user_id": {
"format": "uuid",
"type": "string"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"installed_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"Audit": {
"properties": {
"account_id": {
"format": "uuid",
"type": "string"
},
"action": {
"type": "string"
},
"actor": {
"oneOf": [
{
"$ref": "#/components/schemas/User"
},
{
"$ref": "#/components/schemas/AnonymousUser"
}
]
},
"actor_id": {
"format": "uuid",
"type": "string"
},
"application_id": {
"format": "uuid",
"type": "string"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"ip_address": {
"type": "string"
},
"item_id": {
"format": "uuid",
"type": "string"
},
"item_type": {
"type": "string"
},
"request_id": {
"format": "uuid",
"type": "string"
},
"resource": {
"type": "object"
},
"team_id": {
"format": "uuid",
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"AssetSubtitle": {
"properties": {
"_type": {
"enum": [
"asset_subtitle"
],
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"subtitle_tracks": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"PresentationItem": {
"properties": {
"asset": {
"$ref": "#/components/schemas/Asset"
},
"id": {
"format": "uuid",
"type": "string"
},
"index": {
"type": "integer"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"presentation": {
"$ref": "#/components/schemas/Presentation"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"UserPermissions": {
"properties": {
"can_download": {
"type": "boolean"
},
"can_modify_template": {
"type": "boolean"
},
"can_public_share_presentation": {
"type": "boolean"
},
"can_public_share_review_link": {
"type": "boolean"
},
"can_share_downloadable_presentation": {
"type": "boolean"
},
"can_share_downloadable_review_link": {
"type": "boolean"
},
"can_share_unwatermarked_presentation": {
"type": "boolean"
},
"can_share_unwatermarked_review_link": {
"type": "boolean"
}
},
"type": "object"
},
"WatermarkText": {
"properties": {
"alpha": {
"default": 0.5,
"type": "number"
},
"lines": {
"items": {
"type": "string"
},
"type": "array"
},
"position": {
"default": "top",
"enum": [
"top",
"center",
"bottom"
],
"type": "string"
}
},
"type": "object"
},
"Account": {
"properties": {
"collaborator_count": {
"type": "integer"
},
"display_name": {
"type": "string"
},
"folder_count": {
"type": "integer"
},
"image_128": {
"type": "string"
},
"invoice_emails": {
"items": {
"type": "string"
},
"type": "array"
},
"locked_at": {
"format": "date-time",
"type": "string"
},
"plan": {
"$ref": "#/components/schemas/Plan"
},
"archived_storage": {
"type": "integer"
},
"subscription": {
"$ref": "#/components/schemas/Subscription"
},
"image_32": {
"type": "string"
},
"frames": {
"type": "integer"
},
"account_default_color": {
"type": "string"
},
"project_count": {
"type": "integer"
},
"billing_emails": {
"type": "string"
},
"owner": {
"$ref": "#/components/schemas/User"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"upload_url": {
"type": "string"
},
"account_members": {
"items": {
"$ref": "#/components/schemas/AccountMember"
},
"type": "array"
},
"file_count": {
"type": "integer"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"storage": {
"type": "integer"
},
"company_address": {
"type": "string"
},
"lifetime_file_count": {
"type": "integer"
},
"line1": {
"type": "string"
},
"vat": {
"type": "string"
},
"collaborator_role_count": {
"type": "integer"
},
"postal_code": {
"type": "string"
},
"duration": {
"type": "integer"
},
"user_count": {
"type": "integer"
},
"state": {
"type": "string"
},
"member_count": {
"type": "integer"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"watermark": {
"$ref": "#/components/schemas/Watermark"
},
"country": {
"type": "string"
},
"company_name": {
"type": "string"
},
"image": {
"type": "string"
},
"image_256": {
"type": "string"
},
"unpaid_at": {
"format": "date-time",
"type": "string"
},
"team_count": {
"type": "integer"
},
"teams": {
"items": {
"$ref": "#/components/schemas/Team"
},
"type": "array"
},
"city": {
"type": "string"
},
"image_64": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"line2": {
"type": "string"
},
"delinquent_at": {
"format": "date-time",
"type": "string"
},
"owner_id": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"ProjectPreferences": {
"properties": {
"collaborator_can_download": {
"type": "boolean"
},
"collaborator_can_invite": {
"type": "boolean"
},
"collaborator_can_share": {
"type": "boolean"
},
"notify_on_new_asset": {
"type": "boolean"
},
"notify_on_new_collaborator": {
"type": "boolean"
},
"notify_on_new_comment": {
"type": "boolean"
},
"notify_on_updated_label": {
"type": "boolean"
},
"notify_slack": {
"type": "boolean"
}
},
"type": "object"
},
"AssetSource": {
"properties": {
"url": {
"type": "string"
}
},
"type": "object"
},
"BatchInviteParams": {
"properties": {
"batch": {
"items": {
"properties": {
"email": {
"description": "Create an invite for the given email",
"type": "string"
},
"message": {
"description": "Invite message to be used for this one bath op",
"type": "string"
},
"team_id": {
"description": "Create a set of invites for all approved team members within the given team",
"format": "uuid",
"type": "string"
},
"user_group_id": {
"description": "Create a set of invites for all the users within the given user group",
"format": "uuid",
"type": "string"
},
"user_id": {
"description": "Create an invite for the given user_id",
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"default_message": {
"description": "Default invite message to be applied to all invites created",
"type": "string"
},
"send_email": {
"default": true,
"description": "When false no emails will be sent to the new Reviewers and Pending Reviewers",
"type": "boolean"
}
},
"type": "object"
},
"SessionWatermarkDataPoint": {
"properties": {
"order": {
"type": "integer"
},
"type": {
"enum": [
"email",
"username",
"ip_address",
"timestamp",
"custom_text",
"user_input"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"Project": {
"properties": {
"archive_status": {
"enum": [
"standard",
"archiving",
"unarchiving",
"archived"
],
"type": "string"
},
"archived_at": {
"format": "date-time",
"type": "string"
},
"archived_file_count": {
"default": 0,
"type": "integer"
},
"archived_storage": {
"default": 0,
"type": "integer"
},
"collaborator_count": {
"default": 0,
"type": "integer"
},
"collaborators": {
"items": {
"$ref": "#/components/schemas/Collaborator"
},
"type": "array"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"file_count": {
"default": 0,
"type": "integer"
},
"folder_count": {
"default": 0,
"type": "integer"
},
"id": {
"format": "uuid",
"type": "string"
},
"ignore_archive": {
"default": false,
"type": "boolean"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"invite_url": {
"type": "string"
},
"name": {
"type": "string"
},
"owner_id": {
"format": "uuid",
"type": "string"
},
"private": {
"default": false,
"type": "boolean"
},
"project_preferences": {
"$ref": "#/components/schemas/ProjectPreferences"
},
"read_only": {
"default": false,
"type": "boolean"
},
"root_asset": {
"$ref": "#/components/schemas/Asset"
},
"root_asset_id": {
"format": "uuid",
"type": "string"
},
"shared": {
"default": false,
"type": "boolean"
},
"storage": {
"default": 0,
"type": "integer"
},
"team": {
"$ref": "#/components/schemas/Team"
},
"team_id": {
"format": "uuid",
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"user_permissions": {
"$ref": "#/components/schemas/UserPermissions"
},
"user_preferences": {
"$ref": "#/components/schemas/ProjectPreferences"
},
"watermark": {
"$ref": "#/components/schemas/Watermark"
}
},
"type": "object"
},
"RequiredTranscodes": {
"properties": {
"cover": {
"type": "boolean"
},
"finalized": {
"items": {
"enum": [
"thumb",
"thumb_540",
"thumb_scrub",
"image_full",
"image_high",
"cover",
"h264_360",
"h264_540",
"h264_720",
"h264_1080_best",
"h264_2160",
"page_proxy",
"thumb_orig_ar_540"
],
"type": "string"
},
"type": "array"
},
"h264_1080_best": {
"type": "boolean"
},
"h264_2160": {
"type": "boolean"
},
"h264_360": {
"type": "boolean"
},
"h264_540": {
"type": "boolean"
},
"h264_720": {
"type": "boolean"
},
"image_full": {
"type": "boolean"
},
"image_high": {
"type": "boolean"
},
"page_proxy": {
"type": "boolean"
},
"thumb": {
"type": "boolean"
},
"thumb_540": {
"type": "boolean"
},
"thumb_orig_ar_540": {
"type": "boolean"
},
"thumb_scrub": {
"type": "boolean"
}
},
"type": "object"
},
"Team": {
"properties": {
"collaborator_count": {
"default": 0,
"type": "integer"
},
"font_color": {
"type": "string"
},
"folder_count": {
"default": 0,
"type": "integer"
},
"image_128": {
"type": "string"
},
"user_role": {
"type": "object"
},
"background_color": {
"type": "string"
},
"archived_storage": {
"default": 0,
"type": "integer"
},
"image_32": {
"type": "string"
},
"creator_id": {
"format": "uuid",
"type": "string"
},
"solo": {
"default": false,
"type": "boolean"
},
"slack_webhook": {
"type": "object"
},
"frames": {
"default": 0,
"type": "integer"
},
"team_image": {
"type": "string"
},
"access": {
"enum": [
"private",
"public",
"restricted"
],
"type": "string"
},
"project_count": {
"default": 0,
"type": "integer"
},
"account_id": {
"format": "uuid",
"type": "string"
},
"default_color": {
"type": "string"
},
"link": {
"type": "string"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"upload_url": {
"type": "string"
},
"default_font_color": {
"type": "string"
},
"file_count": {
"default": 0,
"type": "integer"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"storage": {
"default": 0,
"type": "integer"
},
"default_session_watermark_template_id": {
"format": "uuid",
"type": "string"
},
"member_limit": {
"type": "integer"
},
"duration": {
"default": 0,
"type": "integer"
},
"member_count": {
"default": 0,
"type": "integer"
},
"name": {
"type": "string"
},
"default_session_watermark_template": {
"$ref": "#/components/schemas/SessionWatermarkTemplate"
},
"disable_sbwm_internally": {
"default": false,
"type": "boolean"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"watermark": {
"$ref": "#/components/schemas/Watermark"
},
"session_watermark_templates": {
"items": {
"$ref": "#/components/schemas/SessionWatermarkTemplate"
},
"type": "array"
},
"image_256": {
"type": "string"
},
"account": {
"$ref": "#/components/schemas/Account"
},
"color": {
"type": "string"
},
"admin_only_actions": {
"$ref": "#/components/schemas/AdminOnlyAction"
},
"bio": {
"type": "string"
},
"storage_limit": {
"type": "integer"
},
"location": {
"type": "string"
},
"asset_lifecycle_policy": {
"type": "integer"
},
"image_64": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"default_background_color": {
"type": "string"
},
"email_branding": {
"$ref": "#/components/schemas/EmailBranding"
},
"dark_theme": {
"default": false,
"type": "boolean"
}
},
"type": "object"
},
"Action": {
"properties": {
"active": {
"type": "boolean"
},
"allow_collaborators": {
"type": "boolean"
},
"creator_id": {
"format": "uuid",
"type": "string"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"event": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"image": {
"type": "string"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"name": {
"type": "string"
},
"team": {
"$ref": "#/components/schemas/Team"
},
"team_id": {
"format": "uuid",
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"upload_url": {
"type": "string"
},
"url": {
"type": "string"
},
"webhook": {
"$ref": "#/components/schemas/Webhook"
}
},
"type": "object"
},
"ReviewLinkItem": {
"properties": {
"asset": {
"$ref": "#/components/schemas/Asset"
},
"asset_id": {
"format": "uuid",
"type": "string"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"index": {
"type": "integer"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"review_link": {
"$ref": "#/components/schemas/ReviewLink"
},
"review_link_id": {
"format": "uuid",
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"AssetSearch": {
"properties": {
"account_id": {
"format": "uuid",
"type": "string"
},
"custom_fields": {
"description": "Custom fields to filter records on (currently only for assets)",
"type": "object"
},
"filter": {
"description": "Custom ES filters to apply to your query",
"type": "object"
},
"include": {
"type": "string"
},
"include_deleted": {
"description": "Flag to include soft-deleted records in results",
"type": "boolean"
},
"opts": {
"description": "Additional request options",
"type": "object"
},
"page": {
"description": "The page to retrieve",
"type": "integer"
},
"page_size": {
"description": "The number of results to include in the page",
"type": "integer"
},
"project_id": {
"format": "uuid",
"type": "string"
},
"properties": {
"type": "object"
},
"q": {
"description": "Search text",
"type": "string"
},
"query": {
"description": "Search text",
"type": "string"
},
"shared_projects": {
"type": "boolean"
},
"sort": {
"description": "Sorting parameters",
"type": "string"
},
"team_id": {
"oneOf": [
{
"format": "uuid",
"type": "string"
},
{
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
]
},
"type": {
"type": "string"
}
},
"type": "object"
},
"ReviewLink": {
"properties": {
"access_control": {
"$ref": "#/components/schemas/ShareableEntityAccessControl"
},
"allow_approvals": {
"default": true,
"type": "boolean"
},
"available_features": {
"type": "object"
},
"bundle_count": {
"default": 0,
"type": "integer"
},
"current_version_only": {
"default": false,
"type": "boolean"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"enable_comments": {
"default": true,
"type": "boolean"
},
"enable_downloading": {
"default": true,
"type": "boolean"
},
"expires_at": {
"format": "date-time",
"type": "string"
},
"folder_item_count": {
"default": 0,
"type": "integer"
},
"has_password": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"is_active": {
"default": true,
"type": "boolean"
},
"is_autoplay": {
"default": true,
"type": "boolean"
},
"item_count": {
"default": 0,
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/ReviewLinkItem"
},
"type": "array"
},
"name": {
"type": "string"
},
"notify_on_view": {
"default": true,
"type": "boolean"
},
"owner": {
"$ref": "#/components/schemas/User"
},
"owner_id": {
"format": "uuid",
"type": "string"
},
"password": {
"type": "string"
},
"project": {
"$ref": "#/components/schemas/Project"
},
"project_id": {
"format": "uuid",
"type": "string"
},
"reviewer_count": {
"default": 0,
"type": "integer"
},
"short_url": {
"type": "string"
},
"team": {
"$ref": "#/components/schemas/Team"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"view_count": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"AccountMember": {
"properties": {
"accepted_at": {
"format": "date-time",
"type": "string"
},
"account_id": {
"format": "uuid",
"type": "string"
},
"declined_at": {
"format": "date-time",
"type": "string"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"role": {
"enum": [
"admin",
"billing_manager",
"account_manager",
"member"
],
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"user_id": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"PendingCollaborator": {
"properties": {
"deleted_at": {
"format": "date-time",
"type": "string"
},
"email": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"message": {
"type": "string"
},
"project_id": {
"format": "uuid",
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"Plan": {
"properties": {
"archived_storage_limit": {
"type": "integer"
},
"autoscaling": {
"type": "boolean"
},
"available_features": {
"properties": {
"archival_storage": {
"type": "boolean"
},
"custom_branded_emails": {
"type": "boolean"
},
"custom_branded_presentations": {
"type": "boolean"
},
"reel_player": {
"type": "boolean"
},
"secure_sharing": {
"type": "boolean"
},
"session_based_watermarking": {
"type": "boolean"
},
"team_only_comments": {
"type": "boolean"
},
"transcription": {
"type": "boolean"
}
},
"type": "object"
},
"collaborator_limit": {
"type": "integer"
},
"cost": {
"type": "integer"
},
"default_plan": {
"type": "boolean"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"enterprise": {
"type": "boolean"
},
"file_limit": {
"type": "integer"
},
"id": {
"format": "uuid",
"type": "string"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"lifetime_file_limit": {
"type": "integer"
},
"member_limit": {
"type": "integer"
},
"name": {
"type": "string"
},
"payment_method": {
"enum": [
"stripe",
"check"
],
"type": "string"
},
"period": {
"enum": [
"monthly",
"yearly",
"semiannually"
],
"type": "string"
},
"project_limit": {
"type": "integer"
},
"storage_limit": {
"type": "integer"
},
"team_limit": {
"type": "integer"
},
"tier": {
"enum": [
"free",
"starter",
"pro",
"team",
"business",
"enterprise"
],
"type": "string"
},
"title": {
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"user_limit": {
"type": "integer"
},
"user_max": {
"type": "integer"
},
"version": {
"type": "integer"
}
},
"type": "object"
},
"AccountMembership": {
"properties": {
"account": {
"enum": [
"owner",
"admin",
"account_manager",
"billing_manager"
],
"type": "string"
},
"reviewer": {
"type": "boolean"
},
"team": {
"enum": [
"team_manager",
"member"
],
"type": "string"
}
},
"type": "object"
},
"ShareableEntityAccessControl": {
"properties": {
"invite_only": {
"type": "boolean"
}
},
"type": "object"
},
"Subscription": {
"properties": {
"account": {
"$ref": "#/components/schemas/Account"
},
"account_id": {
"format": "uuid",
"type": "string"
},
"archived_storage_limit": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"cancellation_option": {
"type": "string"
},
"cancellation_reason": {
"type": "string"
},
"cancelled_at": {
"format": "date-time",
"type": "string"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"last_payment_at": {
"format": "date-time",
"type": "string"
},
"member_limit": {
"type": "integer"
},
"next_bill_at": {
"format": "date-time",
"type": "string"
},
"on_trial": {
"type": "boolean"
},
"plan": {
"$ref": "#/components/schemas/Plan"
},
"plan_id": {
"format": "uuid",
"type": "string"
},
"promotion": {
"$ref": "#/components/schemas/Promotion"
},
"promotion_expires_at": {
"format": "date-time",
"type": "string"
},
"promotion_id": {
"format": "uuid",
"type": "string"
},
"requires_autoscaling": {
"type": "boolean"
},
"storage_limit": {
"type": "integer"
},
"subscription_end_at": {
"format": "date-time",
"type": "string"
},
"total_archived_storage_limit": {
"type": "integer"
},
"total_lifetime_file_limit": {
"type": "integer"
},
"total_member_limit": {
"type": "integer"
},
"total_project_limit": {
"type": "integer"
},
"total_storage_limit": {
"type": "integer"
},
"total_user_limit": {
"type": "integer"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"user_limit": {
"type": "integer"
}
},
"type": "object"
},
"Image": {
"properties": {
"bucket": {
"type": "string"
},
"key": {
"type": "string"
},
"type": {
"default": "image/jpeg",
"type": "string"
},
"uploaded": {
"default": false,
"type": "boolean"
}
},
"type": "object"
},
"Watermark": {
"properties": {
"image": {
"$ref": "#/components/schemas/WatermarkImage"
},
"text": {
"$ref": "#/components/schemas/WatermarkText"
}
},
"type": "object"
},
"ProjectMembership": {
"properties": {
"collaborator": {
"type": "boolean"
},
"owner": {
"type": "boolean"
},
"team_member": {
"type": "boolean"
},
"team_role": {
"type": "string"
}
},
"type": "object"
},
"SessionWatermarkTemplate": {
"properties": {
"account_id": {
"format": "uuid",
"type": "string"
},
"app_default": {
"default": false,
"type": "boolean"
},
"creator": {
"$ref": "#/components/schemas/User"
},
"creator_id": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"watermark_blocks": {
"items": {
"$ref": "#/components/schemas/SessionWatermarkBlock"
},
"type": "array"
}
},
"type": "object"
},
"WatermarkImage": {
"properties": {
"alpha": {
"default": 0.5,
"type": "number"
},
"image": {
"$ref": "#/components/schemas/Image"
},
"position": {
"default": "top_left",
"enum": [
"top_left",
"top_right",
"bottom_left",
"bottom_right"
],
"type": "string"
}
},
"type": "object"
},
"EmailBranding": {
"properties": {
"accent_color": {
"type": "string"
},
"background_color": {
"type": "string"
},
"image": {
"$ref": "#/components/schemas/Image"
}
},
"type": "object"
},
"HTTPError": {
"properties": {
"code": {
"type": "integer"
},
"errors": {
"items": {
"properties": {
"code": {
"type": "integer"
},
"detail": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
}
},
"type": "object"
},
"AdminOnlyAction": {
"properties": {
"lifecycle": {
"default": false,
"type": "boolean"
}
},
"type": "object"
},
"Comment": {
"properties": {
"annotation": {
"type": "string"
},
"completed": {
"type": "boolean"
},
"completed_at": {
"type": "string"
},
"completer_id": {
"format": "uuid",
"type": "string"
},
"has_replies": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"like_count": {
"type": "integer"
},
"owner": {
"$ref": "#/components/schemas/User"
},
"owner_id": {
"format": "uuid",
"type": "string"
},
"text": {
"type": "string"
},
"timestamp": {
"type": "integer"
}
},
"type": "object"
},
"Presentation": {
"properties": {
"enabled": {
"type": "boolean"
},
"expires_at": {
"format": "date-time",
"type": "string"
},
"assets": {
"items": {
"$ref": "#/components/schemas/Asset"
},
"type": "array"
},
"background_color": {
"type": "string"
},
"can_download": {
"type": "boolean"
},
"available_features": {
"type": "object"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"include_upload_date": {
"type": "boolean"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"autoplay": {
"type": "boolean"
},
"asset": {
"$ref": "#/components/schemas/Asset"
},
"secure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"team": {
"$ref": "#/components/schemas/Team"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"project_id": {
"format": "uuid",
"type": "string"
},
"asset_id": {
"format": "uuid",
"type": "string"
},
"layout": {
"enum": [
"blog",
"reel"
],
"type": "string"
},
"format": {
"type": "string"
},
"view_count": {
"default": 0,
"type": "integer"
},
"short_url": {
"type": "string"
},
"vanity": {
"type": "string"
},
"color": {
"type": "string"
},
"access_control": {
"$ref": "#/components/schemas/ShareableEntityAccessControl"
},
"reviewer_count": {
"default": 0,
"type": "integer"
},
"presentation_items": {
"items": {
"$ref": "#/components/schemas/PresentationItem"
},
"type": "array"
},
"style": {
"type": "string"
},
"description": {
"type": "string"
},
"text_color": {
"type": "string"
},
"project": {
"$ref": "#/components/schemas/Project"
},
"title": {
"type": "string"
},
"password": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"owner_id": {
"format": "uuid",
"type": "string"
},
"include_ext": {
"type": "boolean"
}
},
"type": "object"
},
"Collaborator": {
"properties": {
"_type": {
"enum": [
"collaborator",
"pending_collaborator"
],
"type": "string"
},
"email": {
"type": "string"
},
"project_id": {
"format": "uuid",
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"user_id": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"AssetAudio": {
"properties": {
"_type": {
"enum": [
"asset_audio"
],
"type": "string"
},
"audio_tracks": {
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"Promotion": {
"properties": {
"autoscaling": {
"type": "boolean"
},
"can_override_limitations": {
"type": "boolean"
},
"deleted_at": {
"format": "date-time",
"type": "string"
},
"expires_at": {
"format": "date-time",
"type": "string"
},
"header_subtext": {
"type": "string"
},
"header_text": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"is_trial": {
"type": "boolean"
},
"new_price": {
"type": "integer"
},
"no_credit_card": {
"type": "boolean"
},
"plan": {
"$ref": "#/components/schemas/Plan"
},
"plan_id": {
"format": "uuid",
"type": "string"
},
"promo_code": {
"type": "string"
},
"submit_text": {
"type": "string"
},
"trial_length": {
"type": "integer"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"SessionWatermarkBlock": {
"properties": {
"alpha": {
"default": 0.5,
"type": "number"
},
"data_points": {
"items": {
"$ref": "#/components/schemas/SessionWatermarkDataPoint"
},
"type": "array"
},
"font_size": {
"default": "medium",
"enum": [
"small",
"medium",
"large",
"huge"
],
"type": "string"
},
"name": {
"type": "string"
},
"position": {
"default": "top_left",
"enum": [
"top_left",
"top_center",
"top_right",
"middle_left",
"middle_center",
"middle_right",
"bottom_left",
"bottom_center",
"bottom_right"
],
"type": "string"
},
"position_reference_point": {
"enum": [
"top_left",
"top_center",
"top_right",
"middle_left",
"middle_center",
"middle_right",
"bottom_left",
"bottom_center",
"bottom_right"
],
"type": "string"
},
"position_x": {
"type": "integer"
},
"position_y": {
"type": "integer"
},
"scroll_text": {
"default": "none",
"enum": [
"none",
"ltr",
"rtl"
],
"type": "string"
},
"text_alignment": {
"default": "left",
"enum": [
"left",
"right",
"center"
],
"type": "string"
},
"text_color": {
"default": "#FFFFFF",
"type": "string"
},
"text_shadow": {
"default": false,
"type": "boolean"
}
},
"type": "object"
}
},
"securitySchemes": {
"JWTAuth": {
"bearerFormat": "JWT",
"scheme": "bearer",
"type": "http"
},
"OAuth": {
"flows": {
"authorizationCode": {
"authorizationUrl": "https://applications.frame.io/oauth2/auth",
"refreshUrl": "https://applications.frame.io/oauth2/token",
"scopes": {
"presentation.update": "modify presentations",
"comment.read": "read comments",
"asset.update": "modify assets",
"reviewlink.update": "modify review links",
"webhook.create": "create webhooks",
"account.read": "read accounts",
"action.update": "modify actions",
"reviewlink.read": "read review links",
"presentation.read": "read presentations",
"action.create": "create actions",
"presentation.create": "create presentations",
"auditlog.read": "read audit logs",
"team.create": "create teams",
"comment.create": "create comments",
"team.read": "read teams",
"offline": "generate refresh tokens",
"reviewlink.delete": "delete review links",
"project.update": "modify projects",
"project.delete": "delete projects",
"webhook.delete": "delete webhooks",
"action.delete": "delete actions",
"asset.delete": "delete assets",
"webhook.read": "read webhooks",
"asset.create": "create assets",
"comment.delete": "delete comments",
"webhook.update": "modify webhooks",
"asset.read": "read assets",
"comment.update": "modify comments",
"project.read": "read projects",
"action.read": "read actions",
"reviewlink.create": "create review links",
"presentation.delete": "delete presentations",
"project.create": "create projects",
"team.update": "modify teams"
},
"tokenUrl": "https://applications.frame.io/oauth2/token"
},
"implicit": {
"authorizationUrl": "https://applications.frame.io/oauth2/auth",
"scopes": {
"presentation.update": "modify presentations",
"comment.read": "read comments",
"asset.update": "modify assets",
"reviewlink.update": "modify review links",
"webhook.create": "create webhooks",
"account.read": "read accounts",
"action.update": "modify actions",
"reviewlink.read": "read review links",
"presentation.read": "read presentations",
"action.create": "create actions",
"presentation.create": "create presentations",
"auditlog.read": "read audit logs",
"team.create": "create teams",
"comment.create": "create comments",
"team.read": "read teams",
"offline": "generate refresh tokens",
"reviewlink.delete": "delete review links",
"project.update": "modify projects",
"project.delete": "delete projects",
"webhook.delete": "delete webhooks",
"action.delete": "delete actions",
"asset.delete": "delete assets",
"webhook.read": "read webhooks",
"asset.create": "create assets",
"comment.delete": "delete comments",
"webhook.update": "modify webhooks",
"asset.read": "read assets",
"comment.update": "modify comments",
"project.read": "read projects",
"action.read": "read actions",
"reviewlink.create": "create review links",
"presentation.delete": "delete presentations",
"project.create": "create projects",
"team.update": "modify teams"
}
}
},
"type": "oauth2"
},
"SecretTokenAuth": {
"scheme": "token",
"type": "http"
},
"UserTokenAuth": {
"scheme": "bearer",
"type": "http"
}
}
},
"info": {
"description": "Documentation for the Frame.io API",
"title": "Frame.io v2 API",
"version": "2.0.0"
},
"openapi": "3.0.0",
"paths": {
"/v2/assets/{asset_id}/unversion": {
"delete": {
"operationId": "unversionAsset",
"parameters": [
{
"in": "path",
"name": "asset_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/AssetResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.update"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Unversion an Asset",
"tags": [
"Assets"
]
}
},
"/v2/accounts": {
"get": {
"operationId": "getAccounts",
"parameters": [],
"responses": {
"200": {
"$ref": "#/components/responses/AccountsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"account.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get Accounts for User",
"tags": [
"Accounts"
]
}
},
"/v2/review_links/{review_link_id}/assets": {
"post": {
"operationId": "reviewLinkItemCreate",
"parameters": [
{
"in": "path",
"name": "review_link_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ReviewLinkItemCreateRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/ReviewLinkResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"reviewlink.create"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Add Asset to a Review Link",
"tags": [
"Review Links"
]
}
},
"/v2/teams/{team_id}/actions": {
"get": {
"operationId": "getActionsByTeam",
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "include",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ActionsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"UserTokenAuth": []
}
],
"summary": "Get Custom Actions for an Account or Team\n",
"tags": [
"Custom Actions"
]
},
"post": {
"operationId": "createActionForTeam",
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ActionRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/ActionResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"UserTokenAuth": []
}
],
"summary": "Create a Custom Action\n",
"tags": [
"Custom Actions"
]
}
},
"/v2/accounts/{account_id}/audit_logs": {
"get": {
"operationId": "getAuditLogs",
"parameters": [
{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/AuditsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"auditlog.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get Audit Logs for an Account",
"tags": [
"Audit Logs"
]
}
},
"/v2/batch/projects/{project_id}/collaborators": {
"delete": {
"operationId": "batchDeleteCollaborators",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/BatchCollaboratorDeleteResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
}
],
"summary": "Batch delete Collaborators and PendingCollaborators for a Project\n",
"tags": [
"Projects"
]
},
"post": {
"operationId": "batchCreateCollaborators",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/BatchCollaboratorCreateRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/BatchCollaboratorCreateResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
}
],
"summary": "Batch create Collaborators and PendingCollaborators for a Project\n",
"tags": [
"Projects"
]
}
},
"/v2/accounts/{id}": {
"get": {
"operationId": "getAccount",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/AccountResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"account.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get Account",
"tags": [
"Accounts"
]
}
},
"/v2/teams/{team_id}/projects": {
"get": {
"operationId": "getProjectsByTeam",
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ProjectsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"project.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get Projects by Team",
"tags": [
"Projects"
]
},
"post": {
"operationId": "createProject",
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ProjectRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/ProjectResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"project.create"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Create a Project",
"tags": [
"Projects"
]
}
},
"/v2/projects/shared": {
"get": {
"operationId": "getSharedProjects",
"parameters": [
{
"in": "query",
"name": "filter",
"schema": {
"properties": {
"account_id": {
"description": "Filter based on project account",
"type": "string"
},
"archived": {
"default": false,
"description": "Filter based on project archival status",
"type": "boolean"
},
"name": {
"description": "Filter based on project.name",
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Page of the results to return",
"in": "query",
"name": "page",
"schema": {
"default": 1,
"type": "integer"
}
},
{
"description": "Number of results to include in a results page",
"in": "query",
"name": "page_size",
"schema": {
"default": 50,
"type": "integer"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ProjectsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"project.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get Projects where User is a Collaborator\n",
"tags": [
"Projects"
]
}
},
"/v2/assets/{id}": {
"delete": {
"operationId": "deleteAsset",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/AssetResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.delete"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Delete an Asset",
"tags": [
"Assets"
]
},
"get": {
"operationId": "getAsset",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "include_deleted",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type",
"schema": {
"oneOf": [
{
"enum": [
"file",
"folder",
"version_stack",
"bundle"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/AssetResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get an Asset",
"tags": [
"Assets"
]
},
"put": {
"operationId": "updateAsset",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/AssetUpdateRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/AssetResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.update"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Update an asset",
"tags": [
"Assets"
]
}
},
"/v2/projects/{project_id}/collaborators": {
"post": {
"operationId": "addCollaboratorToProject",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/CollaboratorRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/CollaboratorResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"project.update"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Add a collaborator to a project",
"tags": [
"Projects"
]
}
},
"/v2/comments/{comment_id}/replies": {
"get": {
"operationId": "getReplies",
"parameters": [
{
"in": "path",
"name": "comment_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "include",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/CommentsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"comment.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get comments by asset or get replies by comment.\n\n This endpoint will return all comments and replys in a flat list.\n ",
"tags": [
"Comments"
]
},
"post": {
"operationId": "createReply",
"parameters": [
{
"in": "path",
"name": "comment_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/CommentRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/CommentResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"comment.create"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Create a Comment",
"tags": [
"Comments"
]
}
},
"/v2/actions/{id}": {
"delete": {
"operationId": "deleteAction",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ActionResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"UserTokenAuth": []
}
],
"summary": "Delete a Custom Action\n",
"tags": [
"Custom Actions"
]
},
"get": {
"operationId": "getAction",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ActionResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"UserTokenAuth": []
}
],
"summary": "Get a Custom Action by ID\n",
"tags": [
"Custom Actions"
]
},
"put": {
"operationId": "updateAction",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ActionRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/ActionResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"UserTokenAuth": []
}
],
"summary": "Update a Custom Action\n",
"tags": [
"Custom Actions"
]
}
},
"/v2/projects/{project_id}/membership": {
"get": {
"operationId": "getProjectMembership",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "user_id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ProjectMembershipResonse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"project.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get current User(s) membership for a Project",
"tags": [
"Projects"
]
}
},
"/v2/assets/{asset_id}/subtitles": {
"get": {
"operationId": "getSubtitles",
"parameters": [
{
"in": "path",
"name": "asset_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/AssetSubtitleResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get the subtitles for an asset",
"tags": [
"Assets"
]
}
},
"/v2/hooks/{id}": {
"delete": {
"operationId": "deleteWebhook",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/WebhookResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"UserTokenAuth": []
}
],
"summary": "Delete webhook",
"tags": [
"Webhooks"
]
},
"get": {
"operationId": "getWebhook",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/WebhookResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"UserTokenAuth": []
}
],
"summary": "Get webhook by ID",
"tags": [
"Webhooks"
]
},
"put": {
"operationId": "updateWebhook",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/WebhookRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/WebhookResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"UserTokenAuth": []
}
],
"summary": "Update webhook",
"tags": [
"Webhooks"
]
}
},
"/v2/teams": {
"get": {
"operationId": "getTeams",
"parameters": [],
"responses": {
"200": {
"$ref": "#/components/responses/TeamsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"team.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get Teams for User or Account\n",
"tags": [
"Teams"
]
}
},
"/v2/accounts/{account_id}/membership": {
"get": {
"operationId": "getAccountMembership",
"parameters": [
{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/AccountMembershipResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"account.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get Account membership",
"tags": [
"Accounts"
]
}
},
"/v2/search/assets": {
"get": {
"operationId": "assetSearchGet",
"parameters": [
{
"in": "query",
"name": "account_id",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "Custom fields to filter records on (currently only for assets)",
"in": "query",
"name": "custom_fields",
"schema": {
"type": "object"
}
},
{
"description": "Custom ES filters to apply to your query",
"in": "query",
"name": "filter",
"schema": {
"type": "object"
}
},
{
"in": "query",
"name": "include",
"schema": {
"type": "string"
}
},
{
"description": "Flag to include soft-deleted records in results",
"in": "query",
"name": "include_deleted",
"schema": {
"type": "boolean"
}
},
{
"description": "Additional request options",
"in": "query",
"name": "opts",
"schema": {
"type": "object"
}
},
{
"description": "The page to retrieve",
"in": "query",
"name": "page",
"schema": {
"type": "integer"
}
},
{
"description": "The number of results to include in the page",
"in": "query",
"name": "page_size",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "project_id",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "properties",
"schema": {
"type": "object"
}
},
{
"description": "Search text",
"in": "query",
"name": "q",
"schema": {
"type": "string"
}
},
{
"description": "Search text",
"in": "query",
"name": "query",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "shared_projects",
"schema": {
"type": "boolean"
}
},
{
"description": "Sorting parameters",
"in": "query",
"name": "sort",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "team_id",
"schema": {
"oneOf": [
{
"format": "uuid",
"type": "string"
},
{
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
]
}
},
{
"in": "query",
"name": "type",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/AssetsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Search for Assets",
"tags": [
"Assets"
]
},
"post": {
"operationId": "assetSearchPost",
"parameters": [],
"requestBody": {
"$ref": "#/components/requestBodies/AssetSearchRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/AssetsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Search for Assets",
"tags": [
"Assets"
]
}
},
"/v2/assets/{asset_id}/audio": {
"get": {
"operationId": "getAudio",
"parameters": [
{
"in": "path",
"name": "asset_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/AssetAudioResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get audio for an Asset",
"tags": [
"Assets"
]
}
},
"/v2/search/library": {
"get": {
"operationId": "librarySearchGet",
"parameters": [
{
"in": "query",
"name": "account_id",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "Custom fields to filter records on (currently only for assets)",
"in": "query",
"name": "custom_fields",
"schema": {
"type": "object"
}
},
{
"description": "Custom ES filters to apply to your query",
"in": "query",
"name": "filter",
"schema": {
"type": "object"
}
},
{
"description": "Flag to include soft-deleted records in results",
"in": "query",
"name": "include_deleted",
"schema": {
"type": "boolean"
}
},
{
"description": "Additional request options",
"in": "query",
"name": "opts",
"schema": {
"type": "object"
}
},
{
"description": "The page to retrieve",
"in": "query",
"name": "page",
"schema": {
"type": "integer"
}
},
{
"description": "The number of results to include in the page",
"in": "query",
"name": "page_size",
"schema": {
"type": "integer"
}
},
{
"description": "Search text",
"in": "query",
"name": "q",
"schema": {
"type": "string"
}
},
{
"description": "Search text",
"in": "query",
"name": "query",
"schema": {
"type": "string"
}
},
{
"description": "Sorting parameters",
"in": "query",
"name": "sort",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/AssetsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Advanced search for Assets\n",
"tags": [
"Assets"
]
},
"post": {
"operationId": "librarySearchPost",
"parameters": [],
"requestBody": {
"$ref": "#/components/requestBodies/LibrarySearchRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/AssetsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Advanced search for Assets\n",
"tags": [
"Assets"
]
}
},
"/v2/accounts/{account_id}/actions": {
"get": {
"operationId": "getActionsByAccount",
"parameters": [
{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "include",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ActionsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"UserTokenAuth": []
}
],
"summary": "Get Custom Actions for an Account or Team\n",
"tags": [
"Custom Actions"
]
}
},
"/v2/projects/{project_id}/review_links": {
"get": {
"operationId": "reviewLinksList",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ReviewLinksResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"reviewlink.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get a Review Link",
"tags": [
"Review Links"
]
},
"post": {
"operationId": "reviewLinkCreate",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ReviewLinkCreateRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/ReviewLinkResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"reviewlink.create"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Create a Review Link",
"tags": [
"Review Links"
]
}
},
"/v2/accounts/{account_id}/hooks": {
"get": {
"operationId": "getWebhooksByAccount",
"parameters": [
{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/WebhooksResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"UserTokenAuth": []
}
],
"summary": "Get webhooks for account",
"tags": [
"Webhooks"
]
}
},
"/v2/me": {
"get": {
"operationId": "getMe",
"parameters": [],
"responses": {
"200": {
"$ref": "#/components/responses/UserResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": []
},
{
"UserTokenAuth": []
}
],
"summary": "Get the current authenticated User",
"tags": [
"Users"
]
}
},
"/v2/accounts/{account_id}/teams": {
"get": {
"operationId": "getTeamsByAccount",
"parameters": [
{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "include",
"schema": {
"enum": [
"user_role"
],
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/TeamsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"team.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get Teams for User or Account\n",
"tags": [
"Teams"
]
},
"post": {
"operationId": "createTeam",
"parameters": [
{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/TeamRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/TeamResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"team.create"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Create a Team for the given Account\n",
"tags": [
"Teams"
]
}
},
"/v2/teams/{team_id}/membership": {
"get": {
"operationId": "getMembershipByTeam",
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/TeamMembershipResonse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"team.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get user membership for team",
"tags": [
"Teams"
]
}
},
"/v2/batch/assets/{asset_id}/copy": {
"post": {
"operationId": "batchCopyAsset",
"parameters": [
{
"description": "Identifier of the folder to copy into",
"in": "path",
"name": "asset_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/BatchAssetCopyRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/BatchAssetCopyResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.create"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Bulk copy assets\n",
"tags": [
"Assets"
]
}
},
"/v2/assets/{asset_id}/copy": {
"post": {
"operationId": "copyAsset",
"parameters": [
{
"description": "Identifier of the folder to copy into",
"in": "path",
"name": "asset_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/AssetCopyRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/AssetResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.create"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Copy an Asset",
"tags": [
"Assets"
]
}
},
"/v2/installations/for_me": {
"get": {
"operationId": "getInstallationForMe",
"parameters": [],
"responses": {
"200": {
"$ref": "#/components/responses/InstallationResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": []
},
{
"UserTokenAuth": []
}
],
"summary": "Get the installation associated with the current bot user",
"tags": [
"App Installations"
]
}
},
"/v2/batch/assets": {
"delete": {
"operationId": "batchDeleteAsset",
"parameters": [],
"responses": {
"200": {
"$ref": "#/components/responses/BatchAssetDeleteResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.delete"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Bulk delete assets\n",
"tags": [
"Assets"
]
}
},
"/v2/assets/{asset_id}/version": {
"post": {
"operationId": "addVersionToAsset",
"parameters": [
{
"in": "path",
"name": "asset_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"next_asset_id": {
"format": "uuid",
"type": "string"
}
},
"required": [
"next_asset_id"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/responses/AssetResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.update"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Version an Asset",
"tags": [
"Assets"
]
}
},
"/v2/projects/{id}": {
"delete": {
"operationId": "deleteProject",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ProjectResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"project.delete"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Delete Project by ID",
"tags": [
"Projects"
]
},
"get": {
"operationId": "getProject",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ProjectResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"project.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get Project by ID",
"tags": [
"Projects"
]
},
"put": {
"operationId": "updateProject",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ProjectRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/ProjectResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"project.update"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Update a Project",
"tags": [
"Projects"
]
}
},
"/v2/projects/{project_id}/presentations": {
"get": {
"operationId": "getProjectPresentations",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/PresentationsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"presentation.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get a paginated list of Presentations",
"tags": [
"Presentations"
]
}
},
"/v2/assets/{asset_id}/children": {
"get": {
"operationId": "getAssets",
"parameters": [
{
"in": "path",
"name": "asset_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "include_deleted",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/AssetsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get Assets for a Review Link",
"tags": [
"Assets"
]
},
"post": {
"operationId": "createAsset",
"parameters": [
{
"in": "path",
"name": "asset_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/AssetCreateRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/AssetResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"asset.create"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Create an Asset",
"tags": [
"Assets"
]
}
},
"/v2/comments/{id}": {
"delete": {
"operationId": "deleteComment",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/CommentResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"comment.delete"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Delete a Comment",
"tags": [
"Comments"
]
},
"get": {
"operationId": "getComment",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "include",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/CommentResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"comment.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get a Comment by ID",
"tags": [
"Comments"
]
},
"put": {
"operationId": "updateComment",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/CommentRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/CommentResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"comment.update"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Update a Comment",
"tags": [
"Comments"
]
}
},
"/v2/teams/{team_id}/members": {
"post": {
"operationId": "addTeamMember",
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/TeamMemberRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/TeamMemberResonse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"team.update"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Add a team member",
"tags": [
"Teams"
]
}
},
"/v2/review_links/{id}": {
"delete": {
"operationId": "reviewLinkDelete",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ReviewLinkResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"reviewlink.delete"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Delete a Review Link",
"tags": [
"Review Links"
]
},
"get": {
"operationId": "reviewLinkGet",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "include",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ReviewLinkResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"reviewlink.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get a Review Link",
"tags": [
"Review Links"
]
},
"put": {
"operationId": "reviewLinkUpdate",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ReviewLinkUpdateRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/ReviewLinkResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"reviewlink.update"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Update a Review Link",
"tags": [
"Review Links"
]
}
},
"/v2/review_links/{review_link_id}/items": {
"get": {
"operationId": "reviewLinkItemsList",
"parameters": [
{
"in": "path",
"name": "review_link_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "include",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ReviewLinkItemsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"reviewlink.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get items in a Review Link",
"tags": [
"Review Links"
]
}
},
"/v2/presentations/{id}": {
"delete": {
"operationId": "deletePresentation",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/PresentationResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"presentation.delete"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Delete a Presentation",
"tags": [
"Presentations"
]
},
"get": {
"operationId": "showPresentation",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/PresentationResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"presentation.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Show a Presentation",
"tags": [
"Presentations"
]
},
"put": {
"operationId": "updatePresentation",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/PresentationUpdateRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/PresentationResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"presentation.update"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Update a Presentation",
"tags": [
"Presentations"
]
}
},
"/v2/teams/{id}": {
"get": {
"operationId": "getTeam",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "include",
"schema": {
"enum": [
"account",
"user_role"
],
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/TeamResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"team.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get a Team",
"tags": [
"Teams"
]
}
},
"/v2/assets/{asset_id}/presentations": {
"get": {
"operationId": "getAssetPresentations",
"parameters": [
{
"in": "path",
"name": "asset_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/PresentationsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"presentation.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get a paginated list of Presentations",
"tags": [
"Presentations"
]
},
"post": {
"operationId": "createPresentation",
"parameters": [
{
"in": "path",
"name": "asset_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/PresentationCreateRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/PresentationResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"presentation.create"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Create a Presentation",
"tags": [
"Presentations"
]
}
},
"/v2/teams/{team_id}/hooks": {
"post": {
"operationId": "createWebhookForTeam",
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/WebhookRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/WebhookResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"UserTokenAuth": []
}
],
"summary": "Create team webhook",
"tags": [
"Webhooks"
]
}
},
"/v2/presentations": {
"get": {
"operationId": "getUserPresentations",
"parameters": [],
"responses": {
"200": {
"$ref": "#/components/responses/PresentationsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"presentation.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get a paginated list of Presentations",
"tags": [
"Presentations"
]
}
},
"/v2/assets/{asset_id}/comments": {
"get": {
"operationId": "getComments",
"parameters": [
{
"in": "path",
"name": "asset_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "include",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/CommentsResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"comment.read"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Get comments by asset or get replies by comment.\n\n This endpoint will return all comments and replys in a flat list.\n ",
"tags": [
"Comments"
]
},
"post": {
"operationId": "createComment",
"parameters": [
{
"in": "path",
"name": "asset_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/CommentRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/CommentResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"comment.create"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Create a Comment",
"tags": [
"Comments"
]
}
},
"/v2/comments/{comment_id}/complete": {
"delete": {
"operationId": "uncompleteComment",
"parameters": [
{
"in": "path",
"name": "comment_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/CommentResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"comment.update"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Mark a Comment as uncompleted\n",
"tags": [
"Comments"
]
},
"post": {
"operationId": "completeComment",
"parameters": [
{
"in": "path",
"name": "comment_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/CommentResponse"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"JWTAuth": []
},
{
"OAuth": [
"comment.update"
]
},
{
"UserTokenAuth": []
}
],
"summary": "Mark a Comment as completed\n",
"tags": [
"Comments"
]
}
}
},
"servers": [
{
"url": "https://api.frame.io"
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment