---
title: "Propose changes"
method: POST
path: "/api/{projectId}/raw-data/{sampleId}/propose-changes"
tags: ["Raw data"]
---

# Propose changes

`POST /api/{projectId}/raw-data/{sampleId}/propose-changes`

## Request

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

Queue up changes to an object as part of the AI Actions flow. This overwrites any previous proposed changes.

## Path parameters

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

## Request body

- SetSampleProposedChangesRequest
  - `jobId` integer, required: Job ID of an AI Actions job. This is passed into your job via the --propose-actions argument.
  - `proposedChanges` SampleProposedChanges, required
    - `label` string: New label (single-label)
    - `isDisabled` boolean: True if the current sample should be disabled; or false if it should not be disabled.
    - `boundingBoxes` BoundingBox[]: List of bounding boxes. The existing bounding boxes on the sample will be replaced (so if you want to add new bounding boxes, use the existing list as a basis).
      - `label` string, required
      - `x` integer, required
      - `y` integer, required
      - `width` integer, required
      - `height` integer, required
    - `metadata` object: Free form associated metadata. The existing metadata on the sample will be replaced (so if you want to add new metadata, use the existing list as a basis).
    - `structuredLabels` StructuredLabel[]: New label (multi-label)
      - `startIndex` integer, required: Start index of the label (e.g. 0)
      - `endIndex` integer, required: End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
      - `label` string, required: The label for this section.
      - `labelMap` SampleLabelMapLabels
        - `type` 'key-values', required
        - `labels` object, required

## Response `200`

OK

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

---

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