Fields

Get field metadata

Gets field metadata and returns field_id, name, description, read_only, is_trained, file_ids

get/fields/{field_id}/metadata

Request

Base URL
https://us.app.zuva.ai/api/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/zuva/apis/zuva-docai/docs/fields/:field_id/metadata/get.ts
A function with typed inputs. Its response is checked against the schema.

field_idstring required

Field ID

The field's metadata

descriptionstring required

field_idstring required

file_idsstring[] required

is_trainedboolean required

namestring required

normalization_typestring required

read_onlyboolean required

tagsstring[] required

{
  "field_id": "12345678-1234-1234-1234-123456789012",
  "file_ids": [
    "c5e407f1qk1er7odm6tg"
  ]
}