v1

latestOpenAPI 3.0.3MIT2026-07-22153276289.7 KB

Deprecated End Points

Create a data point

Create a custom data point.

post/v3/data_points

Request body

namestring required

Name of the data point.

slugstring required

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

descriptionstring nullable

annotationContentType'text' | 'integer' | 'float' | 'decimal' | 'date' | 'datetime' | 'daterange' | 'boolean' | 'enum' | 'location' | 'phonenumber' | 'json' | 'table' | 'expectedremuneration' | 'jobtitle' | 'language' | 'skill' | 'yearsexperience' | 'group' | 'table_deprecated' | 'url' | 'image' | 'docclf' required

The different data types of annotations

organizationstring required

Uniquely identify an organization.

extractorstring required

Uniquely identify an extractor.

multipleboolean

noRectboolean

parentstring nullable

The identifier of the parent data point if applicable.

manualEntryboolean

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.

mappingDataSourcestring nullable

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

Example request

{
  "organization": "mEFayXdO",
  "extractor": "resume",
  "parent": "DdCbJhhx",
  "mappingDataSource": "mEFayXdO"
}

Response

Successfully created a data point.

identifierstring required

Uniquely identify a data point.

namestring required

Name of the data point.

slugstring required

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

descriptionstring nullable

annotationContentType'text' | 'integer' | 'float' | 'decimal' | 'date' | 'datetime' | 'daterange' | 'boolean' | 'enum' | 'location' | 'phonenumber' | 'json' | 'table' | 'expectedremuneration' | 'jobtitle' | 'language' | 'skill' | 'yearsexperience' | 'group' | 'table_deprecated' | 'url' | 'image' | 'docclf' required

The different data types of annotations

extractorstring required

Uniquely identify an extractor.

multipleboolean

noRectboolean

parentstring nullable

The identifier of the parent data point if applicable.

mappingDataSourcestring nullable

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

manualEntryboolean

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.