Documentation

API reference

Query video workspace capabilities

GET/v1/video-models

Returns executable presets and frame constraints by mode. Only complete presets may be used; do not mix parameters across modes.

Authentication and permissions

Use your current GloopAPI key. Available models, capabilities and permissions depend on its catalog and the endpoint documentation.

Authorization: Bearer $GLOOP_API_KEY

Authentication schemes: BearerAuth

Responses and errors

HTTP 200

Video workspace capabilities queried successfully

application/json

Type
object
Required fields
dataworkspace_enabledupload_enabledfile_storage_enabled
  • dataarrayRequired

    Array of data for the current page/catalog.

    data child fields (1)
    • []objectOptional
      [] child fields (6)
      • idstringRequired

        Public identifier of this object, used for its corresponding detail path.

      • namestringRequired

        Human-readable name.

      • capability_versionstringRequired

        Capability version of this public model.

      • modesarrayRequired

        Executable modes for this model and their respective complete parameter combinations.

        modes child fields (1)
        • []objectOptional
          [] child fields (9)
          • modestringRequired

            Execution mode.

          • presetsarrayRequired

            Complete executable parameter combinations; do not construct a Cartesian product across combinations.

            presets child fields (1)
            • []objectOptional
              [] child fields (4)
              • durationintegerOptionalAllows null

                Duration in seconds in the model preset.

              • resolutionstringOptional

                Resolution value in the model preset.

              • aspect_ratiostringOptional

                Aspect ratio value in the model preset.

              • generate_audiobooleanOptionalAllows null

                Whether this model preset generates audio.

          • audio_policystringRequired

            Audio field policy for the current mode.

          • aspect_policystringRequired

            Aspect ratio field policy for the current mode.

          • duration_policystringRequired

            Duration field policy for the current mode.

          • prompt_max_charsintegerRequired

            Maximum Unicode characters in the prompt for the current mode.

          • start_frameobjectOptional

            First frame constraints for the current mode.

            start_frame child fields (5)
            • requiredbooleanRequired

              Whether this mode requires the frame.

            • max_bytesintegerRequired

              Maximum file size in bytes allowed for this frame.

            • max_pixelsintegerRequired

              Maximum total pixel count allowed for this frame.

            • max_edgeintegerRequired

              Maximum pixel count on either side allowed for this frame.

            • content_typesarrayRequired

              Image MIME types allowed for this frame.

              content_types child fields (1)
              • []stringOptional
            allOf branch 1

            Type: object

            Required in this branch: required, max_bytes, max_pixels, max_edge, content_types

            • requiredbooleanRequired

              Whether this mode requires the frame.

            • max_bytesintegerRequired

              Maximum file size in bytes allowed for this frame.

            • max_pixelsintegerRequired

              Maximum total pixel count allowed for this frame.

            • max_edgeintegerRequired

              Maximum pixel count on either side allowed for this frame.

            • content_typesarrayRequired

              Image MIME types allowed for this frame.

              content_types child fields (1)
              • []stringOptional
          • end_frameobjectOptional

            Final frame constraints for the current mode.

            end_frame child fields (5)
            • requiredbooleanRequired

              Whether this mode requires the frame.

            • max_bytesintegerRequired

              Maximum file size in bytes allowed for this frame.

            • max_pixelsintegerRequired

              Maximum total pixel count allowed for this frame.

            • max_edgeintegerRequired

              Maximum pixel count on either side allowed for this frame.

            • content_typesarrayRequired

              Image MIME types allowed for this frame.

              content_types child fields (1)
              • []stringOptional
            allOf branch 1

            Type: object

            Required in this branch: required, max_bytes, max_pixels, max_edge, content_types

            • requiredbooleanRequired

              Whether this mode requires the frame.

            • max_bytesintegerRequired

              Maximum file size in bytes allowed for this frame.

            • max_pixelsintegerRequired

              Maximum total pixel count allowed for this frame.

            • max_edgeintegerRequired

              Maximum pixel count on either side allowed for this frame.

            • content_typesarrayRequired

              Image MIME types allowed for this frame.

              content_types child fields (1)
              • []stringOptional
          • cancel_policystringOptional

            Cancellation capability policy; requesting cancellation does not guarantee completion or a refund.

      • cancel_policystringRequired

        Cancellation capability policy; requesting cancellation does not guarantee completion or a refund.

      • pricing_kindsarrayRequired

        Pricing methods allowed by this model.

        pricing_kinds child fields (1)
        • []stringOptional
  • workspace_enabledbooleanRequired

    Whether new tasks are enabled in the current workspace; does not mean historical objects were deleted.

  • upload_enabledbooleanRequired

    Whether the service enables reference image uploads.

  • file_storage_enabledbooleanRequired

    Whether the service enables managed file storage.

HTTP 400

Invalid request fields or parameters.

application/json

Type
object
Required fields
error

HTTP 401

The key is missing, invalid, expired, or revoked.

application/json

Type
object
Required fields
error

HTTP 403

Insufficient IP, account, model, or tool permissions.

application/json

Type
object
Required fields
error

HTTP 404

Object/capability unavailable, or feature switch disabled.

application/json

Type
object
Required fields
error

HTTP 409

Idempotency/quote conflict, object not ready, or still referenced.

application/json

Type
object
Required fields
error

HTTP 429

Request/queue rate limit.

application/json

Type
object
Required fields
error

HTTP 500

Internal authentication or data storage failure.

application/json

Type
object
Required fields
error

HTTP 503

Service, pricing, or storage unavailable.

application/json

Type
object
Required fields
error