<!-- Source: https://docs.geopera.com/api-reference/operations/clip · Markdown for LLMs -->

<!-- AUTO-GENERATED by scripts/generate-api-reference.cjs from the committed OpenAPI spec. Do not edit by hand. -->

# Clipping operations

Clip imagery to an area of interest.

Each operation below is reachable at `POST /v1/op/{operation_id}` or the resource path `POST /v1/{resource}/{action}`, with a Bearer token (a `gpra_` API key or a session token). Back to the [Operations Reference](/api-reference/operations) index.

## `clip.area.metadata`

Capture-date metadata for a clip area.

| | |
|---|---|
| **Scope** | `clip:read` |
| **Side-effect** | read |
| **HTTP** | `POST /v1/op/clip.area.metadata`  ·  `POST /v1/clip/area/metadata` |
| **Python / TypeScript** | `client.clip.area.metadata(…)` |
| **CLI** | `geopera clip area metadata …` |

**Request** — `_Area`

| Field | Type | Required | Description |
|---|---|---|---|
| `area` | string | yes |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.

## `clip.area.mosaics`

List mosaic types for a clip area.

| | |
|---|---|
| **Scope** | `clip:read` |
| **Side-effect** | read |
| **HTTP** | `POST /v1/op/clip.area.mosaics`  ·  `POST /v1/clip/area/mosaics` |
| **Python / TypeScript** | `client.clip.area.mosaics(…)` |
| **CLI** | `geopera clip area mosaics …` |

**Request** — `_Area`

| Field | Type | Required | Description |
|---|---|---|---|
| `area` | string | yes |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.

## `clip.areas.list`

List delivery-bucket clip areas.

| | |
|---|---|
| **Scope** | `clip:read` |
| **Side-effect** | read |
| **HTTP** | `POST /v1/op/clip.areas.list`  ·  `POST /v1/clip/areas/list` |
| **Python / TypeScript** | `client.clip.areas.list(…)` |
| **CLI** | `geopera clip areas list …` |

**Request** — `_Empty` _(see the OpenAPI schema for fields)_.

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.

## `clip.create_from_area`

Create + dispatch an area-bucket COG clip job.

| | |
|---|---|
| **Scope** | `clip:write` |
| **Side-effect** | spend — accepts an `Idempotency-Key` header |
| **HTTP** | `POST /v1/op/clip.create_from_area`  ·  `POST /v1/clip/create_from_area` |
| **Python / TypeScript** | `client.clip.create_from_area(…)` |
| **CLI** | `geopera clip create-from-area …` |

**Request** — `ClipCreateFromAreaInput`

| Field | Type | Required | Description |
|---|---|---|---|
| `area` | string | yes |  |
| `mosaic_types` | array of string | yes |  |
| `aoi_geometry` | object | yes |  |
| `aoi_name` | string | — |  |
| `project_id` | string | — |  |
| `organization_id` | string | yes |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.

## `clip.create_from_item`

Invoke Clip Create From Item.

| | |
|---|---|
| **Scope** | `processing:process` |
| **Side-effect** | spend — accepts an `Idempotency-Key` header |
| **HTTP** | `POST /v1/op/clip.create_from_item`  ·  `POST /v1/clip/create_from_item` |
| **Python / TypeScript** | `client.clip.create_from_item(…)` |
| **CLI** | `geopera clip create-from-item …` |

**Request** — a free-form JSON object.

## `clip.job.delete`

Delete a clip job and its GCS files.

| | |
|---|---|
| **Scope** | `clip:destroy` |
| **Side-effect** | destructive |
| **HTTP** | `POST /v1/op/clip.job.delete`  ·  `POST /v1/clip/job/delete` |
| **Python / TypeScript** | `client.clip.job.delete(…)` |
| **CLI** | `geopera clip job delete …` |

**Request** — `ClipJobDeleteInput`

| Field | Type | Required | Description |
|---|---|---|---|
| `job_id` | string | yes |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.

## `clip.job.download`

Stream a clip file from GCS (egress-enforced).

| | |
|---|---|
| **Scope** | `clip:read` |
| **Side-effect** | read |
| **HTTP** | `POST /v1/op/clip.job.download`  ·  `POST /v1/clip/job/download` |
| **Python / TypeScript** | `client.clip.job.download(…)` |
| **CLI** | `geopera clip job download …` |

**Request** — `ClipDownloadInput`

| Field | Type | Required | Description |
|---|---|---|---|
| `job_id` | string | yes |  |
| `mosaic_type` | string | yes |  |
| `user_agent` | string | — |  |
| `requester_ip` | string | — |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.

## `clip.job.downloads`

List downloadable clip files for a job.

| | |
|---|---|
| **Scope** | `clip:read` |
| **Side-effect** | read |
| **HTTP** | `POST /v1/op/clip.job.downloads`  ·  `POST /v1/clip/job/downloads` |
| **Python / TypeScript** | `client.clip.job.downloads(…)` |
| **CLI** | `geopera clip job downloads …` |

**Request** — `ClipJobInput`

| Field | Type | Required | Description |
|---|---|---|---|
| `job_id` | string | yes |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.

## `clip.job.get`

Get a single clip job by id.

| | |
|---|---|
| **Scope** | `clip:read` |
| **Side-effect** | read |
| **HTTP** | `POST /v1/op/clip.job.get`  ·  `POST /v1/clip/job/get` |
| **Python / TypeScript** | `client.clip.job.get(…)` |
| **CLI** | `geopera clip job get …` |

**Request** — `ClipJobInput`

| Field | Type | Required | Description |
|---|---|---|---|
| `job_id` | string | yes |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.

## `clip.job.tile_info`

Tile rendering params for a completed clip job.

| | |
|---|---|
| **Scope** | `clip:read` |
| **Side-effect** | read |
| **HTTP** | `POST /v1/op/clip.job.tile_info`  ·  `POST /v1/clip/job/tile_info` |
| **Python / TypeScript** | `client.clip.job.tile_info(…)` |
| **CLI** | `geopera clip job tile-info …` |

**Request** — `ClipJobInput`

| Field | Type | Required | Description |
|---|---|---|---|
| `job_id` | string | yes |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.

## `clip.jobs.list`

List clip jobs for an organization.

| | |
|---|---|
| **Scope** | `clip:read` |
| **Side-effect** | read |
| **HTTP** | `POST /v1/op/clip.jobs.list`  ·  `POST /v1/clip/jobs/list` |
| **Python / TypeScript** | `client.clip.jobs.list(…)` |
| **CLI** | `geopera clip jobs list …` |

**Request** — `ClipJobsListInput`

| Field | Type | Required | Description |
|---|---|---|---|
| `organization_id` | string | yes |  |
| `status` | string | — |  |
| `limit` | integer | — |  |
| `offset` | integer | — |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.