{"@context": "https://schema.org", "@type": "WebAPI", "name": "api.clarify.io API", "description": "The API to Search and Understand Audio & Video Data.", "provider": {"@type": "Organization", "name": "clarify.io"}, "documentation": "https://api.clarify.io/api-docs"}
The API to Search and Understand Audio & Video Data.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.clarify.io
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
The API to Search and Understand Audio & Video Data.
| method | path | what the vendor says it does |
|---|---|---|
GET | /v1/bundles | List bundles Gets the list of bundles. Links to each item are in the _links with link relation items.After get |
POST | /v1/bundles | Create a bundle Create a new bundle with the specified name, media url, and optional JSON metadata.name can be |
GET | /v1/bundles/{bundle_id} | Get a bundle Get a bundle that has previously been created. bundles |
PUT | /v1/bundles/{bundle_id} | Update a bundle Update a bundle. To update the tracks, media, or metadata of a bundle, use the tracks and meta |
DELETE | /v1/bundles/{bundle_id} | Delete a bundle Delete a bundle and its related metadata and tracks. This will only delete media stored on Cla |
GET | /v1/bundles/{bundle_id}/insights | Get bundle insights Gets the insights for a bundle.URLs of the available insights for the bundle are in the _l |
POST | /v1/bundles/{bundle_id}/insights | Request an insight to be run Request an insight to be run on a bundle. Note that most insights are set to auto |
GET | /v1/bundles/{bundle_id}/insights/{insight_id} | Get bundle insight Gets a particular insight for a bundle. Typically, you will hit this endpoint from a link c |
GET | /v1/bundles/{bundle_id}/metadata | Get bundle metadata Gets the metadata for a bundle. bundles |
PUT | /v1/bundles/{bundle_id}/metadata | Update bundle metadata Update the metadata for a bundle.The metadata is a single-level JSON object of your own |
DELETE | /v1/bundles/{bundle_id}/metadata | Delete bundle metadata Delete the metadata of a bundle and set data to {} (empty object.) This is functionally |
GET | /v1/bundles/{bundle_id}/tracks | Get bundle tracks Gets the array of tracks for a bundle. This includes the specification of the media and the |
POST | /v1/bundles/{bundle_id}/tracks | Add a track for a bundle Add a new track to a bundle. This will insert or append a new track in the tracks arr |
PUT | /v1/bundles/{bundle_id}/tracks | Update a tracks for a bundle Update tracks for a bundle.parts_complete a boolean true or false. If true, any t |
DELETE | /v1/bundles/{bundle_id}/tracks | Delete bundle tracks Delete tracks of a bundle. This will only delete media stored on Clarify systems and not |
GET | /v1/bundles/{bundle_id}/tracks/{track_id} | Get bundle track Gets a single track in a bundle. This includes the specification of the media and the status |
PUT | /v1/bundles/{bundle_id}/tracks/{track_id} | Add media to a track Add media to an existing track of a bundle. This can only be called on a track that curre |
DELETE | /v1/bundles/{bundle_id}/tracks/{track_id} | Delete a bundle track Delete a track of a bundle. This will only delete media stored on Clarify systems and no |
GET | /v1/reports/scores | Generate Group Report beta Analyzes bundle content over a series of time periods grouped by the value of group |
GET | /v1/reports/trends | Generate Trends Report beta Analyzes bundle content over a series of time periods and generates a trend report |
GET | /v1/search | Search bundles Searches the bundles and returns a list of matching bundles, along with what matched and where |
specification origin: https://api.clarify.io/api-docs
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.