generated: '2026-07-21'
method: searched
source: https://developer.vidgrid.com/docs/v2/
description: >-
  Cross-cutting request/response semantics of the VidGrid Content Management API v2 —
  authentication style, pagination, field expansion, error envelope, rate-limit
  signaling, and versioning — as documented in the v2 API reference and implied by
  openapi/vidgrid-openapi-original.json.

base_url: https://api.vidgrid.com/ContentManagement
api_style: REST over HTTPS, JSON requests and responses; server-side use only (keys must never be exposed client side)

authentication:
  scheme: HTTP Basic — API key as username, API secret as password, base64-encoded in the Authorization header
  header: "Authorization: Basic {base64(key:secret)}"
  key_location: https://app.vidgrid.com/integrations
  docs: https://developer.vidgrid.com/docs/v2/
  detail: authentication/vidgrid-authentication.yml

idempotency:
  supported: false
  note: No idempotency-key mechanism is documented in the v2 reference or declared in the OpenAPI.

pagination:
  style: page
  scope: search endpoint only (GET /vidgrid/v2/search/{resource})
  request_params:
    page: page number to return
    "filter[]": filter to apply to the search
  note: List/retrieve endpoints return arrays without documented cursor or page parameters.

field_expansion:
  supported: true
  mechanism: "include[] query parameter on GET /vidgrid/v2/videos/{identifier}"
  note: An array of properties (e.g. captions, events, metadata) to be included with returned Video Resources.

batch_retrieval:
  mechanism: "identifiers[] query parameter on GET /vidgrid/v2/videos — takes priority over the path identifier"

response_envelope:
  success: '{"data": {...}} for single resources; {"data": [{...}]} arrays on GET requests'
  error: '{"message": "A message explaining what went wrong."}'
  detail: errors/vidgrid-problem-types.yml

request_tracing:
  supported: false
  note: No request-id header is documented.

versioning:
  scheme: uri-path
  current: v2
  path_prefix: /vidgrid/v2/
  legacy: v1 (https://developer.vidgrid.com/docs/v1/ — marked "an older version of the API")
  detail: lifecycle/vidgrid-lifecycle.yml

rate_limits:
  default: 60 requests per minute
  headers: [X-RateLimit-Limit, X-RateLimit-Remaining]
  detail: rate-limits/vidgrid-rate-limits.yml

webhooks:
  configured_at: https://app.vidgrid.com/webhooks
  extras: webhook_extras on POST /vidgrid/v2/tokens attaches custom data to fired events
  detail: asyncapi/vidgrid-webhooks.yml