> ## Documentation index
> Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt
> Use it to discover all available pages before exploring further.

# Get a specified saved clip with current progress

> Get a specified saved clip with current progress

```http
POST https://api2.rhombussystems.com/api/event/getClipWithProgress
```

EU organizations send the same request to `https://api2.eu.rhombussystems.com`.

## Authentication and parameters

- `x-auth-apikey` (header, required): Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).
- `Authorization` (header): instead of an API key, an OAuth access token (`Bearer <token>`) with the `read` scope.
- `x-auth-scheme` (header, string, default: `api-token`): Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer <token>` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters. One of: `api-token`, `api`, `api-oauth-token`, `federated-token`, `partner-api-token`, `partner-api`, `partner-api-oauth-token`.
- `x-auth-org` (header, string<RUUID>): Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`.

## Request body

Content type: `application/json`. Request object for retrieving a specific clip with progress information.

- `clipUuid` (string<RUUID> | null, required): base 64 (url-safe) uuid string

## Response 200

OK. Content type: `application/json`

- `clip` (object): Saved clip with progress information for processing operations.
- `error` (boolean | null)
- `errorCode` (string | null): Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.
- `errorMsg` (string | null)
- `warningMsg` (string | null)

## Errors

Also 400, 401, 403, 429, 500, 503 with the standard error body (`errorCode`, `errorMsg`): https://developer.rhombus.com/errors

## OpenAPI

````yaml
openapi: 3.0.1
info:
  title: Rhombus API
  version: "1.0"
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/event/getClipWithProgress:
    post:
      description: Get a specified saved clip with current progress
      operationId: getClipWithProgress
      parameters:
        - description: "Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer <token>` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters."
          example: api-token
          in: header
          name: x-auth-scheme
          required: false
          schema:
            default: api-token
            enum:
              - api-token
              - api
              - api-oauth-token
              - federated-token
              - partner-api-token
              - partner-api
              - partner-api-oauth-token
            type: string
        - description: "Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`."
          in: header
          name: x-auth-org
          required: false
          schema:
            format: RUUID
            maxLength: 22
            minLength: 22
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Event_GetClipWithProgressWSRequest"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Event_GetClipWithProgressWSResponse"
          description: OK
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "503":
          $ref: "#/components/responses/ServiceUnavailable"
      security:
        - ApiKeyAuth: []
        - oauth2:
            - read
      summary: Get a specified saved clip with current progress
      tags:
        - Event Webservice
