---
title: "Crop sample"
method: POST
path: "/api/{projectId}/raw-data/{sampleId}/crop"
tags: ["Raw data"]
---

# Crop sample

`POST /api/{projectId}/raw-data/{sampleId}/crop`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/crop`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - OAuth 2
    - Authorization code: `/v1/oauth/authorize`
    - Client credentials
    - Implicit: `/v1/oauth/authorize`
    - Password
    - Token URL: `/v1/oauth/token`
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/raw-data/:sampleId/crop/post.ts> (a function with typed inputs; its response is checked against the schema)

Crop a sample to within a new range. cropStart/cropEnd are relative to the selected datastream. If you have multiple datastreams and OptionalDatastreamIndexParameter is not passed in, the first datastream is used.

## Path parameters

- `projectId` integer, required
- `sampleId` integer, required

## Query parameters

- `datastreamIndex` integer

## Request body

- CropSampleRequest
  - `cropStart` integer, required: New start index of the sample
  - `cropEnd` integer, required: New end index of the sample

## Response `200`

OK

- CropSampleResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `requiresProcessing` boolean, required

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)