PARSER GUIDES
Create Field
POST
/api/v1/parsers/{parserId}/fields
Create a scalar field or table field.
Authorization
bearerAuth
authorization: <token>
Your API key. Include it directly in the Authorization header as the API key value (e.g., 'authorization: your-api-key-here')
In: header
Path Parameters
parserId — string
The ID of the parser
Format: uuid
Request Body
application/json
id?string
name?string
type?string
Value in"text" | "number" | "date" | "boolean" | "currency" | "choice" | "list" | "table"
description?string|null
instructions?string|null
required?boolean
position?integer
options?array<string\>
columns?array<PublicField\>
Response Body
201
application/json
curl -X POST "https://api.PARSER.com/api/v1/parsers/d1458cd7-8692-488f-8b3f-0fddade05f9c/fields" \ -H "Content-Type: application/json" \ -d '{}'
201
{
"fields": [
{
"id": "string",
"name": "string",
"type": "text",
"description": "string",
"instructions": "string",
"required": true,
"position": 0,
"options": [
"string"
],
"columns": [
{
"id": "string",
"name": "string",
"type": "text",
"description": "string",
"instructions": "string",
"required": true,
"position": 0,
"options": [
"string"
],
"columns": []
}
]
}
],
"reprocessRecommended": true
}
List Fields GETList scalar fields and table fields for a parser.Open guide →
Update Field PATCHUpdate or rename a scalar field or table field. For table fields, \columns\ is the full desired column list.Open guide →