ContentGroove API
Overview The ContentGroove Developer API enables you to add the power of ContentGroove's video AI to your own applications and workflows. Webhooks are a way…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Overview
The ContentGroove Developer API enables you to add the power of ContentGroove's video AI to your own applications and workflows.
Webhooks are a way for ContentGroove to send video information
to your application, to update your system and/or trigger other business processes.
You can use Webhooks and the Developer API separately or together.
Getting Started with Webhooks
- Sign up for an account at app.contentgroove.com
- Read "Using Webhooks" on the API Reference page
- Visit the Webhooks page and create a new webhook
Using Webhooks
Webhooks, also known as callbacks, are a way for ContentGroove to notify your application as soon as possible after an event has occurred in ContentGroove.
For example after a media completes processing, ContentGroove can use a webhook to notify your application with information about the video: Suggested clips, transcription, and so on.
You can use the information sent to update your system and/or use the
webhook to trigger other business processes.
The webhook request is sent as an HTTP POST containing a payload of JSON-formatted data.
For the details of the payload format see the "CALLBACKS" sections below.
When your application receives the webhook request, it must respond with
a 200 HTTP status code (success).
If a 200 HTTP status code is not returned,
ContentGroove will assume that the webhook was not delivered and
will retry a limited number of times, using an exponential backoff algorithm.
ContentGroove makes a best effort to attempt to send the webhook at
least once.
Applications receiving webhooks must tolerate the
possibility of a single webhook payload being sent more than once
(idempotent behavior).
Applications receiving webhooks should tolerate the possibility that
a webhook could not be delivered
(for example your application was down when delivery was attempted).
Getting Started with the Developer API
- Sign up for an account at app.contentgroove.com
- Visit the API Keys page
- Create a new API Key then copy and save the value.
> ⚠️ IMPORTANT: This API Key is intended only for use on the server side. Be sure never to use a server-side API Key in client-side (web, mobile, or otherwise) code. ⚠️
- View all available endpoints, and try the API, on our API Reference page
Using the Developer API
- Create a new media (video or audio) in ContentGroove
- If the video or audio is available from a URL, you can create a media by providing the
source_urlparameter. ContentGroove will fetch the video or audio from the URL if possible. - Or, you can create a media from a video or audio file which you upload directly to ContentGroove (see File Uploading section below).
- After the new media is created, at first it will be in a "processing" state.
Depending on the size and duration of the video or audio file, it will take some time for processing to complete.
- You can use ContentGroove Webhooks to be notified immediately when processing has completed. (Details coming soon.)
- You can also use the API to read the state of the media, to determine if the media has completed processing yet.
- After the media has completed processing, you can access all of these details about the media:
- The media name and description
- The transcription of spoken words
- Topics and keywords which were discussed in the transcription
- Suggested video clips are automatically created
- In addition to the automatically created video clips, you can create more video clips from the media
Response Codes
The following is a comprehensive list of the status codes you may receive while using the ContentGroove API:
- 200 "Ok"
- The request was valid
- 400 "Bad Request
- This is returned when there was a problem parsing the JSON body of your request if you supplied the 'Content-Type': 'application/json' header, or if your request is missing the 'Content-Type' header altogether
- 401 "Unauthorized"
- This is returned when you are attempting to perform an action on a resource that you are not authorized to do
- 402 "Payment Required"
- This is returned when you are attempting to perform an action that would push your account above a usage limit. You can view your usage at: https://app.contentgroove.com/quota_usage
- 404 "Not Found"
- This is returned when the resource you are trying to view does not exist
- 429 "Too Many Requests"
- This is returned when you have performed too many requests within a given period of time
- 500 "Internal Server Error"
- This is returned when your request was valid but there was a problem on our end
File Uploading
- Step 1: Make a GET request to the direct uploads URL endpoint (/api/v1/direct_uploads) to receive an upload URL to…
Endpoints 15
- GETlist clips
/api/v1/clips?filter={ "filter[name_eq]": "john h. glenn, kindly air force base hospital", "filter[text_start]": "He landed in the sea" }&page={ "page[number]": 1, "page[size]": 5 }&sort=created_at - POSTcreate clip
/api/v1/clips - GETshow clip
/api/v1/clips/:id - PUTupdate clip
/api/v1/clips/:id - DELETEdelete clip
/api/v1/clips/:id - GETprepare presigned upload url
/api/v1/direct_uploads - GETlist medias
/api/v1/medias?filter={ "filter[name_eq]": "chimp into space", "filter[sourceUrl_start]": "https://archive.org" }&page={ "page[number]": 1, "page[size]": 5 }&sort=created_at - POSTcreate media
/api/v1/medias - GETshow media
/api/v1/medias/:id - PUTupdate media
/api/v1/medias/:id - DELETEdelete media
/api/v1/medias/:id - GETlist webhook subscriptions
/api/v1/webhook_subscriptions?filter={ "filter[name_eq]": "chimp into space" }&sort=created_at - POSTcreate webhook subscription
/api/v1/webhook_subscriptions - GETshow webhook subscription
/api/v1/webhook_subscriptions/:id - DELETEdelete webhook subscription
/api/v1/webhook_subscriptions/:id
API details
- Base URL
https://api.contentgroove.com- Authentication
- An API key in the Authorization header
- Operations
- 15 operations on 7 pathsGET 7POST 3DELETE 3PUT 2
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the ContentGroove API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the ContentGroove API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “list clips” (GET /api/v1/clips?filter={ "filter[name_eq]": "john h. glenn, kindly air force base hospital", "filter[text_start]": "He landed in the sea" }&page={ "page[number]": 1, "page[size]": 5 }&sort=created_at), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the ContentGroove API?
Overview The ContentGroove Developer API enables you to add the power of ContentGroove's video AI to your own applications and workflows. Webhooks are a way… It is listed under Other and has 15 endpoints.
Who publishes the ContentGroove API?
It is listed from Contentgroove's public API description (an OpenAPI document), not published by Contentgroove on Swastik Codes. Anyone who controls contentgroove.com can claim the profile by adding a DNS TXT record.
What is the base URL of the ContentGroove API?
Requests go to https://api.contentgroove.com. Endpoint paths are added to this base URL.
How do I authenticate with the ContentGroove API?
With an API key in the Authorization header.
How many endpoints does the ContentGroove API have?
15 operations on 7 paths (7 GET, 3 POST, 3 DELETE, 2 PUT).
Is forking the ContentGroove API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.