components:
  schemas:
    Event_GetClipWithProgressWSRequest:
      description: Request object for retrieving a specific clip with progress information.
      properties:
        clipUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      required:
        - clipUuid
      type: object
    Event_GetClipWithProgressWSResponse:
      description: Response object containing a specific clip with progress information.
      properties:
        clip:
          $ref: "#/components/schemas/Event_SavedClipWithProgressType"
        error:
          nullable: true
          type: boolean
        errorCode:
          description: Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.
          nullable: true
          type: string
        errorMsg:
          nullable: true
          type: string
        warningMsg:
          nullable: true
          type: string
      type: object
    Event_SavedClipWithProgressType:
      description: Saved clip with progress information for processing operations.
      properties:
        accessSettings:
          $ref: "#/components/schemas/ClipAccessSettings"
        alterMap:
          additionalProperties:
            items:
              $ref: "#/components/schemas/AlteredView"
            nullable: true
            type: array
          nullable: true
          type: object
        analyzed:
          nullable: true
          type: boolean
        byteCount:
          format: int64
          nullable: true
          type: integer
        clipLocation:
          $ref: "#/components/schemas/MetaDataLocationType"
        clipLocationV2:
          nullable: true
          type: string
        consoleDelete:
          nullable: true
          type: boolean
        createdAtMs:
          format: int64
          nullable: true
          type: integer
        currentOperation:
          description: Current operation being performed on the clip
          example: Processing video
          nullable: true
          type: string
        description:
          nullable: true
          type: string
        deviceIntervalMap:
          additionalProperties:
            items:
              $ref: "#/components/schemas/TimeInterval"
            nullable: true
            type: array
          nullable: true
          type: object
        devicePresentationOrder:
          items:
            description: RUUID with optional appended facet information
            example: AAAAAAAAAAAAAAAAAAAAAA.v0
            format: DeviceFacetUuid
            nullable: true
            type: string
          nullable: true
          type: array
        deviceUuid:
          description: RUUID with optional appended facet information
          example: AAAAAAAAAAAAAAAAAAAAAA.v0
          format: DeviceFacetUuid
          nullable: true
          type: string
        deviceUuidMap:
          additionalProperties:
            $ref: "#/components/schemas/MetaDataLocationType"
          nullable: true
          type: object
        deviceUuids:
          items:
            description: RUUID with optional appended facet information
            example: AAAAAAAAAAAAAAAAAAAAAA.v0
            format: DeviceFacetUuid
            nullable: true
            type: string
          nullable: true
          type: array
        durationSec:
          format: int32
          nullable: true
          type: integer
        externalTransactionId:
          nullable: true
          type: string
        fisheyeHardware:
          $ref: "#/components/schemas/HardwareVariationEnum"
        fisheyeMap:
          additionalProperties:
            items:
              $ref: "#/components/schemas/DewarpedView"
            nullable: true
            type: array
          nullable: true
          type: object
        integrationUploadList:
          items:
            $ref: "#/components/schemas/IntegrationEnum"
          nullable: true
          type: array
        isMonitoringClip:
          nullable: true
          type: boolean
        isVendorClip:
          nullable: true
          type: boolean
        lastUpdatedSec:
          description: Last update timestamp in seconds
          example: 1640995200
          format: int64
          nullable: true
          type: integer
        mountingDirection:
          $ref: "#/components/schemas/CameraMountingDirectionEnum"
        orgUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        percentComplete:
          description: Percentage of completion for the current operation
          example: 75
          format: int32
          nullable: true
          type: integer
        placeholder:
          nullable: true
          type: boolean
        sendToSharedStorage:
          nullable: true
          type: boolean
        sha256Hex:
          nullable: true
          type: string
        sourceAlertUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        status:
          $ref: "#/components/schemas/ClipStatusEnum"
        thumbnailLocation:
          $ref: "#/components/schemas/MetaDataLocationType"
        thumbnailLocationV2:
          nullable: true
          type: string
        timestampMs:
          format: int64
          nullable: true
          type: integer
        title:
          nullable: true
          type: string
        userUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        uuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        videoResolution:
          $ref: "#/components/schemas/Resolution"
      type: object
    ClipAccessSettings:
      description: Visibility setting for the clip
      properties:
        allowedRoles:
          items:
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            format: RUUID
            nullable: true
            type: string
          nullable: true
          type: array
          uniqueItems: true
        allowedUsers:
          items:
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            format: RUUID
            nullable: true
            type: string
          nullable: true
          type: array
          uniqueItems: true
        visibility:
          $ref: "#/components/schemas/ClipVisibilityEnum"
      type: object
    ClipVisibilityEnum:
      description: Use accessSettings instead
      enum:
        - PRIVATE
        - ROLE_RESTRICTED
        - ORG_WIDE
      type: string
    AlteredView:
      description: Map of device facet UUIDs to altered view configurations
      properties:
        crop:
          $ref: "#/components/schemas/CroppedPermyriadRect"
        dewarp:
          $ref: "#/components/schemas/DewarpedView"
      type: object
    CroppedPermyriadRect:
      properties:
        height:
          format: int32
          nullable: true
          type: integer
        width:
          format: int32
          nullable: true
          type: integer
        x:
          format: int32
          nullable: true
          type: integer
        y:
          format: int32
          nullable: true
          type: integer
      type: object
    DewarpedView:
      properties:
        aspectRatio:
          $ref: "#/components/schemas/AspectRatio"
        pitchDegrees:
          format: float
          nullable: true
          type: number
        rollDegrees:
          format: float
          nullable: true
          type: number
        verticalFieldOfViewDegrees:
          format: int32
          nullable: true
          type: integer
        yawDegrees:
          format: float
          nullable: true
          type: number
      type: object
    AspectRatio:
      properties:
        height:
          format: int32
          nullable: true
          type: integer
        width:
          format: int32
          nullable: true
          type: integer
      type: object
    MetaDataLocationType:
      properties:
        region:
          nullable: true
          type: string
      type: object
    TimeInterval:
      properties:
        endMs:
          format: int64
          nullable: true
          type: integer
        startMs:
          format: int64
          nullable: true
          type: integer
      type: object
    HardwareVariationEnum:
      enum:
        - RASPBERRY_PI_3
        - CAMERA_R1
        - CAMERA_R2
        - CAMERA_R2_LONG_RANGE
        - CAMERA_R2_180
        - CAMERA_R3
        - CAMERA_R4
        - CAMERA_R100
        - CAMERA_R120
        - CAMERA_R170
        - CAMERA_R200
        - CAMERA_R500
        - CAMERA_R510
        - CAMERA_R520
        - CAMERA_R600
        - SENSOR_ASSET_TAG_T1
        - SENSOR_DOOR_D1
        - SENSOR_DOOR_D20
        - SENSOR_ENVIRONMENTAL_E1
        - SENSOR_ENVIRONMENTAL_E15
        - SENSOR_ENVIRONMENTAL_E2
        - SENSOR_MOTION_M1
        - SENSOR_MOTION_M15
        - GATEWAY_A1
        - GATEWAY_A100
        - GATEWAY_ENVIRONMENTAL_E50
        - CAMERA_R220
        - CAMERA_R230
        - CAMERA_R36S
        - CAMERA_R410
        - CAMERA_R540
        - CAMERA_R545
        - BADGE_READER_DR1
        - BADGE_READER_DR40
        - BADGE_READER_DR20
        - DOOR_CONTROLLER_DC1
        - DOOR_CONTROLLER_DC20
        - DOOR_CONTROLLER_DC10
        - ETHERNET_TESTER_ET1
        - IO_BOARD_TB1
        - BLE_BUTTON_B10
        - BLE_BUTTON_B15
        - CAMERA_THIRD_PARTY_RELAY
        - CAMERA_THIRD_PARTY_NVR
        - CAMERA_THIRD_PARTY_NVR_MULTISENSOR
        - NVR_N100
        - CAMERA_R130
        - NVR_N500
        - CAMERA_R150
        - ROBOT_RC1
        - CAMERA_R210
        - CAMERA_R650
        - NVR_N550
        - NVR_N551
        - ROBOT_RC2
        - UNSPECIFIED
      type: string
    IntegrationEnum:
      enum:
        - AVIGILON_ALTA
        - BOULEVARD
        - BRIVO
        - BUTTERFLY_MX
        - DEVICE_INTEGRATION
        - DICE
        - ENVOY
        - FLIC
        - GENEA
        - GOOGLE
        - HONEYWELL_ELEMENTS
        - GUEST_MANAGEMENT
        - INFORMACAST
        - INNER_RANGE
        - KISI
        - LUMEO
        - MICROSOFT_TEAMS
        - OMNIALERT
        - OPENAI
        - OPENTECH_ALLIANCE
        - PIMLOC
        - PLACE_OS
        - PRODATAKEY
        - SHELLY
        - TOAST
        - WEBHOOKS
        - ZAPIER
        - RAPTOR
        - NINEONEONE_CELLULAR
        - SLACK
        - APERIO
        - PAR_POS
        - HONEYWELL_ONGUARD
        - HONEYWELL_NETBOX
        - SIGNATURE_API
        - SCHLAGE
        - UNKNOWN
      type: string
    CameraMountingDirectionEnum:
      enum:
        - DOWN
        - UP
        - SIDEWAYS
        - UNKNOWN
      type: string
    ClipStatusEnum:
      enum:
        - INITIATING
        - UPLOADING
        - RENDERING
        - FAILED
        - COMPLETE
        - OFFLINE
        - DELETED
        - UNKNOWN
      type: string
    Resolution:
      properties:
        height:
          format: int32
          nullable: true
          type: integer
        width:
          format: int32
          nullable: true
          type: integer
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).
      in: header
      name: x-auth-apikey
      type: apiKey
    oauth2:
      description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer <token>`. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.'
      flows:
        authorizationCode:
          authorizationUrl: https://console.rhombus.com/oauth/authorize
          refreshUrl: https://auth-web.rhombussystems.com/oauth/token
          scopes:
            physical: Unlock doors and elevators, lockdown, alarms, speakers and robots
            read: View cameras, footage and settings
            write: Change settings and data
          tokenUrl: https://auth-web.rhombussystems.com/oauth/token
      type: oauth2
````