Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rapidata CustomerRapid API

The CustomerRapid API from Rapidata — 8 operation(s) for customerrapid.

Rapidata CustomerRapid API is one of 55 APIs that Rapidata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CustomerRapid. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 8 operations across 8 paths, and defines 97 schemas. It is described by OpenAPI 3.0.4, at version v1.

Requests are made against a single base URL, https://api.rapidata.ai/.

8 operations 8 paths 97 schemas 1 DELETE4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
v1
Base URL
https://api.rapidata.ai/
Authentication
OpenID Connect
Resource Areas
1

Authentication & Security 1

Rapidata CustomerRapid 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 8

Across 8 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

CustomerRapid 8
POST
/rapid/demographic
Creates a new demographic rapid.
body → 200400401403
DELETE
/rapid/{rapidId}
Deletes a rapid.
1 param → 204400401403
GET
/rapid/global-responses
Gets the most recent public responses across all customers.
→ 200400401403
GET
/rapid/{rapidId}/responses
Gets all responses for a given rapid.
1 param → 200400401403
GET
/rapids/flagged
Queries all rapids that have been flagged.
9 params → 200400401403
GET
/rapid/{correlationId}/validation-potential
Queries rapids that may be eligible for validation-set creation.
10 params → 200400401403
POST
/rapid/{rapidId}/unflag
Unflags a flagged rapid.
1 param → 204400401403
PATCH
/rapid/validation/{rapidId}
Updates the validation information of a rapid.
1 param body → 204400401403

Schemas 97

The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are QueryFlaggedRapidsEndpoint_Output (13 properties), GetResponsesForRapidEndpoint_Output_Response (7 properties), GetGlobalResponsesEndpoint_Output_Response (6 properties), UpdateValidationRapidEndpoint_Input (6 properties). Each schema is shown below with its type and property counts.

