---
title: "Update Record"
method: PATCH
path: "/records/{record_id}"
tags: ["records"]
---

# Update Record

`PATCH /records/{record_id}`

## Path parameters

- `record_id` string, uuid, required

## Request body

- RecordUpdate
  - `fields` object, nullable
  - `metadata` object, nullable
  - `suggestions` SuggestionCreate[], nullable
    - `question_id` string, uuid, required
    - `type` 'model' | 'human' | 'selection'
    - `value` union, required
      - SpanQuestionResponseValueItem[]
        - `label` string, required
        - `start` integer, required
        - `end` integer, required
      - RankingQuestionResponseValueItem[]
        - `value` string, required
        - `rank` integer, nullable
      - string[]
      - integer
      - string
      - object
    - `agent` string, nullable — Agent used to generate the suggestion
    - `score` union — The score assigned to the suggestion
      - number
      - number[]
  - `vectors` object, nullable

## Response `200`

Successful Response

- Record
  - `id` string, uuid, required
  - `status` 'pending' | 'completed', required
  - `fields` object, required
  - `metadata` object, nullable
  - `external_id` string, nullable
  - `responses` Response[], nullable
    - `id` string, uuid, required
    - `values` object, nullable
    - `status` 'draft' | 'submitted' | 'discarded', required
    - `record_id` string, uuid, required
    - `user_id` string, uuid, required
    - `inserted_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `suggestions` Suggestion[], nullable
    - `question_id` string, uuid, required
    - `type` 'model' | 'human' | 'selection'
    - `value` unknown, required
    - `agent` string, nullable
    - `score` union
      - number
      - number[]
    - `id` string, uuid, required
    - `inserted_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `vectors` object, nullable
  - `dataset_id` string, uuid, required
  - `inserted_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `422` — Unprocessable Content
- `500` — Internal Server Error

---

[API](https://skmtc.net/hf/apis/extralit-v1.md) · [All operations](https://skmtc.net/hf/apis/extralit-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hf/extralit-v1/versions/3ebd7ae94c89/schema)