POST
/
v3
/
data_points
Create a data point
curl --request POST \
  --url https://{region}.affinda.com/v3/data_points \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "annotationContentType": "text",
  "organization": "mEFayXdO",
  "extractor": "resume",
  "multiple": true,
  "noRect": true,
  "parent": "DdCbJhhx",
  "manualEntry": true,
  "mappingDataSource": "mEFayXdO"
}'
{
  "identifier": "XprEvgai",
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "annotationContentType": "text",
  "organization": {
    "identifier": "mEFayXdO",
    "name": "Grove Street King",
    "userRole": "admin",
    "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
    "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad",
    "isTrial": true,
    "validationToolConfig": {
      "theme": {
        "palette": {
          "mode": "light",
          "background": "<string>",
          "text": {
            "primary": "<string>",
            "secondary": "<string>",
            "disabled": "<string>"
          },
          "divider": "<string>",
          "primary": {
            "main": "<string>",
            "light": "<string>",
            "dark": "<string>",
            "contrastText": "<string>"
          },
          "secondary": {
            "main": "<string>",
            "light": "<string>",
            "dark": "<string>",
            "contrastText": "<string>"
          },
          "success": {
            "main": "<string>",
            "light": "<string>",
            "dark": "<string>",
            "contrastText": "<string>"
          },
          "annotation": {
            "main": "<string>",
            "light": "<string>",
            "dark": "<string>",
            "contrastText": "<string>"
          },
          "error": {
            "main": "<string>",
            "light": "<string>",
            "dark": "<string>",
            "contrastText": "<string>"
          },
          "info": {
            "main": "<string>",
            "light": "<string>",
            "dark": "<string>",
            "contrastText": "<string>"
          },
          "warning": {
            "main": "<string>",
            "light": "<string>",
            "dark": "<string>",
            "contrastText": "<string>"
          }
        },
        "typography": {
          "fontFamily": "<string>",
          "fontSize": "<string>",
          "fontWeightRegular": "<string>",
          "fontWeightMedium": "<string>",
          "fontWeightBold": "<string>"
        },
        "borderRadius": 123,
        "fontUrl": "<string>"
      },
      "hideActions": true,
      "hideCollection": true,
      "hideEditPages": true,
      "hideExport": true,
      "hideFilename": true,
      "hideReject": true,
      "hideReparse": true,
      "hideRunOcr": true,
      "hideTags": true,
      "hideWarnings": true,
      "restrictDocumentSplitting": true,
      "disableCurrencyFormatting": true,
      "disableEditDocumentMetadata": true
    },
    "showCustomFieldCreation": true
  },
  "extractor": "resume",
  "multiple": true,
  "noRect": true,
  "parent": "DdCbJhhx",
  "children": [
    {}
  ],
  "availableDataSources": [
    {
      "identifier": "mEFayXdO",
      "name": "My supplier list",
      "keyProperty": "value",
      "displayProperty": "value",
      "organization": "mewlkWEKL",
      "workspace": "mewlkWEKL",
      "schema": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-07/schema#",
        "required": [
          "label"
        ],
        "properties": {
          "label": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      }
    }
  ],
  "mappingDataSource": "mEFayXdO",
  "manualEntry": true
}

Authorizations

​
Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Body

application/json
​
name
string
required

Name of the data point.

​
slug
string
required

A camelCase string that will be used as the key in the API response.

​
annotationContentType
enum<string>
required

The different data types of annotations

Available options:
text,
integer,
float,
decimal,
date,
datetime,
daterange,
boolean,
enum,
location,
phonenumber,
json,
table,
expectedremuneration,
jobtitle,
language,
skill,
yearsexperience,
group,
table_deprecated,
url,
image,
docclf
​
organization
string
required

Uniquely identify an organization.

Example:

"mEFayXdO"

​
extractor
string
required

Uniquely identify an extractor.

Example:

"resume"

​
description
string | null
​
multiple
boolean
​
noRect
boolean
​
parent
string | null

The identifier of the parent data point if applicable.

Example:

"DdCbJhhx"

​
manualEntry
boolean

If true, the model will not be used to predict this data point. Instead, the user will be able to manually enter the value in the validation tool.

​
mappingDataSource
string | null

If populated, the model will learn to predict this field using the data source, rather than relying on fuzzy string matching.

Example:

"mEFayXdO"

Response

Successfully created a data point.

​
identifier
string
required

Uniquely identify a data point.

Example:

"XprEvgai"

​
name
string
required

Name of the data point.

​
slug
string
required

A camelCase string that will be used as the key in the API response.

​
annotationContentType
enum<string>
required

The different data types of annotations

Available options:
text,
integer,
float,
decimal,
date,
datetime,
daterange,
boolean,
enum,
location,
phonenumber,
json,
table,
expectedremuneration,
jobtitle,
language,
skill,
yearsexperience,
group,
table_deprecated,
url,
image,
docclf
​
organization
object
required
​
extractor
string
required

Uniquely identify an extractor.

Example:

"resume"

​
description
string | null
​
multiple
boolean
​
noRect
boolean
​
parent
string | null

The identifier of the parent data point if applicable.

Example:

"DdCbJhhx"

​
children
object[]
​
availableDataSources
object[]
​
mappingDataSource
string | null

If populated, the model will learn to predict this field using the data source, rather than relying on fuzzy string matching.

Example:

"mEFayXdO"

​
manualEntry
boolean

If true, the model will not be used to predict this data point. Instead, the user will be able to manually enter the value in the validation tool.