Gumlet Global Search API
Search all video assets / playlists / folders etc across workspaces.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/gumlet-global-search-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Gumlet Global Search API
description: Gumlet helps developers deliver online video and images. This API encompasses Gumlet Video, Image and Video Analytics functionality to help you build your products better and faster than ever before.
version: '1.4'
contact:
name: Gumlet Support Team
url: https://www.gumlet.com/contact/
email: support@gumlet.com
termsOfService: https://www.gumlet.com/terms/
license:
name: Apache 2.0
url: https://opensource.org/license/apache-2.0
x-scalar-sdk-installation:
- lang: TypeScript
description: '```sh
npm install @gumlet/nodejs-sdk
```'
- lang: Python
description: '```sh
pip install gumlet
```'
servers:
- url: https://api.gumlet.com/v1
security:
- API_KEY: []
tags:
- name: Global Search
description: Search all video assets / playlists / folders etc across workspaces.
paths:
/entities/global-search:
get:
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
all_folders:
type: array
items:
type: object
properties:
id:
type: string
description: Folder ID
created_at:
type: integer
format: int64
description: Created at timestamp in milliseconds since epoch
updated_at:
type: integer
format: int64
description: Updated at timestamp in milliseconds since epoch
workspace_id:
type: string
description: Workspace ID in which the folder resides
highlight:
type: array
items:
type: object
properties:
score:
type: number
description: Search ranking score
path:
type: string
description: Which field to highlight
texts:
type: array
items:
type: object
properties:
value:
type: string
description: The word to highlight or not
type:
type: string
enum:
- hit
- text
x-apidog-enum:
- value: hit
name: ''
description: ''
- value: text
name: ''
description: ''
description: Whether this word needs highlight
x-apidog-orders:
- value
- type
required:
- value
- type
x-apidog-orders:
- score
- path
- texts
required:
- score
- path
- texts
x-apidog-orders:
- id
- created_at
- updated_at
- workspace_id
- highlight
required:
- id
- created_at
- updated_at
- workspace_id
- highlight
description: Result array of all folders
all_assets:
type: array
items:
type: object
properties:
id:
type: string
description: Asset ID
title:
type: string
description: Asset Title
tags:
type: array
items:
type: string
description: List of tags applied to this asset
workspace_id:
type: string
description: Workspace ID on in which this asset resides
created_at:
type: integer
description: Created at timestamp in milliseconds since epoch
format: int64
updated_at:
type: integer
description: Updated at timestamp in milliseconds since epoch
format: int64
highlight:
type: array
items:
type: object
properties:
score:
type: number
description: Search ranking score
path:
type: string
description: Which field to highlight
texts:
type: array
items:
type: object
properties:
value:
type: string
description: The word to highlight or not
type:
type: string
enum:
- hit
- text
x-apidog-enum:
- value: hit
name: ''
description: ''
- value: text
name: ''
description: ''
description: Whether this word needs highlight
x-apidog-orders:
- value
- type
required:
- value
- type
x-apidog-orders:
- score
- path
- texts
required:
- score
- path
- texts
x-apidog-orders:
- id
- title
- tags
- workspace_id
- created_at
- updated_at
- highlight
required:
- id
- title
- tags
- workspace_id
- created_at
- updated_at
- highlight
description: Result array of all assets
all_playlists:
type: array
items:
type: object
properties:
id:
type: string
description: Playlist ID
title:
type: string
description: Playlist title
description:
type: string
description: Playlist description
created_at:
type: integer
description: Created at timestamp in milliseconds since epoch
format: int64
updated_at:
type: integer
description: Updated at timestamp in milliseconds since epoch
format: int64
workspace_id:
type: string
description: Workspace ID on in which this playlist resides
highlight:
type: array
items:
type: object
properties:
score:
type: number
description: Search ranking score
path:
type: string
description: Which field to highlight
texts:
type: array
items:
type: object
properties:
value:
type: string
description: The word to highlight or not
type:
type: string
enum:
- hit
- text
x-apidog-enum:
- value: hit
name: ''
description: ''
- value: text
name: ''
description: ''
description: Whether this word needs highlight
x-apidog-orders:
- value
- type
required:
- value
- type
x-apidog-orders:
- score
- path
- texts
required:
- score
- path
- texts
x-apidog-orders:
- id
- title
- description
- created_at
- updated_at
- workspace_id
- highlight
required:
- id
- title
- description
- created_at
- updated_at
- workspace_id
- highlight
description: Result array of all playlists
all_channels:
type: array
items:
type: object
properties:
title:
type: string
description: Channel title
description:
type: string
description: Channel description
created_at:
type: integer
description: Created at timestamp in milliseconds since epoch
format: int64
updated_at:
type: integer
description: Updated at timestamp in milliseconds since epoch
format: int64
workspace_id:
type: string
description: Workspace ID on in which this channel resides
highlight:
type: array
items:
type: object
properties:
score:
type: number
description: Search ranking score
path:
type: string
description: Which field to highlight
texts:
type: array
items:
type: object
properties:
value:
type: string
description: The word to highlight or not
type:
type: string
enum:
- hit
- text
x-apidog-enum:
- value: hit
name: ''
description: ''
- value: text
name: ''
description: ''
description: Whether this word needs highlight
x-apidog-orders:
- value
- type
required:
- value
- type
x-apidog-orders:
- score
- path
- texts
required:
- score
- path
- texts
x-apidog-orders:
- title
- description
- created_at
- updated_at
- workspace_id
- highlight
required:
- title
- description
- created_at
- updated_at
- workspace_id
- highlight
description: Result array of all channels
x-apidog-orders:
- all_folders
- all_assets
- all_playlists
- all_channels
required:
- all_folders
- all_assets
- all_playlists
- all_channels
'400':
description: Bad Request
content:
application/json:
examples:
Result:
value:
error:
code: parameter_missing
message: One or more required values are missing.
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: parameter_missing
message:
type: string
example: One or more required values are missing.
required:
- code
- message
required:
- error
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
summary: Global Search
tags:
- Global Search
operationId: global-search
description: Search all video assets / playlists / folders etc across workspaces.
parameters:
- in: query
name: search_query
schema:
type: string
required: true
description: Search query term
- in: query
name: collection_id
schema:
type: string
description: Workspace ID if you want to limit search to a specific workspace
- in: query
name: size
schema:
type: integer
default: 20
description: Number of results to return
- in: query
name: assets_offset
schema:
type: integer
default: 0
description: Offset for assets
- in: query
name: folders_offset
schema:
type: integer
default: 0
description: Offset for folders
- in: query
name: playlists_offset
schema:
type: integer
default: 0
description: Offset for playlists
- in: query
name: channels_offset
schema:
type: integer
default: 0
description: Offset for channels
x-codeSamples:
- label: TypeScript
lang: TypeScript
source: "import Gumlet from '@gumlet/nodejs-sdk';\n\nconst client = new Gumlet({\n apiKey: process.env['API_KEY'], // defaults to the API_KEY env var\n});\n\nconst globalSearch = await client.globalSearch.search({\n search_query: 'searchQuery',\n size: 20,\n assets_offset: 0,\n folders_offset: 0,\n playlists_offset: 0,\n channels_offset: 0,\n});\n\nconsole.log(globalSearch);"
- label: Python
lang: Python
source: "import os\n\nfrom gumlet import Gumlet\n\nclient = Gumlet(\n api_key=os.environ.get(\"API_KEY\"),\n)\n\nglobal_search = client.global_search.search(\n search_query=\"search_query\",\n size=20,\n assets_offset=0,\n folders_offset=0,\n playlists_offset=0,\n channels_offset=0,\n)\n\nprint(global_search)"
components:
schemas:
Error:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
properties:
code:
type: string
description: Machine-readable error code
message:
type: string
description: Human-readable error message
param:
type: string
description: Optional parameter name related to the error
responses:
Unauthorized:
description: Unauthorized — missing or invalid API key / bearer token
content:
application/json:
examples:
Result:
value:
error:
code: invalid_api_key
message: API key supplied with request is invalid
schema:
$ref: '#/components/schemas/Error'
Forbidden:
description: Forbidden — unpaid account or insufficient role permissions
content:
application/json:
examples:
Result:
value:
error:
code: unauthorized
message: You don't have access to this feature. Please contact your organization owner.
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
API_KEY:
type: http
scheme: bearer
x-tagGroups:
- name: Video on Demand
tags:
- Video Assets
- Global Search
- Multipart Upload
- Audio Upload
- Subtitle Upload
- Recycle Bin
- Video Workspaces
- Folders
- Video Playlists
- Channel Viewers
- Video Usage Analytics
- Video Profiles
- Webhooks
- name: Live Streams
tags:
- Live Stream Workspaces
- Live Stream Assets
- Live Stream Analytics
- name: Image APIs
tags:
- Image Sources
- Image Usage Analytics
- name: Video Analytics
tags:
- Video Analytics
- name: Webhooks
tags:
- Webhooks
- name: Account Endpoints
tags:
- User Data
- Billing
- Organization Data
- Audit Logs
x-ext-urls: {}