TranscriptionResultModel_TranscriptionWord
object
2 properties 2 required
IRapidResultModelSkipResultModel
object
2 properties 2 required
IMetadataModelFileTypeMetadataModel
object
2 properties 2 required
IMetadataModel
object
1 required
GetResponsesForRapidEndpoint_Output_Response
object
7 properties 7 required
LocateBoxTruthModel_Box
object
4 properties
TranscriptionPayloadModel_TranscriptionWord
object
2 properties 2 required
UpdateValidationRapidEndpoint_Input
object
6 properties
IValidationTruthModelEmptyValidationTruthModel
object
1 property 1 required
IMetadataInputTextMetadataInput
object
3 properties 3 required
QueryFlaggedRapidsEndpoint_PagedResultOfOutput
object
5 properties 4 required
ClassifyPayloadModel_Category
object
2 properties 1 required
IAssetModel
object
1 required
FileType
IValidationTruthModelLocateBoxTruthModel
object
4 properties 2 required
IRapidResultModelLocateResultModel
object
3 properties 3 required
MetadataInputCollection
object
IRapidPayloadModelBoundingBoxPayloadModel
object
2 properties 2 required
NamedEntityResultModel_NamedClassification
object
3 properties 3 required
IRapidResultModelScrubResultModel
object
3 properties 3 required
IValidationTruthModelBoundingBoxTruthModel
object
5 properties 5 required
IRapidResultModelAttachCategoryResultModel
object
3 properties 3 required
MetadataModelCollection
object
FeatureFlag
object
2 properties 2 required
IRapidPayloadModelLocatePayloadModel
object
2 properties 2 required
MetadataVisibilities
array
IAssetModelNullAssetModel
object
3 properties 3 required
IRapidResultModelFreeTextResultModel
object
3 properties 3 required
RapidStateModel
IRapidPayloadModel
object
1 required
IMetadataModelVideoDurationMetadataModel
object
2 properties 2 required
LineResultModel_LinePoint
object
2 properties 2 required
IAssetInputTextAssetInput
object
4 properties 2 required
CreateDemographicRapidEndpoint_Output
object
1 property 1 required
ScrubTruthModel_ScrubRange
object
2 properties 2 required
IRefereeInfoModelProbabilisticAttachCategoryRefereeInfoModel
object
3 properties 3 required
IMetadataModelOriginalFilenameMetadataModel
object
2 properties 2 required
IRapidPayloadModelPolygonPayloadModel
object
2 properties 2 required
IRefereeInfoModelNaiveRefereeInfoModel
object
3 properties 1 required
LineResultModel_Line
object
2 properties 2 required
IRapidPayloadModelClassifyPayloadModel
object
3 properties 3 required
IRefereeInfoModelQuorumRefereeInfoModel
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
QueryValidationRapidEligibilityEndpoint_Output
object
5 properties 5 required
PolygonResultModel_Shape
object
1 property 1 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
IRapidResultModelBoundingBoxResultModel
object
3 properties 3 required
IValidationTruthModelCompareTruthModel
object
2 properties 2 required
IMetadataModelStreamsMetadataModel
object
4 properties 4 required
LocateCoordinateModel
object
2 properties 2 required
ValidationProblemDetails
object
6 properties
QueryFlaggedRapidsEndpoint_Output
object
13 properties 13 required
IRapidResultModelPolygonResultModel
object
3 properties 3 required
QueryValidationRapidEligibilityEndpoint_PagedResultOfOutput
object
5 properties 4 required
IRapidResultModel
object
1 required
TranscriptionTruthModel_TranscriptionWord
object
2 properties 2 required
IMetadataModelImageDimensionMetadataModel
object
3 properties 1 required
GetGlobalResponsesEndpoint_Output
object
1 property 1 required
IValidationTruthModelAttachCategoryTruthModel
object
2 properties 2 required
IMetadataModelCountMetadataModel
object
2 properties 2 required
IRefereeInfoModelNeverEndingRefereeInfoModel
object
1 property 1 required
IRapidResultModelLineResultModel
object
3 properties 3 required
IRapidResultModelCompareResultModel
object
3 properties 2 required
GetGlobalResponsesEndpoint_Output_Response
object
6 properties 3 required
ClassifyPayloadModel
object
2 properties 2 required
IRapidPayloadModelLinePayloadModel
object
2 properties 2 required
IRapidPayloadModelComparePayloadModel
object
2 properties 2 required
NamedEntityTruthModel_NamedClassification
object
3 properties 3 required
IAssetInputMultiAssetInput
object
4 properties 2 required
GetResponsesForRapidEndpoint_Output
object
4 properties 4 required
IAssetModelMultiAssetModel
object
4 properties 4 required
IMetadataModelSourceUrlMetadataModel
object
2 properties 2 required
PolygonResultModel_Coordinate
object
2 properties 2 required
IValidationTruthModelSkipTruthModel
object
1 property 1 required
IAssetModelTextAssetModel
object
4 properties 4 required
IValidationTruthModelMultiCompareTruthModel
object
2 properties 2 required
IRapidPayloadModelScrubPayloadModel
object
2 properties 2 required
IRapidResultModelTranscriptionResultModel
object
3 properties 3 required
IValidationTruthModelScrubTruthModel
object
2 properties 2 required
IAssetInput
object
1 required
IRefereeInfoModel
object
1 required
BoundingBoxResultModel_Box
object
4 properties
IRapidPayloadModelTranscriptionPayloadModel
object
3 properties 3 required
IRapidResultModelNamedEntityResultModel
object
3 properties 3 required
CreateDemographicRapidEndpoint_Input
object
6 properties 2 required
IAssetInputExistingAssetInput
object
4 properties 2 required
IValidationTruthModelPolygonTruthModel
object
1 property 1 required
IAssetModelFileAssetModel
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapidata-customerrapid-api-openapi.yml Raw ↑

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 Datapoints API