Get Project Status

This endpoint will return a json with the information corresponding to a project ID. For example if you created auto-edited clips via the ‘Create Auto Edited Clips’ endpoint, this endpoint’s response will provide the clips, hashtags, description, virality score etc. It’s recommended to call this endpoint once every 5 seconds for best performance.

GEThttp://api.spikes.studio/api/v1/api/project

Required Parameters

Name
id
Type
string
Description
Project unique identifier

Response

Name
clips
Type
array
Description
Fields are relevant according to the corresponding APIs
Name
createdAt
Type
bigInt
Description
Name
updatedAt
Type
bigInt
Description
Name
id
Type
string
Description
The clip ID
Name
name
Type
string
Description
Title of the clip
Name
desktop_download_url
Type
string
Description
The link to the auto-edited clip
Name
mobile_download_url
Type
string
Description
The link to the auto-edited clip (9:16)
Name
thumbnail_url
Type
string
Description
Thumbnail reflecting the original video
Name
mobile_thumbnail_url
Type
string
Description
Thumbnail reflecting the original video
Name
status
Type
string
Description
The status of the project. Ready when it is done.
Name
clip_ranking
Type
int
Description
How good the clip will do on social media (0-100)
Name
duration
Type
int/float
Description
The clip’s duration
Name
platform_url
Type
string
Description
The original video URL
Name
tags
Type
string
Description
Array of hashtags
Name
description
Type
string
Description
Clip description suitable for social media
Name
headline
Type
string
Description
Title of the clip (sometimes name is empty and headline is full)
Name
summary
Type
string
Description
Summary of the clip content. Different angle than description
Name
streamer
Type
string
Description
User ID
Name
upload
Type
string
Description
The project’s ID
Name
timestamps
Type
array
Description
Relevant for project timestamps API (not for auto edited clips endpoint)
Name
id
Type
string
Description
Name
timestamps
Type
json
Description
Name
start_time
Type
string
Description
time in the format HH:MM:SS
Name
end_time
Type
string
Description
time in the format HH:MM:SS
Name
title
Type
string
Description
clip title
Name
hashtags
Type
array
Description
clip hashtags
Name
description
Type
string
Description
clip description
Name
virality_score
Type
int
Description
how good the clip will be on social media (0-100)
Name
streamer
Type
json
Description
user’s id
Name
upload
Type
json
Description
project’s id
Name
createdAt
Type
bigInt
Description
Name
updatedAt
Type
bigInt
Description
Name
id
Type
string
Description
Project Identifier
Name
platform
Type
string
Description
Youtube/Google Drive Share Link/Personal(an original upload)
Name
platfrom_url
Type
string
Description
The original video URL
Name
download_url
Type
string
Description
The original video download URL
Name
channel_name
Type
string
Description
If you uploaded a youtube link, here you will find the channel name. In case of a personal or google drive upload, you will find here your own username.
Name
channel_id
Type
string
Description
Channel id in the platform.
Name
thumbnail_url
Type
string
Description
Thumbnail reflecting the original video.
Name
duration
Type
int/float
Description
The clip’s duration.
Name
title
Type
string
Description
The project’s title in the platform.
Name
platform_video_id
Type
string
Description
Parameter description - id of the video within the platform (not relevant for personal uploads).
Name
total_views
Type
int
Description
Amount of views of the video in the platform (not relevant for personal uploads).
Name
status
Type
string
Description
Internal status of the project in our system. ‘Ready’ when the project has at least 1 clip ready. Important to mention that more clips can show up with time (not more than 15 minutes).
Name
style_properties
Type
string
Description
Style properties of the project which indicates the design of the template for the auto edited clips.

Request

GET

http://api.spikes.studio/api/v1/api/project

  http://api.spikes.studio/api/v1/api/project?id=d5202669-8785-4040-bb17-15ec5b6fe0e9

