Generate video upload URL

Creates a new video record and returns a presigned URL for uploading the video file to R2 storage. The URL expires after 20 minutes.

PUT/api/v1/{team_slug}/{app_slug}/videos
API
Management
Updated
Apr 26, 2026

management-api:PUT:/api/v1/{team_slug}/{app_slug}/videos

Creates a new video record and returns a presigned URL for uploading the video file to R2 storage. The URL expires after 20 minutes.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: PUT
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/videos
  • Summary: Generate video upload URL
  • Description: Creates a new video record and returns a presigned URL for uploading the video file to R2 storage. The URL expires after 20 minutes.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters2 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
Request bodyDocumented body
  • Required: Yes
  • Description: Video payload
  • Content: application/json (object)

Upload Video URL

PropertyTypeRequiredDetails
content_typestringYes-
descriptionstringNo-
filenamestringYes-
size_bytesintegerYes-
titlestringYes-
video_variantsobject[]No-

Video Variant

PropertyTypeRequiredDetails
formatstringYes-
heightintegerYes-
widthintegerYes-

Generated example (synthetic):

{
  "content_type": "string",
  "description": "string",
  "filename": "string",
  "size_bytes": 0,
  "title": "string",
  "video_variants": [
    {
      "format": "string",
      "height": 0,
      "width": 0
    }
  ]
}
Responses4 statuses
StatusDescriptionContent
200Presigned URL generated successfullyapplication/json (object)
400Invalid requestapplication/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Video URL Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Video URL
PropertyTypeRequiredDetails
constraintsobjectNo-
expires_atintegerNo-
idstringNo-
pathstringNo-
upload_urlstringNo-
Constraint
PropertyTypeRequiredDetails
allowed_typesstring[]No-
max_size_bytesintegerNo-

Generated example (synthetic):

{
  "data": {
    "constraints": {
      "allowed_types": [
        "string"
      ],
      "max_size_bytes": 0
    },
    "expires_at": 0,
    "id": "string",
    "path": "string",
    "upload_url": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: PUT
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/videos
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Videos
  • OpenAPI summary: Generate video upload URL

Generate video upload URL

# Generate video upload URL Creates a new video record and returns a presigned URL for uploading the video file to R2 storage. The URL expires after 20 minutes.
PUT /api/v1/{team_slug}/{app_slug}/videos
Purpose

Creates a new video record and returns a presigned URL for uploading the video file to R2 storage.

Required inputs

app_slug path team_slug path

Primary response

200 ยท Presigned URL generated successfully

Operation key

management-api:PUT:/api/v1/{team_slug}/{app_slug}/videos

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `PUT` - Path: `/api/v1/{team_slug}/{app_slug}/videos` - Summary: Generate video upload URL - Description: Creates a new video record and returns a presigned URL for uploading the video file to R2 storage. The URL expires after 20 minutes. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PUT:/api/v1/{team_slug}/{app_slug}/videos` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | ## Request body - Required: Yes - Description: Video payload - Content: application/json (object) ### Upload Video URL | Property | Type | Required | Details | | --- | --- | --- | --- | | `content_type` | string | Yes | - | | `description` | string | No | - | | `filename` | string | Yes | - | | `size_bytes` | integer | Yes | - | | `title` | string | Yes | - | | `video_variants` | object[] | No | - | #### Video Variant | Property | Type | Required | Details | | --- | --- | --- | --- | | `format` | string | Yes | - | | `height` | integer | Yes | - | | `width` | integer | Yes | - | **Generated example (synthetic):** ```json { "content_type": "string", "description": "string", "filename": "string", "size_bytes": 0, "title": "string", "video_variants": [ { "format": "string", "height": 0, "width": 0 } ] } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Presigned URL generated successfully | application/json (object) | | 400 | Invalid request | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Video URL Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Video URL | Property | Type | Required | Details | | --- | --- | --- | --- | | `constraints` | object | No | - | | `expires_at` | integer | No | - | | `id` | string | No | - | | `path` | string | No | - | | `upload_url` | string | No | - | ##### Constraint | Property | Type | Required | Details | | --- | --- | --- | --- | | `allowed_types` | string[] | No | - | | `max_size_bytes` | integer | No | - | **Generated example (synthetic):** ```json { "data": { "constraints": { "allowed_types": [ "string" ], "max_size_bytes": 0 }, "expires_at": 0, "id": "string", "path": "string", "upload_url": "string" }, "details": [ "string" ], "success": false } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `PUT` - Path: `/api/v1/{team_slug}/{app_slug}/videos` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PUT:/api/v1/{team_slug}/{app_slug}/videos` - OpenAPI tag: Videos - OpenAPI summary: Generate video upload URL