POST /fields

Create a new field to be used for training. This endpoint will return the field_id for your new field. You can then use the field_id to train your smart field using the POST/ Train Field endpoint.

Headers

Authorization (required) - Requires the standard authentication header used in the system.

Parameters

  • field_name Body Required

    the name of your new field

  • description Body Required

    the description of what this smart field will be trained to identify

Code Sample
curl -X POST -H "Accept: application/json"  
-H "Authorization: Bearer <token>"
-H "Content-Type: application/json"
-d "{
      "field_name": ["<field_name>"], 
      "description": ["<description>"]
    }" 
    https://<base_url>/api/v2/fields
fieldID, _ = zdai.fields.create(field_name=’field name’, description=’field description’, from_field_id=’field ID’)
Response Codes
  • 201 Created
    Field has been created successfully.
  • 400 Bad Request
    Malformed request body, or field_name/description are missing.
  • 403 Forbidden
    Invalid or missing authentication token.
  • 500 Internal Server Error
    Something went wrong unrelated to the users request.

Response Data

  • field_id

    the field identifier. This can be used in other endpoints

Response
{
    "field_id": "ffc67f474-f27d-4598-9425-f95f7dea2805"
}

Need Help?

Couldn’t find the information you were looking for or need more assistance?

Contact us at support@zuva.ai