---
title: "Split sample into frames"
method: POST
path: "/api/{projectId}/raw-data/{sampleId}/split"
tags: ["Raw data"]
---

# Split sample into frames

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

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/split`
- 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/split/post.ts> (a function with typed inputs; its response is checked against the schema)

Split a video sample into individual frames.
Depending on the length of the video sample this will either execute immediately or return the ID of a job that will perform this action.

## Path parameters

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

## Request body

- SplitSampleInFramesRequest
  - `fps` integer: Frames per second to extract from this video.

## Response `200`

OK

- union
  - GenericApiResponse
    - `success` boolean, required: Whether the operation succeeded
    - `error` string: Optional error description (set if 'success' was false)
  - StartJobResponse
    - `success` boolean, required: Whether the operation succeeded
    - `error` string: Optional error description (set if 'success' was false)
    - `id` integer, required: Job identifier. Status updates will include this identifier.

---

[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)