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

The Sample API from Rapidata — 4 operation(s) for sample.

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

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

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

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

4 operations 4 paths 28 schemas 4 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 Sample 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 4

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

Sample 4
GET
/benchmark-sample/{sampleId}
Gets a benchmark sample by its id.
1 param → 200400401403
GET
/benchmark-sample/{sampleId}/navigation
Gets navigation context (previous, next, related samples) for a sample.
1 param → 200400401403
GET
/benchmark/{benchmarkId}/samples/{identifier}
Returns the paged samples of a benchmark filtered by an identifier.
9 params → 200400401403
GET
/participant/{participantId}/samples
Queries all samples of a participant.
9 params → 200400401403

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are GetSamplesByIdentifierEndpoint_Output (12 properties), GetSampleByIdEndpoint_Output (12 properties), GetSampleNavigationEndpoint_SampleModel (12 properties), GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput (11 properties). Each schema is shown below with its type and property counts.

GetSampleNavigationEndpoint_Output
object
4 properties 4 required
GetSamplesByIdentifierEndpoint_PagedResultOfOutput
object
5 properties 4 required
MetadataModelCollection
object
IMetadataModelClassificationMetadataModel
object
2 properties 2 required
GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput
object
11 properties 6 required
IMetadataModelTextMetadataModel
object
2 properties 2 required
IAssetModelNullAssetModel
object
3 properties 3 required
IMetadataModelFileTypeMetadataModel
object
2 properties 2 required
IMetadataModel
object
1 required
GetSamplesByParticipantEndpoint_ISampleOutput
object
Represents a sample returned for a participant.
1 required
IAssetModelMultiAssetModel
object
4 properties 4 required
IMetadataModelSourceUrlMetadataModel
object
2 properties 2 required
IMetadataModelVideoDurationMetadataModel
object
2 properties 2 required
IMetadataModelStreamsMetadataModel
object
4 properties 4 required
GetSamplesByParticipantEndpoint_PagedResultOfISampleOutput
object
5 properties 4 required
ValidationProblemDetails
object
6 properties
IAssetModelTextAssetModel
object
4 properties 4 required
GetSamplesByIdentifierEndpoint_Output
object
12 properties 7 required
GetSampleNavigationEndpoint_SampleModel
object
12 properties 7 required
IMetadataModelOriginalFilenameMetadataModel
object
2 properties 2 required
IAssetModel
object
1 required
FileType
GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_PlaceholderSampleOutput
object
6 properties 3 required
IMetadataModelImageDimensionMetadataModel
object
3 properties 1 required
GetSampleByIdEndpoint_Output
object
12 properties 7 required
IMetadataModelCountMetadataModel
object
2 properties 2 required
IMetadataModelLocationMetadataModel
object
3 properties 3 required
IAssetModelFileAssetModel
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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