Import Videos

POST/api/2026-03/import/videos

public-api:write

Latest version

ACCESS_TOKEN=ey1234
curl -k -X POST "https://server.livingdocs.io/api/2026-03/import/videos" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  --data-binary @- << EOF
  {
    "systemName": "identifier-for-your-system",
    "webhook": "https://my-domain.com/webhooks/video-import",
    "videos": [
      {
        "url": "https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4",
        "id": "123abc",
        "fileName": "sample",
        "metadata": {
          "title": "sample video"
          "credit": "LC"
        }
      }
    ]
  }
  EOF

Request Body

JSON Body

Sent as JSON in the request body.

Parameter	Type	Description
`systemName`*	`string`	Identifier for the system you are importing from, e.g. an archive
`webhook`	`uri`	Endpoint at the importing system that gets notified by POST when import job is done. Notification contains the id of the import job, the state and an overview.
`context`	`object`	An object that is passed as context in the body of the request to the webhook. Limited to 8192 Bytes.
`videos`*	`array`	An array of videos to import. Each entry is an object with the following keys, all of which are required: url: a URL to a video file, must reference a video file with mimetype `video/`. id:* a unique id (stored as externalId in Livingdocs) that identifies the video on your end, must be unique within your project fileName: the title that the video should get in livingdocs metadata: An object of metadata according to your project config

Description

The video import does both create and update videos. The import remembers the externalId / systemName pair and if an import matches an existing pair, it will update (Hint: consider how to rebuild the externalId when you want to update videos). The video import in Livingdocs is asynchronous. You post a batch of videos that you want to import and get back an id with which you can query later to get your result.

Use Cases

Initial import from a legacy system

Responses

{
  "id": "25bzj8j"
}

GET/api/2026-03/import/videos/status

public-api:write

Latest version

ACCESS_TOKEN=ey1234
curl -k -X GET "https://server.livingdocs.io/api/2026-03/import/videos/status" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Query Parameters

Query String

Passed as URL query string. Comma-separated values for arrays (e.g. ?contentTypes=regular,author).

Parameter	Type	Description
`id`*	`string`	The id that Livingdocs provided you for your prior call to `/api/:apiVersion/import/videos`

Description

You can use this endpoint to check for the status and/or result of a video import.

Responses

{
  "finished": true,
  "state": "success",
  "id": "25bzj8j",
  "videos": [
    {
      "state": "success",
      "systemName": "identifier-for-your-system",
      "externalId": "external-unique-id-123",
      "video": {
        "mediaId": "jjiwhsf23kdk",
        "originalUrl": "https://livingdocs-videos.imgix.net/2019/11/21/a209790e-1549-46d9-b3c7-cefe28c7ea99.mp4",
        "mimeType": "video/mp4"
      }
    },
    {
      "state": "skipped",
      "reason": "already exists",
      "systemName": "identifier-for-your-system",
      "externalId": "external-unique-id-234",
      "video": {
        "mediaId": "jjiwhsf23wer",
        "originalUrl": "https://livingdocs-videos.imgix.net/2019/11/21/a209790e-1549-46d9-b3c7-cefe28c7ea99.mp4",
        "mimeType": "video/mp4"
      }
    },
    {
      "state": "failed",
      "reason": "Could not upload video",
      "systemName": "identifier-for-your-system",
      "externalId": "external-unique-id-345"
    }
  ]
}

{
  "finished": false,
  "state": "started",
  "id": "243kdc",
  "startedAt": "2020-01-01 13:45:12"
}

{
  "finished": true,
  "state": "failed",
  "id": "098shjhv9"
}