Get Upload

Endpoint

GET /upload/:uploadId

Description

This endpoint allows you to retrieve information about a specific upload task.

Authentication

Authentication is required for this endpoint. Include an API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Parameters

Parameter	Type	Required	Description
uploadId	string	Yes	The unique identifier of the upload task.

Response

Success Response

Code: 200 OK

Content example:

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "COMPLETE",
  "source": "YOUTUBE",
  "sourceUrl": "https://example.com/video.mp4",
  "sourceDuration": 600,
  "audioUrl": "https://example.com/audio.mp3",
  "audioDuration": 600,
  "videoUrl": "https://example.com/video_processed.mp4",
  "videoDuration": 600,
  "format": "VIDEO",
  "completionActions": {},
  "content": [
    {
      "id": "content-id-1",
      "type": "DISCUSSION QUESTIONS",
      "isRichText": true,
      "isPage": false,
      "created": "1999-04-18T12:05:00Z"
    },
    {
      "id": "content-id-2",
      "type": "SUMMARY",
      "isRichText": true,
      "isPage": false,
      "created": "1999-04-18T12:00:00Z"
    }
  ]
}

Property	Type	Description
id	string	The unique identifier of the upload task.
status	string	The current status of the upload task.
source	string	The source platform of the video (e.g., YOUTUBE, VIMEO).
sourceUrl	string	The original URL of the uploaded video.
sourceDuration	number	The duration of the source video in seconds.
audioUrl	string	The URL of the extracted audio file.
audioDuration	number	The duration of the audio file in seconds.
videoUrl	string	The URL of the processed video file.
videoDuration	number	The duration of the processed video in seconds.
format	string	The format of the uploaded video.
completionActions	object	Actions to be performed upon completion of the upload.
content	array	An array of content objects related to the upload.

Content Object

Property	Type	Description
id	string	The unique identifier of the content item.
type	string	The type of content (e.g., TRANSCRIPT, SUMMARY).
isRichText	boolean	Indicates if the content is in rich text format.
isPage	boolean	Indicates if the content is a full page.
created	string	The creation date and time of the content item in ISO 8601 format.

Notes

• The content array is sorted by creation date in descending order (newest first).
• The sourceDuration, audioDuration, and videoDuration are provided in seconds.
• The audioUrl and videoUrl fields provide direct access to the processed media files.

Error Responses

Unauthorized Error

Code: 401 Unauthorized

Content example:

{
  "error": "Unauthorized or missing upload ID"
}

Upload Not Found Error

Code: 404 Not Found

Content example:

{
  "error": "Upload not found"
}

Notes

• The API key used for authentication must match the initiator_id of the upload task.
• If the upload is not found or the API key doesn't match the initiator_id, appropriate error responses will be returned.