---
title: "Get project sample metadata"
method: GET
path: "/api/{projectId}/raw-data/metadata"
tags: ["Raw data"]
---

# Get project sample metadata

`GET /api/{projectId}/raw-data/metadata`

## Request

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

Get metadata for all samples in a project.

## Path parameters

- `projectId` integer, required

## Query parameters

- `category` 'training' | 'testing' | 'validation' | 'post-processing' | 'all', required

## Response `200`

OK

- GetSampleMetadataResponse: Project sample metadata
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `metadata` SampleMetadata[], required: Array with all available sample metadata.
    - `id` integer, required: Sample ID
    - `metadata` object, required: Sample free form associated metadata

---

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