> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ringbee.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Black Detect

> Detect black frames in a video

<RequestExample>
  ```json Example Request theme={null}
  {
    "input": "https://example.com/video.mp4",
    "threshold": 0.1,
    "duration": 0.5
  }
  ```

  ```bash File Upload theme={null}
  curl -X POST https://api.ringbee.dev/v1/video/black-detect \
    -H "X-API-Key: YOUR_API_KEY" \
    -F "file=@video.mp4" \
    -F "threshold=0.1" \
    -F "duration=0.5"
  ```
</RequestExample>

| Param     | Type   | Description                                        |
| --------- | ------ | -------------------------------------------------- |
| threshold | number | Black pixel threshold (0-1, higher = more lenient) |
| duration  | number | Minimum black frame duration in seconds            |


## OpenAPI

````yaml POST /v1/video/black-detect
openapi: 3.0.3
info:
  title: MediAPI
  description: >-
    Media processing API — video, audio, image, and document transformations via
    simple REST calls.
  version: 1.0.0
servers:
  - url: https://api.ringbee.dev
    description: Production
security:
  - apiKey: []
paths:
  /v1/video/black-detect:
    post:
      tags:
        - Video
      summary: Black Detect
      description: Detect black frames in a video
      operationId: videoBlackDetect
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - input
              properties:
                input:
                  type: string
                  description: Input file URL
                threshold:
                  type: number
                  description: Black pixel threshold (0-1, higher = more lenient)
                duration:
                  type: number
                  description: Minimum black frame duration in seconds
                webhook_url:
                  type: string
                  description: URL to receive job completion notification
          multipart/form-data:
            schema:
              type: object
              required:
                - file
              properties:
                file:
                  type: string
                  format: binary
                  description: Upload file directly
                threshold:
                  type: number
                  description: Black pixel threshold (0-1, higher = more lenient)
                duration:
                  type: number
                  description: Minimum black frame duration in seconds
                webhook_url:
                  type: string
                  description: URL to receive job completion notification
      responses:
        '202':
          description: Job accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Usage limit reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    JobResponse:
      type: object
      properties:
        id:
          type: string
          example: job_abc123
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
            - cancelled
          example: pending
    Error:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key

````