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

The Workflow API from Rapidata — 5 operation(s) for workflow.

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

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

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

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

6 operations 5 paths 78 schemas 1 DELETE5 GET

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 Workflow 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 6

Across 5 paths, the API surfaces 6 operations — 1 DELETE, 5 GET. Each is listed below with its method, path, parameters, and response codes.

Workflow 6
DELETE
/workflow/{workflowId}
Deletes a workflow by its id.
1 param → 204400401403
GET
/workflow/{workflowId}
Returns the workflow identified by workflowId.
1 param → 200400401403
GET
/workflow/{workflowId}/compare-ab-summary
Returns the number of times each asset index won across the workflow's rapids.
2 params → 200400401403
GET
/workflow/{workflowId}/progress
Gets the progress of a workflow.
1 param → 200400401403
GET
/workflow/{workflowId}/responses
Gets the most recent or oldest responses for a workflow, across any rapid.
3 params → 200400401403
GET
/workflows
Queries workflows based on the provided filter, page, and sort criteria.
8 params → 200400401403

Schemas 78

The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are IWorkflowModelRankingWorkflowModel (11 properties), IWorkflowModelGroupedRankingWorkflowModel (8 properties), GetWorkflowResponsesEndpoint_Response (8 properties), IWorkflowModelSimpleWorkflowModel (7 properties). Each schema is shown below with its type and property counts.

IWorkflowModelSimpleWorkflowModel
object
7 properties 7 required
IRankingConfigModelBradleyTerryRankingConfigModel
object
2 properties 2 required
IMetadataModel
object
1 required
IMetadataModelFileTypeMetadataModel
object
2 properties 2 required
NamedClassification
object
3 properties 1 required
IRefereeConfigModelNeverEndingRefereeConfigModel
object
1 property 1 required
BoxShape
object
4 properties
IAssetModel
object
1 required
IRapidResult
object
1 required
IRefereeConfigModelProbabilisticAttachCategoryRefereeConfigModel
object
3 properties 3 required
FileType
IRefereeConfigModel
object
1 required
IRankingConfigModelEloConfigModel
object
4 properties 4 required
IWorkflowRapidBlueprintModelFreeTextWorkflowRapidBlueprintModel
object
4 properties 3 required
GetWorkflowByIdEndpoint_Output
object
1 property 1 required
PolygonCoordinate
object
2 properties
IRapidResultAttachCategoryResult
object
3 properties 3 required
IRefereeConfigModelBudgetRefereeConfigModel
object
3 properties 2 required
MetadataModelCollection
object
IRapidResultLocateResult
object
3 properties 3 required
IAssetModelNullAssetModel
object
3 properties 3 required
WorkflowStateModel
LocateCoordinate
object
2 properties
IMetadataModelVideoDurationMetadataModel
object
2 properties 2 required
IRapidResultScrubResult
object
3 properties 3 required
IWorkflowModelEvaluationWorkflowModel
object
7 properties 7 required
GetWorkflowResponsesEndpoint_Response
object
8 properties 8 required
TranscriptionWord
object
2 properties 1 required
IMetadataModelOriginalFilenameMetadataModel
object
2 properties 2 required
PolygonShape
object
1 property 1 required
IWorkflowModel
object
1 required
IRapidResultFreeTextResult
object
3 properties 3 required
IWorkflowRapidBlueprintModelCompareWorkflowRapidBlueprintModel
object
3 properties 3 required
IWorkflowRapidBlueprintModelTranscriptionWorkflowRapidBlueprintModel
object
2 properties 2 required
IMetadataModelLocationMetadataModel
object
3 properties 3 required
IWorkflowRapidBlueprintModelAttachCategoryWorkflowRapidBlueprintModel
object
3 properties 3 required
IWorkflowRapidBlueprintModelNamedEntityWorkflowRapidBlueprintModel
object
3 properties 3 required
QueryWorkflowsEndpoint_PagedResultOfOutput
object
5 properties 4 required
IRapidResultTranscriptionResult
object
3 properties 3 required
IMetadataModelClassificationMetadataModel
object
2 properties 2 required
IRapidResultLineResult
object
3 properties 3 required
IMetadataModelTextMetadataModel
object
2 properties 2 required
IWorkflowModelRankingWorkflowModel
object
11 properties 10 required
IMetadataModelStreamsMetadataModel
object
4 properties 4 required
ValidationProblemDetails
object
6 properties
IRapidResultCompareResult
object
3 properties 3 required
GetWorkflowProgressEndpoint_Output
object
4 properties 4 required
Line
object
2 properties 1 required
SortDirection
IPairMakerInformationModelOnlinePairMakerInformationModel
object
4 properties 4 required
IWorkflowRapidBlueprintModelBoundingBoxWorkflowRapidBlueprintModel
object
2 properties 2 required
IWorkflowRapidBlueprintModelPolygonWorkflowRapidBlueprintModel
object
2 properties 2 required
IWorkflowModelGroupedRankingWorkflowModel
object
8 properties 7 required
IMetadataModelImageDimensionMetadataModel
object
3 properties 1 required
GetWorkflowResponsesEndpoint_Output
object
1 property 1 required
IMetadataModelCountMetadataModel
object
2 properties 2 required
IRefereeConfigModelQuorumRefereeConfigModel
object
3 properties 3 required
IWorkflowRapidBlueprintModelLineWorkflowRapidBlueprintModel
object
2 properties 2 required
IRapidResultPolygonResult
object
3 properties 3 required
IWorkflowRapidBlueprintModelScrubWorkflowRapidBlueprintModel
object
2 properties 2 required
IRankingConfigModel
object
1 required
IAssetModelMultiAssetModel
object
4 properties 4 required
IMetadataModelSourceUrlMetadataModel
object
2 properties 2 required
WorkflowState
QueryWorkflowsEndpoint_Output
object
1 property 1 required
IRapidResultBoundingBoxResult
object
3 properties 3 required
IWorkflowRapidBlueprintModelLocateWorkflowRapidBlueprintModel
object
2 properties 2 required
IAssetModelTextAssetModel
object
4 properties 4 required
IWorkflowRapidBlueprintModel
object
1 required
LinePoint
object
2 properties
AttachCategoryWorkflowRapidBlueprintModel_Category
object
2 properties 2 required
IRapidResultSkipResult
object
2 properties 2 required
IPairMakerInformationModel
object
1 required
GetCompareAbSummaryEndpoint_Output
object
2 properties 2 required
IPairMakerInformationModelFullPermutationPairMakerInformationModel
object
1 property 1 required
IRapidResultNamedEntityResult
object
3 properties 3 required
IAssetModelFileAssetModel
object
4 properties 4 required
IRefereeConfigModelNaiveRefereeConfigModel
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapidata-workflow-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 CustomerRapid API