Response

  {
      "createdAt": 1714494078230,
      "updatedAt": 1714494089391,
      "id": "d5202669-8785-4040-bb17-15ec5b6fe0e9",
      "platform": "youtube",
      "platform_url": "https://www.youtube.com/watch?v=pLPpl2ISKTg&ab_channel=LastWeekTonight",
      "download_url": "https://s3-us-east-2.amazonaws.com/spikes-upload-files-pro-staging/upload_clips/d5202669-8785-4040-bb17-15ec5b6fe0e9.mp4",
      "create_date": "1709208047000",
      "channel_name": "LastWeekTonight",
      "channel_id": "UC3XTzVzaHQEd30rQbuvCtTQ",
      "thumbnail_url": "https://i.ytimg.com/vi/pLPpl2ISKTg/maxresdefault.jpg",
      "duration": 1467,
      "title": "Pig Butchering Scams: Last Week Tonight with John Oliver (HBO)",
      "platform_video_id": "pLPpl2ISKTg",
      "total_views": 4854988,
      "status": "platform_upload_finished",
      "upload_mode": "spikes_API-project_timestamps",
      "is_active": true,
      "style_properties": null,
      "streamer": "a7bf3aa3-2310-4081-8860-be9ae8a9d307"
      "clips": [
          {
              "createdAt": 1714494243394,
              "updatedAt": 1714494306917,
              "id": "10d69196-7efe-4de8-9367-d111e8e44228",
              "name": "A Comedian's Tribute to Decency in Politics at the White House Correspondents’ Dinner",
              "desktop_download_url": "https://hype-clips-pro-staging.s3.us-east-2.amazonaws.com/tmp//a7bf3aa3-2310-4081-8860-be9ae8a9d307_638500910128213466_cropped_1714494246559_desktop.mp4",
              "mobile_download_url": "https://hype-clips-pro-staging.s3.us-east-2.amazonaws.com/tmp//a7bf3aa3-2310-4081-8860-be9ae8a9d307_638500910128213466_cropped_1714494246559_mobile.mp4",
              "thumbnail_url": "https://spikes-thumbnails-pro-staging.s3.us-east-2.amazonaws.com/tmp//a7bf3aa3-2310-4081-8860-be9ae8a9d307_638500910128213466_cropped_1714494246559_desktop.jpg",
              "mobile_thumbnail_url": "https://spikes-thumbnails-pro-staging.s3.us-east-2.amazonaws.com/tmp//a7bf3aa3-2310-4081-8860-be9ae8a9d307_638500910128213466_cropped_1714494246559_mobile.jpg",
              "status": "ready",
              "clip_ranking": 85,
              "duration": 38.2,
              "platform_url": "https://www.youtube.com/watch?v=S28SAhhA4XU&ab_channel=ABCNews",
              "tags": "['#decency', '#democraticmachine', '#freedom', '#journalists', '#Newsmax']",
              "description": "Speech about democracy and decency at Newsmax Afterparty",
              "headline": "A Comedian's Tribute to Decency in Politics at the White House Correspondents’ Dinner",

              "summary": null,
              "streamer": "a7bf3aa3-2310-4081-8860-be9ae8a9d307",
              "upload": "4b6597bb-62f4-4a36-82ea-3baf90c9894f"
          }
      ],
      "timestamps": [
          {
              "createdAt": 1714494240079,
              "updatedAt": 1714494240079,
              "id": "5450cba3-55d1-4d84-97ac-8ebec2169857",
              "timestamps": {
                  "start_time": "00:20:02",
                  "end_time": "00:21:35",
                  "title": "The Brutal Truth of Life Inside Scam Compounds",
                  "hashtags": [
                      "Cambodia",
                      "humantrafficking",
                      "abuse",
                      "scams",
                      "awareness"
                  ],
                  "description": "Exposing exploitation in Cambodia's peat industry.",
                  "virality_score": 90
              },
              "streamer": "a7bf3aa3-2310-4081-8860-be9ae8a9d307",
              "upload": "d5202669-8785-4040-bb17-15ec5b6fe0e9"
          },
      ],
    }

Errors

Name
400 Bad Request
Description
The request was malformed or missing required parameters.
Name
401 Unauthorized
Description
The API key provided was invalid or missing.
Name
404 Not Found
Description
The requested resource was not found.
Name
500 Internal Server Error
Description
500 Internal Server Error