---
title: "Create a new field"
method: POST
path: "/fields"
tags: ["Fields"]
---

# Create a new field

`POST /fields`

## Request

- Base URL: `https://us.app.zuva.ai/api/v2`
- URL: `https://us.app.zuva.ai/api/v2/fields`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/zuva/apis/zuva-docai/docs/fields/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a new field and returns its field ID.

The optional `from_field_id` parameter can be provided in order to copy an existing field as
a starting point for further training.

## Request body

- PostFieldRequest
  - `description` string
  - `name` string, required
  - `from_field_id` string: ID of an existing field to copy

## Response `201`

ID of newly created field

- NewFieldResponse
  - `field_id` string

## Other responses

- `400`: Specified `from_field_id` does not exist
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Request not found.
- `500`: Internal Server Error

## Changes

- **2023-12-13** `51f2a4c5de2e`: 1 breaking, 1 warning
  - added the new required request property `name`
  - removed the request property `field_name`

[Operation history](https://skmtc.dev/zuva/apis/zuva-docai/changes/fields/post.md)

---

[API](https://skmtc.dev/zuva/apis/zuva-docai.md) - [All operations](https://skmtc.dev/zuva/apis/zuva-docai/llms.txt) - [OpenAPI document](https://skmtc.dev/zuva/apis/zuva-docai/revisions/7397ad071d55?raw)