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

# remove background

> Remove the background from an image or a video, in credits. A person in a timeline video is separated free by a person mask (edit_timeline updateClip masks, shape "person"); this is for files, stills and what that mask refuses. An image becomes a transparent PNG beside the original. A video keeps its subject as a WebM with transparency up to 1080p, with its sound; breaks up on fast motion; up to 3 minutes per call. With timeline_id and clip_id only the stretch the clip plays is cut: as "clip" (default) takes its slot, as "mask" attaches the cutout as a matte over the still-playing clip. A job, refunded on failure.



## OpenAPI

````yaml /openapi.json post /tools/remove_background
openapi: 3.1.0
info:
  title: Eversince API
  version: '1'
  description: >-
    Every Eversince tool as one POST call, plus the routes beside them: the tool
    list, account and keys, uploads, webhooks and models. The prose is at
    https://docs.eversince.ai.
servers:
  - url: https://eversince.ai/api/v1
security:
  - bearer: []
tags:
  - name: Discovery
    description: The tool list, the same on the MCP server, the REST API and the CLI.
  - name: Workspace
    description: Jobs, balances, settings, templates, skills and the overview.
  - name: Library
    description: >-
      Items, search, import, reading media, comments, boards, calendars, the
      brand kit and public links.
  - name: Timeline
    description: 'Video editing: timelines, clips, captions, sound, language and rendering.'
  - name: Canvas
    description: 'Still editing: canvases, slides, layers and rendering.'
  - name: Generation
    description: Image, video and audio generation, upscaling, cutouts and models.
  - name: Research
    description: 'What platforms publish: pulling and keeping posts.'
  - name: Account
    description: Balances, keys, workspaces and script sessions.
  - name: Uploads
    description: Files into the library by presigned upload or by URL.
  - name: Webhooks
    description: Job results posted to a URL as they complete.
  - name: Models
    description: Generation models and cost estimates.
paths:
  /tools/remove_background:
    post:
      tags:
        - Generation
      summary: remove background
      description: >-
        Remove the background from an image or a video, in credits. A person in
        a timeline video is separated free by a person mask (edit_timeline
        updateClip masks, shape "person"); this is for files, stills and what
        that mask refuses. An image becomes a transparent PNG beside the
        original. A video keeps its subject as a WebM with transparency up to
        1080p, with its sound; breaks up on fast motion; up to 3 minutes per
        call. With timeline_id and clip_id only the stretch the clip plays is
        cut: as "clip" (default) takes its slot, as "mask" attaches the cutout
        as a matte over the still-playing clip. A job, refunded on failure.
      operationId: remove_background
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
        - $ref: '#/components/parameters/WorkspaceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ref:
                  type: string
                timeline_id:
                  description: >-
                    Video only. With clip_id: only that clip's trimmed stretch
                    is cut, and the result goes on it. Alone: the result is
                    added to this timeline's media.
                  type: string
                clip_id:
                  description: >-
                    Video only, with timeline_id: the clip whose trimmed stretch
                    is cut, and which the result replaces or carries a mask for.
                  type: string
                as:
                  description: >-
                    Video on a clip: "clip" (default) takes the clip's slot;
                    "mask" leaves the clip playing and attaches the cutout as a
                    subject mask on it.
                  type: string
                  enum:
                    - clip
                    - mask
                idempotency_key:
                  type: string
                  minLength: 1
                  maxLength: 200
                  description: >-
                    Idempotency key (a UUID). A retry with the same key returns
                    the job already dispatched instead of charging again; a new
                    attempt takes a new key.
                context:
                  description: 'Optional: one sentence shown to the user beside this action.'
                  type: string
                  maxLength: 600
              required:
                - ref
                - idempotency_key
      responses:
        '200':
          description: >-
            Done, or a job started for work that runs longer (follow it with
            get_jobs).
          content:
            application/json:
              schema:
                type: object
                required:
                  - ok
                  - data
                  - meta
                properties:
                  ok:
                    const: true
                  data:
                    type: object
                    additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      cost:
                        $ref: '#/components/schemas/Cost'
                      cloud_processing:
                        $ref: '#/components/schemas/CloudProcessing'
                  media:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        default:
          $ref: '#/components/responses/Error'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
      description: >-
        Retry a paid dispatch safely: the same key returns the job already
        dispatched instead of charging again.
    WorkspaceId:
      name: x-workspace-id
      in: header
      required: false
      schema:
        type: string
      description: >-
        The workspace this one call acts in, when it is not the default: for a
        key or a connected agent, one of the workspaces the user allowed it.
  schemas:
    Cost:
      type: object
      description: AI credits the call cost.
      additionalProperties: true
    CloudProcessing:
      type: object
      description: >-
        Cloud processing for this call. minutes is the estimate. charged_minutes
        is what work that finished inside the call was charged; work still
        running or queued is charged when it finishes, and get_jobs reports it
        as cloud_minutes. month_left_minutes is the month after held_minutes,
        which running work holds until it settles, with bought_minutes apart.
      properties:
        ran_on:
          const: cloud
        minutes:
          type: number
        charged_minutes:
          type: number
        queued_minutes:
          type: number
        month_left_minutes:
          type: number
        held_minutes:
          type: number
        bought_minutes:
          type: number
        note:
          type: string
    Error:
      type: object
      required:
        - ok
        - error
      properties:
        ok:
          const: false
        error:
          type: object
          required:
            - code
            - message
            - retryable
          properties:
            code:
              type: string
            message:
              type: string
              description: What went wrong, in words to act on.
            retryable:
              type: boolean
            suggested_action:
              type: string
              description: The next step that works.
            cloud_processing:
              $ref: '#/components/schemas/CloudProcessing'
  responses:
    Error:
      description: The call was refused or failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        An API key (es_live_…) from Settings, under API keys, or an OAuth access
        token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.