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

The Pipeline API from Rapidata — 3 operation(s) for pipeline.

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

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

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

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

3 operations 3 paths 58 schemas 2 GET1 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 Pipeline 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 3

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

Pipeline 3
GET
/pipeline/{pipelineId}
Gets a pipeline by its id.
1 param → 200400401403
GET
/pipeline/preliminary-download/{preliminaryDownloadId}
Streams the preliminary download file when ready.
1 param → 200202400401403
POST
/pipeline/{pipelineId}/preliminary-download
Initiates a preliminary download of the pipeline.
1 param body → 200400401403

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are IWorkflowConfigRankingWorkflowConfig (8 properties), IWorkflowConfigGroupedRankingWorkflowConfig (8 properties), ValidationProblemDetails (6 properties), IMetadataStreamsMetadata (5 properties). Each schema is shown below with its type and property counts.

StartPreliminaryDownloadEndpoint_Input
object
1 property
IWorkflowConfigGroupedRankingWorkflowConfig
object
8 properties 6 required
IRankingConfigEloRankingConfig
object
4 properties 4 required
IMetadataImageDimensionMetadata
object
4 properties 2 required
IArtifactModel
object
1 required
StartPreliminaryDownloadEndpoint_Output
object
1 property 1 required
IArtifactModelFileArtifactModel
object
3 properties 3 required
IArtifactModelWorkflowArtifactModel
object
3 properties 3 required
IArtifactModelWorkflowConfigArtifactModel
object
3 properties 3 required
FeatureFlag
object
2 properties 2 required
GetPipelineByIdEndpoint_Output
object
2 properties 2 required
IRapidBlueprint
object
1 required
MetadataVisibilities
array
IRapidBlueprintAttachCategoryRapidBlueprint
object
4 properties 3 required
IMetadataDurationMetadata
object
3 properties 3 required
IMetadataFileTypeMetadata
object
3 properties 3 required
IArtifactModelCampaignArtifactModel
object
3 properties 3 required
IPairMakerConfigFullPermutationPairMakerConfig
object
1 property 1 required
AttachCategoryRapidBlueprint_Category
object
2 properties 2 required
IAssetTextAsset
object
3 properties 3 required
ValidationProblemDetails
object
6 properties
IRapidBlueprintPolygonRapidBlueprint
object
2 properties 2 required
IRankingConfig
object
1 required
IRefereeConfigQuorumRefereeConfig
object
3 properties 3 required
IMetadataStreamsMetadata
object
5 properties 2 required
IRapidBlueprintBoundingBoxRapidBlueprint
object
2 properties 2 required
IRapidBlueprintFreeTextRapidBlueprint
object
4 properties 2 required
IRapidBlueprintNamedEntityRapidBlueprint
object
3 properties 3 required
IWorkflowConfigEvaluationWorkflowConfig
object
5 properties 4 required
IAssetMultiAsset
object
3 properties 3 required
IRankingConfigBradleyTerryRankingConfig
object
2 properties 2 required
IArtifactModelDatasetArtifactModel
object
3 properties 3 required
IRapidBlueprintCompareRapidBlueprint
object
3 properties 2 required
IWorkflowConfig
object
1 required
IRefereeConfig
object
1 required
IAsset
object
1 required
IRefereeConfigNaiveRefereeConfig
object
2 properties 2 required
FileType
IWorkflowConfigRankingWorkflowConfig
object
8 properties 4 required
IMetadataClassificationMetadata
object
3 properties 3 required
IRapidBlueprintLocateRapidBlueprint
object
2 properties 2 required
IPairMakerConfigOnlinePairMakerConfig
object
3 properties 3 required
IRefereeConfigProbabilisticAttachCategoryRefereeConfig
object
3 properties 3 required
IRefereeConfigNeverEndingRefereeConfig
object
1 property 1 required
IRapidBlueprintTranscriptionRapidBlueprint
object
2 properties 2 required
IMetadataCountMetadata
object
3 properties 2 required
IMetadataSourceUrlMetadata
object
3 properties 3 required
IMetadataOriginalFilenameMetadata
object
3 properties 3 required
IAssetFileAsset
object
3 properties 3 required
IRapidBlueprintScrubRapidBlueprint
object
2 properties 2 required
IMetadataTextMetadata
object
3 properties 2 required
IAssetNullAsset
object
2 properties 2 required
IMetadata
object
1 required
IWorkflowConfigSimpleWorkflowConfig
object
5 properties 3 required
IPairMakerConfig
object
1 required
IRefereeConfigBudgetRefereeConfig
object
3 properties 2 required
IRapidBlueprintLineRapidBlueprint
object
2 properties 2 required
IMetadataLocationMetadata
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapidata-pipeline-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