Upload Management

This section documents the endpoints available for managing and retrieving information about your uploads.

Base URL

https://api.multi-upload-tool.com/api/v1

Authentication

All requests require an API Token in the header: x-api-key: YOUR_API_TOKEN

List Uploads

Retrieve a list of posts you have uploaded. Supports pagination and filtering.

Endpoint

GET /upload

Query Parameters

Parameter	Type	Required	Description
`page`	number	No	Page number (default: 1).
`limit`	number	No	Items per page (default: 100, max: 1000).
`platform`	string	No	Filter by platform (`tiktok`, `youtube`).
`status`	string	No	Filter by status (`pending`, `processing`, `completed`, `failed`, `scheduled`).
`search`	string	No	Search by title.
`startDate`	string (ISO)	No	Filter by uploaded/scheduled/created on or after date.
`endDate`	string (ISO)	No	Filter by uploaded/scheduled/created on or before date.

Example Request


curl -X GET "https://api.multi-upload-tool.com/api/v1/upload?page=1&limit=10&platform=tiktok" \
  -H "x-api-key: YOUR_API_TOKEN"

Example Response


{
  "success": true,
  "data": [
    {
      "id": 456,
      "title": "My amazing video",
      "platform": "tiktok",
      "status": "completed",
      "uploadedAt": "2023-10-27T10:00:00.000Z",
      "thumbnailUrl": "https://...",
      "videoUrl": "https://...",
      "fileSize": "12345678",
      "connectedAccount": {
        "id": 123,
        "platform": "tiktok",
        "accountName": "brand account",
        "profileImageUrl": "https://...",
        "tags": "team,marketing"
      },
      "metadata": { "videoId": "73123456789" }
    }
  ],
  "pagination": {
    "total": 50,
    "page": 1,
    "limit": 10,
    "totalPages": 5
  }
}

Get Upload Details

Retrieve details for a specific upload.

Endpoint

GET /upload/:id

Example Request


curl -X GET "https://api.multi-upload-tool.com/api/v1/upload/456" \
  -H "x-api-key: YOUR_API_TOKEN"

Example Response


{
  "success": true,
  "data": {
    "id": 456,
    "platform": "tiktok",
    "title": "My amazing video",
    "description": "Check this out!",
    "status": "completed",
    "uploadedAt": "2023-10-27T10:00:00.000Z",
    "thumbnailUrl": "https://...",
    "videoUrl": "https://...",
    "connectedAccount": {
      "id": 123,
      "platform": "tiktok",
      "accountName": "brand account",
      "profileImageUrl": "https://..."
    },
    "metadata": {
      "videoId": "73123456789",
      "shareUrl": "https://www.tiktok.com/@user/video/73123456789"
    }
  }
}

Update Upload

Update details of an upload (e.g. retry a failed upload or update metadata).

Endpoint

PATCH /upload/:id

Only uploads in scheduled status can be updated.

Body Parameters

Parameter	Type	Required	Description
`title`	string	No	Update the title.
`description`	string	No	Update the description.
`scheduledFor`	string (ISO)	No	Update scheduled publish time.
`status`	string	No	Update status (e.g. cancel scheduled).

Example Request


curl -X PATCH "https://api.multi-upload-tool.com/api/v1/upload/456" \
  -H "x-api-key: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title": "Updated Title", "scheduledFor": "2023-10-30T12:00:00.000Z"}'

Example Response


{
  "success": true,
  "data": {
    "id": 456,
    "title": "Updated Title",
    "status": "scheduled",
    "scheduledFor": "2023-10-30T12:00:00.000Z"
  }
}

Get Upload Limits

Check upload limits for a specific account (e.g. YouTube daily quota).

Endpoint

GET /limits/:accountId

Example Request


curl -X GET "https://api.multi-upload-tool.com/api/v1/limits/123" \
  -H "x-api-key: YOUR_API_TOKEN"

Example Response


{
  "success": true,
  "data": {
    "remaining": 5,
    "limit": 10,
    "resetAt": "2023-10-28T00:00:00.000Z"
  }
}