overlay: 1.0.0
info:
title: API Evangelist enhancements for Vidmob Public API (Organization & Workspaces)
version: 1.0.0
extends: openapi/vidmob-public-api-openapi.json
x-generated: '2026-08-05'
x-method: generated
x-source: >-
Enhancements derived from the Vidmob developer documentation
(https://vidmob-api-docs.readme.io/docs/api-reference) and the artifacts in this repo.
actions:
- target: $.info
update:
description: >-
Account-hierarchy endpoints used to bootstrap every Vidmob integration: retrieve the organization the API key
is issued against, and enumerate the workspaces that key can reach along with the workspaceId values required
by the scoring and criteria endpoints.
contact:
name: Vidmob Support
email: support@vidmob.com
url: https://help.vidmob.com/en/
x-apievangelist-slug: vidmob
x-apievangelist-data-model: data-model/vidmob-data-model.yml
- target: $.servers
update:
- url: https://public-api.vidmob.com
description: Production
- target: $.components.securitySchemes.sec0
update:
description: >-
Organization-scoped API key sent as `Authorization: Bearer <api-key>`. These operations require a valid key but
no specific scope.
- target: $.paths['/v1/organization'].get
update:
x-bootstrap: true
x-note: Call this first to confirm access and retrieve the workspaceId values every other operation needs.
- target: $.paths['/v1/workspaces'].get
update:
x-operationid-note: >-
The published operationId is `get-organization-copy`, an artifact of the docs tooling — it lists workspaces,
not organizations. Reported to the provider surface as a naming defect; not corrected in the harvested spec.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.