Rapidata ValidationSet API
The ValidationSet API from Rapidata — 13 operation(s) for validationset.
Rapidata ValidationSet API is one of 55 APIs that Rapidata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include ValidationSet. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes 15 operations across 13 paths, and defines 80 schemas. It is described by OpenAPI 3.0.4, at version v1.
Requests are made against a single base URL, https://api.rapidata.ai/.
15 operations
13 paths
80 schemas
1 DELETE7 GET4 PATCH3 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Rapidata ValidationSet API declares
1 security scheme
for authenticating requests.
It supports OpenID Connect (OpenIdConnect) discovered at https://auth.rapidata.ai/.well-known/openid-configuration.
OpenIdConnect— OpenID Connect connection flow
Paths & Operations 15
Across 13 paths, the API surfaces 15 operations — 1 DELETE, 7 GET, 4 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
ValidationSet 15
POST
/validation-set/{validationSetId}/rapid
Adds a new validation rapid to a validation set using a JSON body.
POST
/validation-set
Creates a new empty validation set.
DELETE
/validation-set/{validationSetId}
Deletes a validation set by id.
GET
/validation-set/{validationSetId}
Gets a validation set by id.
PATCH
/validation-set/{validationSetId}
Updates different characteristics of a validation set using patch semantics.
GET
/validation-set/{validationSetId}/export
Exports all rapids of a validation set to a file.
GET
/validation-sets/available
Gets the available validation sets for the current user.
GET
/validation-sets/compatible
Gets all validation sets available to the user that a rapid with the provided parameters can be added to.
GET
/validation-set/recommended
Gets a validation set that is available to the user and best matches the provided parameters.
GET
/validation-set/{validationSetId}/rapids
Queries the validation rapids for a specific validation set.
GET
/validation-sets
Queries available validation sets based on the provided filter, paging and sorting criteria.
POST
/validation-set/{validationSetId}/update-labeling-hints
Refreshes the labeling hints for a validation set.
PATCH
/validation-set/{validationSetId}/dimensions
Updates the dimensions of all rapids within a validation set.
PATCH
/validation-set/{validationSetId}/shouldAlert
Updates the shouldAlert field on all rapids within a validation set.
PATCH
/validation-set/{validationSetId}/visibility
Updates the visibility of a validation set.
Schemas 80
The contract defines 80 schemas that model the data the API accepts and returns. The most detailed are GetValidationRapidsEndpoint_Output (12 properties), GetRecommendedValidationSetEndpoint_ValidationSetOutputModel (10 properties), GetCompatibleValidationSetsEndpoint_ValidationSetOutputModel (10 properties), QueryValidationSetsEndpoint_Output (10 properties). Each schema is shown below with its type and property counts.
IMetadataModelFileTypeMetadataModel
object
2 properties
2 required
IMetadataModel
object
1 required
GetAvailableValidationSetsEndpoint_ValidationSetOverviewOutputModel
object
3 properties
3 required
LocateBoxTruthModel_Box
object
4 properties
TranscriptionPayloadModel_TranscriptionWord
object
2 properties
2 required
IValidationTruthModelEmptyValidationTruthModel
object
1 property
1 required
IMetadataInputTextMetadataInput
object
3 properties
3 required
ClassifyPayloadModel_Category
object
2 properties
1 required
IAssetModel
object
1 required
FileType
IValidationTruthModelLocateBoxTruthModel
object
4 properties
2 required
GetValidationRapidsEndpoint_Output
object
12 properties
7 required
IRapidPayloadModelBoundingBoxPayloadModel
object
2 properties
2 required
MetadataInputCollection
object
PromptType
array
IValidationTruthModelBoundingBoxTruthModel
object
5 properties
5 required
GetCompatibleValidationSetsEndpoint_Output
object
1 property
1 required
MetadataModelCollection
object
FeatureFlag
object
2 properties
2 required
IRapidPayloadModelLocatePayloadModel
object
2 properties
2 required
MetadataVisibilities
array
IAssetModelNullAssetModel
object
3 properties
3 required
GetRecommendedValidationSetEndpoint_ValidationSetOutputModel
object
10 properties
10 required
RapidStateModel
IRapidPayloadModel
object
1 required
IMetadataModelVideoDurationMetadataModel
object
2 properties
2 required
IAssetInputTextAssetInput
object
4 properties
2 required
GetAvailableValidationSetsEndpoint_Output
object
1 property
1 required
ScrubTruthModel_ScrubRange
object
2 properties
2 required
UpdateValidationSetEndpoint_Input
object
5 properties
IMetadataModelOriginalFilenameMetadataModel
object
2 properties
2 required
IRapidPayloadModelPolygonPayloadModel
object
2 properties
2 required
CreateValidationSetEndpoint_Input
object
1 property
1 required
IRapidPayloadModelClassifyPayloadModel
object
3 properties
3 required
IValidationTruthModelTranscriptionTruthModel
object
5 properties
2 required
IRapidPayloadModelFreeTextPayloadModel
object
4 properties
2 required
IMetadataModelLocationMetadataModel
object
3 properties
3 required
IMetadataInput
object
1 required
IValidationTruthModelNamedEntityTruthModel
object
2 properties
2 required
IValidationTruthModelLineTruthModel
object
1 property
1 required
IMetadataModelClassificationMetadataModel
object
2 properties
2 required
IRapidPayloadModelNamedEntityPayloadModel
object
3 properties
3 required
IMetadataModelTextMetadataModel
object
2 properties
2 required
IValidationTruthModel
object
1 required
IValidationTruthModelClassifyTruthModel
object
2 properties
2 required
CreateValidationSetEndpoint_Output
object
1 property
1 required
IValidationTruthModelCompareTruthModel
object
2 properties
2 required
IMetadataModelStreamsMetadataModel
object
4 properties
4 required
AssetType
array
ValidationProblemDetails
object
6 properties
TranscriptionTruthModel_TranscriptionWord
object
2 properties
2 required
GetValidationRapidsEndpoint_PagedResultOfOutput
object
5 properties
4 required
IMetadataModelImageDimensionMetadataModel
object
3 properties
1 required
IValidationTruthModelAttachCategoryTruthModel
object
2 properties
2 required
IMetadataModelCountMetadataModel
object
2 properties
2 required
IRapidPayloadModelLinePayloadModel
object
2 properties
2 required
UpdateValidationSetShouldAlertEndpoint_Input
object
1 property
1 required
IRapidPayloadModelComparePayloadModel
object
2 properties
2 required
NamedEntityTruthModel_NamedClassification
object
3 properties
3 required
IAssetInputMultiAssetInput
object
4 properties
2 required
IAssetModelMultiAssetModel
object
4 properties
4 required
IMetadataModelSourceUrlMetadataModel
object
2 properties
2 required
RapidModality
array
GetRecommendedValidationSetEndpoint_Output
object
1 property
1 required
IValidationTruthModelSkipTruthModel
object
1 property
1 required
GetValidationSetByIdEndpoint_Output
object
7 properties
7 required
QueryValidationSetsEndpoint_Output
object
10 properties
10 required
IAssetModelTextAssetModel
object
4 properties
4 required
IRapidPayloadModelScrubPayloadModel
object
2 properties
2 required
IValidationTruthModelMultiCompareTruthModel
object
2 properties
2 required
AddValidationRapidEndpoint_Input
object
8 properties
2 required
IValidationTruthModelScrubTruthModel
object
2 properties
2 required
IAssetInput
object
1 required
IRapidPayloadModelTranscriptionPayloadModel
object
3 properties
3 required
GetCompatibleValidationSetsEndpoint_ValidationSetOutputModel
object
10 properties
10 required
IAssetInputExistingAssetInput
object
4 properties
2 required
IValidationTruthModelPolygonTruthModel
object
1 property
1 required
UpdateValidationSetDimensionsEndpoint_Input
object
1 property
1 required
IAssetModelFileAssetModel
object
4 properties
4 required
QueryValidationSetsEndpoint_PagedResultOfOutput
object
5 properties
4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Rapidata 12
Other APIs Rapidata publishes across the network.
Rapidata Asset API
Rapidata Audience API
Rapidata BatchUpload API
Rapidata Benchmark API
Rapidata Billing API
Rapidata BillingAccount API
Rapidata Cache API
Rapidata Campaign API
Rapidata Client API
Rapidata ContextShortening API
Rapidata Customer API
Rapidata CustomerRapid API
#ValidationSet