Affinda Deprecated End Points API
Deprecated endpoints that are maintained for backward compatibility.These endpoints include Data Point, Collection, and Users functionality that has been superseded by newer APIs.
Affinda Deprecated End Points API is one of 16 APIs that Affinda publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Deprecated End Points. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 31 operations across 15 paths, and defines 97 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.
Requests are made against a single base URL, https://{region}.affinda.com.
31 operations
15 paths
97 schemas
5 DELETE12 GET6 PATCH8 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Affinda Deprecated End Points API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— Basic authentication using an API key, e.g. {Authorization: Bearer aff0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings pag…
Paths & Operations 31
Across 15 paths, the API surfaces 31 operations — 5 DELETE, 12 GET, 6 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.
Deprecated End Points 31
Deprecated endpoints that are maintained for backward compatibility. These endpoints include Data Point, Collection, and Users functionality that has been superseded by newer APIs.
GET
/v3/collectionsdeprecated
Get list of all collections
POST
/v3/collectionsdeprecated
Create a collection
GET
/v3/collections/{identifier}deprecated
Get specific collection
PATCH
/v3/collections/{identifier}deprecated
Update a collection
DELETE
/v3/collections/{identifier}deprecated
Delete a collection
POST
/v3/collections/{identifier}/create_data_fielddeprecated
Create data field for a collection along with a new data point.
GET
/v3/collections/{identifier}/fields/{datapoint_identifier}deprecated
Get data field for a collection assosciated with a data point.
PATCH
/v3/collections/{identifier}/fields/{datapoint_identifier}deprecated
Update data field for a collection assosciated with a data point.
GET
/v3/collections/{identifier}/usagedeprecated
Get usage by collection
GET
/v3/data_pointsdeprecated
Get list of all data points
POST
/v3/data_pointsdeprecated
Create a data point
GET
/v3/data_points/{identifier}deprecated
Get specific data point
PATCH
/v3/data_points/{identifier}deprecated
Update a data point
DELETE
/v3/data_points/{identifier}deprecated
Delete a data point
GET
/v3/data_point_choicesdeprecated
Get list of data point choices
POST
/v3/data_point_choicesdeprecated
Create a data point choice
GET
/v3/data_point_choices/{id}deprecated
Get specific data point choice
PATCH
/v3/data_point_choices/{id}deprecated
Update a data point choice
DELETE
/v3/data_point_choices/{id}deprecated
Delete a data point choice
POST
/v3/data_point_choices/replacedeprecated
Replace choices of a data point
GET
/v3/api_users
Get list of all API users
POST
/v3/api_users
Create an API user
GET
/v3/api_users/{id}
Get specific API user
PATCH
/v3/api_users/{id}
Update an API user
DELETE
/v3/api_users/{id}
Delete an API user
POST
/v3/api_users/{id}/regenerate_api_key
Regenerate API key for an API user
POST
/v3/mappingsdeprecated
Create a mapping
GET
/v3/mappingsdeprecated
List mappings
GET
/v3/mappings/{identifier}deprecated
Get specific mapping
DELETE
/v3/mappings/{identifier}deprecated
Delete specific mapping
PATCH
/v3/mappings/{identifier}deprecated
Update specific mapping
Schemas 97
The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are Collection (21 properties), Field (17 properties), DataPoint (14 properties), FieldDeprecated (14 properties). Each schema is shown below with its type and property counts.
properties-enableAutoValidationThreshold
boolean
If true, the autoValidationThreshold enable auto validation from the threshold from this field if specified, else from the collection
allowOpenai
boolean
Whether to allow OpenAI API to be used to assist in creating a model for this collection.
disableConfirmationIfValidationRulesFail
boolean
If True, users cannot validate documents with missing mandatory fields, or failing validation rules.
fields
array
description
string
mandatory
boolean
availableDataSources
array
Mapping_properties-identifier
string
Uniquely identify a mapping.
Collection
object
21 properties
1 required
scoreCutoff
number
Higher values will result in more strict matching.
properties-id
integer
Uniquely identify a user.
DataPointChoice
object
5 properties
3 required
createdDt
string
PaginatedResponse
object
3 properties
1 required
Organization_properties-identifier
string
Uniquely identify an organization.
identifier
string
Uniquely identify a workspace.
synonyms
array
email
string
dateFormatFromDocument
boolean
Predict the date format from any dates in the document that is not ambiguous.
displayRawText
boolean
If true, then the validation tool will show the user the raw text found on the page, not the value that has been parsed to a specific type.
name
string
dataSource
string
Data source mapping identifier
CollectionField
object
10 properties
Extractor_properties-identifier
string
Uniquely identify an extractor.
properties-label
string
DataPointChoiceReplaceResponse
object
4 properties
4 required
DataPoint_properties-name
string
Name of the data point.
multiple
boolean
enabledChildFields
array
ThemeConfig
object
4 properties
RequestError
object
2 properties
2 required
FieldGroup
object
2 properties
2 required
DataFieldCreateField
object
The field to be created.
10 properties
1 required
mapping
string
Defines how the data point is mapped to the data source
dateFormatPreference
string
ApiUserCreate
object
5 properties
1 required
properties-identifier
string
Uniquely identify a collection.
OrganizationRole
string
DataFieldCreate
object
3 properties
2 required
FieldsLayout
object
2 properties
2 required
DataField
object
3 properties
2 required
User_properties-name
string
PaletteColorOptions
object
4 properties
1 required
disabledChildFields
array
DataFieldCreateDataPoint
object
The data point to be created for this field. If a data point with the same slug and collection already exists, it will be reused.
9 properties
3 required
categoryLabel
string
The label of the category that this field will be put into. If not provided, the field will be put into the default category. If no category exists with the sp…
DataPoint_properties-identifier
string
Uniquely identify a data point.
orderBy
string
The field to order the results by. Leave blank for ordering by relevance.
username
string
ExtractorConfig
object
Extra configurations specific to an extractor.
1 property
FieldDeprecated
object
14 properties
3 required
AnnotationContentType
string
The different data types of annotations
DataPointChoiceUpdate
object
7 properties
properties-autoValidationThreshold
number
Threshold for auto validation. If null, uses the collection's autoValidationThreshold.
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.
ApiUserWithKey
object
8 properties
7 required
trainsExtractor
boolean
Whether this collection feeds documents into the extractor's training queue. This setting can only be toggled for custom extractors.
FieldCategory
object
3 properties
3 required
children
array
DataPointChoice_properties-id
integer
Data point choice's ID
namePlural
string
ApiUserUpdate
object
4 properties
properties-avatar
string
URL of the user's avatar.
enableAutoValidationThreshold
boolean
DataPointCreate
object
11 properties
5 required
noRect
boolean
properties-dataSource
string
The mapping data source this mapping applies to.
DataPointChoiceReplaceRequest
object
Request body for replacing choices of a data point. Either collection or organization is required.
4 properties
2 required
validatable
boolean
mappingDataSource
string
If populated, the model will learn to predict this field using the data source, rather than relying on fuzzy string matching.
Organization
object
8 properties
MappingCreate
object
4 properties
1 required
DataPointChoiceForReplace
object
4 properties
1 required
ApiUserWithoutKey
object
7 properties
6 required
Organization_properties-name
string
slug
string
A camelCase string that will be used as the key in the API response.
UsageByCollectionResponse
array
Monthly credits consumption
CollectionUpdate
object
11 properties
DataPointUpdate
object
5 properties
organization
string
The organization that this mapping belongs to.
DataPoint
object
14 properties
6 required
displayEnumValue
boolean
If true, both the value and the label for the enums will appear in the dropdown in the validation tool.
Mapping
object
A mapping allows you to specify specific settings regarding a lookup against a MappingDataSource should be applied.
5 properties
2 required
UsageByCollection
object
Monthly credits consumption
2 properties
2 required
Extractor
object
11 properties
4 required
value
string
autoValidationThreshold
number
Field
object
17 properties
3 required
MappingUpdate
object
2 properties
properties-parent
string
The identifier of the parent data point if applicable.
CollectionCreate
object
14 properties
2 required
isCustom
boolean
label
string
MappingDataSource
object
A mapping data source is used to map from raw data found by our AI models to records in your database.
7 properties
5 required
showDropdown
boolean
RedactConfig
object
8 properties
DataPointChoiceCreate
object
7 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Affinda 12
Other APIs Affinda publishes across the network.
Affinda Documents API
Affinda Document Types API
Affinda Workspaces API
Affinda Organizations API
Affinda Data Sources API
Affinda Annotations API
Affinda Validation Results API
Affinda Tags API
Affinda Usage API
Affinda Webhooks API
Affinda Search and Match API
Affinda Add x-hidden to endpoints API
#Deprecated End Points