Cloudglue

Cloudglue API

API for Cloudglue

AI & machine learning#openapi

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

API for Cloudglue

Endpoints 124

Tags

  • GETList all tags/tagsList all tags
  • POSTCreate a new tag/tagsCreate a new tag
  • GETGet a tag/tags/:tag_idGet a tag
  • PUTUpdate a tag/tags/:tag_idUpdate a tag
  • DELETEDelete a tag/tags/:tag_idDelete a tag

Extract

  • GETList all extract jobs/extractList all extract jobs with optional filtering
  • POSTCreate a new extract job/extractExtract structured data from a video
  • GETRetrieve the current state of an extraction job/extract/:job_idRetrieve the current state of an extraction job. Results are paginated with a default limit of 50 segment entities per request (maximum 100). Use limit and…
  • DELETEDelete an extraction job/extract/:job_idDelete an extraction job

Files

  • GETList files that have been uploaded to Cloudglue/filesList files that have been uploaded to Cloudglue
  • POSTUpload a video, audio, or image file that can be used with Cloudglue services/filesUpload a video, audio, or image file that can be used with Cloudglue services
  • POSTSync a public URL into a file/files/syncMaterialize a publicly accessible URL into a Cloudglue file without a data connector or a collection. Accepts direct http(s) video/audio file URLs (e.g.…
  • GETRetrieve details about a specific file/files/:file_idRetrieve details about a specific file
  • PUTUpdate a file/files/:file_idUpdate a file
  • DELETEDelete a file/files/:file_idDelete a file
  • POSTRefresh a file's connector source metadata/files/:file_id/syncRe-fetches the file's source_metadata live from its data connector (google-drive, dropbox, zoom, gong, recall, grain, or iconik) and updates the stored value.…
  • GETList segmentations for a file/files/:file_id/segmentationsList all segmentations for a specific file
  • POSTCreate a new segmentation for a file/files/:file_id/segmentationsCreate a new segmentation for a file using the specified segmentation configuration
  • GETGet thumbnails for a file/files/:file_id/thumbnailsGet all thumbnails for a file
  • GETList tags for a file/files/:file_id/tagsList all tags for a specific file
  • GETList file segments/files/:file_id/segmentsList all segments for a specific file
  • GETGet a file segment/files/:file_id/segments/:segment_idGet a file segment
  • PUTUpdate a file segment/files/:file_id/segments/:segment_idUpdate a file segment
  • GETList tags for a file segment/files/:file_id/segments/:segment_id/tagsList all tags for a specific file segment
  • GETList describes for a file segment/files/:file_id/segments/:segment_id/describesList all describe outputs for a specific file segment
  • GETGet describe for a file segment/files/:file_id/segments/:segment_id/describes/:job_idGet a specific describe output for a file segment by job ID
  • GETList frame extractions for a file/files/:file_id/framesList all frame extractions for a specific file
  • POSTCreate a new frame extraction for a file/files/:file_id/framesCreate a new frame extraction for a file using the specified frame extraction configuration. This is an async operation that returns immediately with a…

Collections

  • GETList all collections/collectionsList all collections
  • POSTCreate a new collection to organize and process video files/collectionsCreate a new collection to organize and process video files. Collections are used to group files together and process them in a consistent way.
  • GETRetrieve details about a specific collection/collections/:collection_idRetrieve details about a specific collection
  • PUTUpdate a collection/collections/:collection_idUpdate a collection
  • DELETEDelete a collection/collections/:collection_idDelete a collection
  • GETList all files in a collection/collections/:collection_id/videosList all files in a collection
  • POST[Deprecated] Add a video to a collection/collections/:collection_id/videosDeprecated. DEPRECATED: Use POST /collections/\{collection_id\}/media instead. Add a video to a collection. This endpoint is deprecated - use the /media…
  • GETRetrieve information about a specific video file in a collection/collections/:collection_id/videos/:file_idRetrieve information about a specific video file in a collection
  • DELETERemove a video file from a collection/collections/:collection_id/videos/:file_idRemove a video file from a collection
  • GETRetrieve extracted entities for a specific file in a collection/collections/:collection_id/videos/:file_id/entitiesRetrieve extracted entities for a specific file in a collection. Results are paginated with a default limit of 50 segment entities per request (maximum 100).…
  • GETRetrieve rich transcription data for a specific file in a collection/collections/:collection_id/videos/:file_id/rich-transcriptsRetrieve rich transcription data for a specific file in a collection. This API is only available when the a collection is created with collection_type…
  • POSTAdd a YouTube video to a collection/collections/:collection_id/youtubeDeprecated. Add a YouTube video to a collection by URL
  • GETList all extracted entities for files in a collection/collections/:collection_id/entitiesList all extracted entities for files in a collection. This API is only available when a collection is created with collection_type 'entities'
  • GETList all rich transcription data for files in a collection/collections/:collection_id/rich-transcriptsList all rich transcription data for files in a collection. This API is only available when a collection is created with collection_type 'rich-transcripts'
  • GETList all media description data for files in a collection/collections/:collection_id/media-descriptionsList all media description data for files in a collection. This API is only available when a collection is created with collection_type 'media-descriptions'
  • GETRetrieve media description data for a specific file in a collection/collections/:collection_id/videos/:file_id/media-descriptionsRetrieve media description data for a specific file in a collection. This API is only available when the collection is created with collection_type…
  • GETRetrieve face detections for a specific file in a collection/collections/:collection_id/videos/:file_id/face-detectionsRetrieve face detections for a specific file in a collection. Results are paginated with a default limit of 50 faces per request (maximum 100). Use limit and…
  • POSTAdd a media file to a collection/collections/:collection_id/mediaAdd a video or audio file to a collection. This is the recommended endpoint for adding media files to collections. Media Type Handling: Video files: Processed…
  • GETList moments in a moments collection/collections/:collection_id/momentsMoments across current collection members, with exact total. Default sort is positional (file_id, then start_time); criterion_score and rank_score sorts…
  • GETList findings in a moments collection/collections/:collection_id/moments/findings
  • POSTAttach a criterion to a moments collection/collections/:collection_id/moment-criteriaAdds a criterion attachment and backfills existing members. The attach response charges nothing (cost header 0); per-file runs charge as they execute, and a…
  • DELETEDetach a criterion from a moments collection/collections/:collection_id/moment-criteria/:attachment_idRemoves the attachment; its moments and findings leave collection enumeration. Underlying runs persist as job history.

Chat

  • GETList all chat completions/chat/completionsList all chat completions with optional filtering
  • POSTGenerate a model response to a conversation that can include references to video content/chat/completionsGenerate a model response to a conversation that can include references to video content
  • GETRetrieve a chat completion/chat/completions/:idRetrieve a chat completion

Transcribe

  • GETList all transcription jobs/transcribeList all transcription jobs with optional filtering
  • POSTCreate a new transcription job/transcribeCreates a new transcription job for video content. Note: For most use cases, you should use the /describe endpoint instead. This API will be deprecated in the…
  • GETRetrieve the current state of a transcription job/transcribe/:job_idRetrieve the current state of a transcription job

Describe

  • GETList all media description jobs/describeList all media description jobs with optional filtering
  • POSTCreate a new media description job/describeGet a comprehensive multimodal description of a video
  • GETRetrieve the current state of a media description job/describe/:job_idRetrieve the current state of a media description job
  • DELETEDelete a media description job/describe/:job_idDelete a media description job
  • PATCHUpdate describe job/describe/:job_idToggle the use_in_default_index flag on an existing describe job. Enabling this makes the file searchable by default in the deep search and response APIs.

Data Connectors

  • GETList all data connectors/data-connectorsList all active data connectors configured for your account
  • GETList files in a data connector/data-connectors/:id/filesBrowse files available in a connected data source. Returns URIs compatible with Cloudglue's file import system, and per-file provider metadata (see the…
  • POSTSync a data connector URI into a file/data-connectors/:id/syncMaterialize a connector URI (e.g. grain://recording/<id>) into a Cloudglue file without starting a downstream job. Idempotent: syncing the same URI returns…
  • GETLook up source metadata for a connector URI/data-connectors/:id/source-metadata?url=grain://recording/abc123Fetch source metadata for a connector URI directly from the upstream source, without creating a Cloudglue file. Supported for Grain, Zoom, Recall, Google…

Webhooks

  • GETList all webhooks/webhooksList all webhooks
  • POSTCreate a webhook/webhooksCreate a webhook
  • GETGet a webhook by ID/webhooks/:webhook_idGet a webhook by ID
  • PUTUpdate a webhook/webhooks/:webhook_idUpdate a webhook
  • DELETEDelete a webhook/webhooks/:webhook_idDelete a webhook

Search

  • GETGet a list of search responses/searchGet a list of search responses. Order by created_at in descending order by default.
  • POSTSearch across video files and segments to find relevant content/searchSearch for videos or video segments in collections to find relevant videos or moments/clips in a video
  • GETGet a search response by ID/search/:search_idGet a search response by search_id.

Response

  • GETList responses/responsesList all responses with pagination and filtering options.
  • POSTCreate a response/responsesCreate a new response using the Response API. This endpoint provides an OpenAI Responses-compatible interface for chat completions with video collections. The…
  • GETGet a response by ID/responses/:idRetrieve a specific response by its ID.
  • DELETEDelete a response/responses/:idDelete a response by ID. This operation is idempotent - deleting a non-existent response returns success.
  • POSTCancel a response/responses/:id/cancelCancel a background response that is in progress. If the response is already completed, failed, or cancelled, this returns the response as-is.

Deep Search

  • GETList deep searches/deepSearchList all deep searches with pagination and filtering options.
  • POSTCreate a deep search/deepSearchCreate a new deep search over one or more collections. Deep search uses agentic retrieval and LLM summarization to find specific moments across your video…
  • GETGet a deep search by ID/deepSearch/:idRetrieve a specific deep search by its ID.
  • DELETEDelete a deep search/deepSearch/:idDelete a deep search by ID. This operation is idempotent - deleting a non-existent deep search returns success.
  • POSTCancel a deep search/deepSearch/:id/cancelCancel a background deep search that is in progress. If the deep search is already completed, failed, or cancelled, this returns the deep search as-is.

Segmentations

  • GETGet a specific segmentation/segmentations/:segmentation_idRetrieve details about a specific segmentation including its segments
  • DELETEDelete a segmentation/segmentations/:segmentation_idDelete a specific segmentation
  • GETGet thumbnails for a segmentation/segmentations/:segmentation_id/thumbnailsGet all thumbnails for a segmentation
  • GETList describe jobs for a segmentation/segmentations/:segmentation_id/describesList all describe jobs that referenced the specified segmentation. Returns describe job records associated with the segmentation.

Frames

  • GETGet a specific frame extraction/frames/:frame_extraction_idRetrieve details about a specific frame extraction including its frames
  • DELETEDelete a frame extraction/frames/:frame_extraction_idDelete a specific frame extraction

Segments

  • GETList all segmentation jobs/segmentsList all segmentation jobs with optional filtering
  • POSTCreate a new segmentation job/segmentsCreate intelligent segments for video or audio files based on shot detection or narrative analysis. Audio File Support: Audio files support narrative criteria…
  • GETRetrieve the current state of a segmentation job/segments/:job_idRetrieve the current state of a segmentation job
  • DELETEDelete a segments job/segments/:job_idDelete a specific segments job

Face Match

  • GETList face match jobs/face-matchList all face match jobs
  • POSTFind matching face in video/face-matchSearch for a source face in a target video using facial recognition
  • GETGet face match results/face-match/:face_match_idRetrieve face match results including detected faces and similarity scores
  • DELETEDelete face match analysis/face-match/:face_match_idDelete a specific face match analysis

Face Detection

  • GETList face detection jobs/face-detectList all face detection jobs
  • POSTDetect faces in video/face-detectAnalyze video to detect all faces
  • GETGet face detection results/face-detect/:face_detection_idRetrieve face detection results including all detected faces
  • DELETEDelete face detection analysis/face-detect/:face_detection_idDelete a specific face detection analysis

Share

  • GETList shareable assets/shareList shareable assets
  • POSTCreate a shareable asset/shareCreate a shareable asset. Public assets (the default) are viewable by anyone with the link; private assets are restricted to members of the owning account and…
  • GETGet a shareable asset/share/:idGet a shareable asset. Optionally pass an instant-clip window (clip_start/clip_end) to receive a stream_url that plays only that window.
  • PUTUpdate a shareable asset/share/:idUpdate a shareable asset
  • DELETEDelete a shareable asset/share/:idDelete a shareable asset

Bulk Imports

  • GETList bulk imports/collections/:collection_id/importsList a collection's metadata imports, newest first, each with its latest run inline.
  • POSTCreate a bulk import/collections/:collection_id/importsCreate a bulk import: a saved definition that lists a data connector's source files and brings each match into the collection. What a run ingests follows the…
  • GETGet a bulk import/collections/:collection_id/imports/:import_idGet a metadata import definition with one page of its run history (newest first).
  • DELETEDelete a bulk import/collections/:collection_id/imports/:import_idDelete an import definition and its run history. Any active run is cancelled first. Imported files and collection memberships are never deleted by this…
  • POSTRun a bulk import/collections/:collection_id/imports/:import_id/runsTrigger a new run of a saved import. mode and delete_missing default to the definition's saved values. Only one run may be active per collection at a time, so…
  • POSTCancel a bulk import run/collections/:collection_id/imports/:import_id/runs/:run_id/cancelCancel an in-flight run. Files already imported by the run are kept. Cancelling an already-finished run is a no-op that returns the current state.

Query

  • GETList query results/queryList all query runs with pagination and filtering options. List items omit the columns and rows payloads — fetch an individual run via GET /query/{id} for the…
  • POSTRun a structured query/queryRun a synchronous read-only SQL query over the structured data extracted from one or more collections. Queries execute against three virtual tables — files,…
  • GETGet the query schema/query/schema?collections=stringIntrospect the virtual tables and per-collection extracted fields available to SQL queries over the given collections. Use this to discover column names,…
  • GETGet a query result by ID/query/:idRetrieve a stored query run by its ID, including its result rows. Results larger than the inline storage cap are replayed truncated (truncated: true).
  • POSTCancel a background export/query/:id/cancelCancel an in-progress background export. The run is marked cancelled synchronously, the export stream is aborted mid-flight (the partial upload is discarded),…

Find Moments

  • GETList find-moments runs/find-momentsLists runs, newest first, with cursor pagination. Pagination is over runs, never over joined moment rows.
  • POSTFind moments in a video/find-momentsRuns exhaustive moment discovery for one criterion over one video. Every accepted moment is persisted; ranking and truncation are read-time parameters on GET.…
  • GETGet a find-moments run/find-moments/:job_idReturns the run; when completed, includes moments and findings shaped by the read parameters. Selection never destroys accepted results: total_moments is…
  • DELETEDelete a find-moments run/find-moments/:job_idDeletes the run and its moments and findings. An in-flight run is cancelled and refunded; a completed run is not refunded.

Sites

  • GETList site route previews/sites/:site_id/route-previewsList the site's per-route unfurl previews, ordered by route.
  • PUTReplace site route previews/sites/:site_id/route-previewsReplace the site's complete set of per-route unfurl previews. Each entry maps a route within the site (e.g. a clip page) to its own preview card and hero…
  • DELETEDelete a site route preview/sites/:site_id/route-previews/:preview_idDelete one route preview. Links to that route fall back to the site-level preview fields at their next unfurl.

API details

Base URL
https://api.cloudglue.dev/v1
Authentication
A bearer token in the Authorization header
Operations
124 operations on 78 pathsGET 65POST 32DELETE 19PUT 7PATCH 1
2 marked deprecated
Main resources
Collections 22Files 19Describe 8Tags 7Bulk Imports 6File Segments 6Deep Search 5Query 5Response 5Share 5
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 0.7.33

How to test the Cloudglue API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Cloudglue API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List all tags” (GET /tags), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Cloudglue API?

API for Cloudglue It is listed under AI & machine learning and has 124 endpoints.

Who publishes the Cloudglue API?

It is listed from Cloudglue's public API description (an OpenAPI document), not published by Cloudglue on Swastik Codes. Anyone who controls cloudglue.dev can claim the profile by adding a DNS TXT record.

What is the base URL of the Cloudglue API?

Requests go to https://api.cloudglue.dev/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Cloudglue API?

With A bearer token in the Authorization header.

How many endpoints does the Cloudglue API have?

124 operations on 78 paths (65 GET, 32 POST, 19 DELETE, 7 PUT, 1 PATCH). The largest groups are Collections, Files, Describe, Tags.

Is forking the Cloudglue API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.