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

The Examples API from Rapidata — 4 operation(s) for examples.

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

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

This API exposes 4 operations across 4 paths, and defines 53 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 53 schemas 1 DELETE1 GET1 PATCH1 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 Examples 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 — 1 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Examples 4
POST
/audience/{audienceId}/example
Adds a new example to an audience.
1 param body → 200400401403
DELETE
/audience/example/{exampleId}
Deletes the specified audience example.
1 param → 200400401403
GET
/audience/{audienceId}/examples
Queries all examples for the specified audience.
7 params → 200400401403
PATCH
/audience/{audienceId}/example/{exampleId}
Updates an example's properties within an audience.
2 params body → 204400401403

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are QueryExamplesForAudienceEndpoint_Output (14 properties), AddExampleToAudienceEndpoint_Input (11 properties), UpdateAudienceExampleEndpoint_Input (8 properties), ValidationProblemDetails (6 properties). Each schema is shown below with its type and property counts.

IExampleTruthLineExampleTruth
object
4 properties 1 required
IExamplePayloadTranscriptionExamplePayload
object
3 properties 3 required
MetadataModelCollection
object
IExamplePayloadScrubExamplePayload
object
2 properties 2 required
IExamplePayloadLocateExamplePayload
object
2 properties 2 required
IExamplePayloadClassifyExamplePayload
object
3 properties 3 required
IMetadataModelClassificationMetadataModel
object
2 properties 2 required
IExampleTruthScrubExampleTruth
object
2 properties 2 required
FeatureFlag
object
2 properties 2 required
IMetadataModelTextMetadataModel
object
2 properties 2 required
MetadataVisibilities
array
IAssetModelNullAssetModel
object
3 properties 3 required
IExampleTruth
object
1 required
IAssetInputMultiAssetInput
object
4 properties 2 required
IExampleTruthClassifyExampleTruth
object
2 properties 2 required
IMetadataModel
object
1 required
ExampleBoxShape
object
4 properties
IMetadataModelFileTypeMetadataModel
object
2 properties 2 required
IAssetModelMultiAssetModel
object
4 properties 4 required
IMetadataModelSourceUrlMetadataModel
object
2 properties 2 required
IMetadataModelVideoDurationMetadataModel
object
2 properties 2 required
UpdateAudienceExampleEndpoint_Input
object
Input model for updating an audience example.
8 properties
IMetadataModelStreamsMetadataModel
object
4 properties 4 required
IExamplePayloadCompareExamplePayload
object
2 properties 2 required
AddExampleToAudienceEndpoint_Input
object
Input model for adding an example to an audience.
11 properties 3 required
ValidationProblemDetails
object
6 properties
IAssetInputTextAssetInput
object
4 properties 2 required
DeleteAudienceExampleEndpoint_Output
object
1 property
IAssetModelTextAssetModel
object
4 properties 4 required
QueryExamplesForAudienceEndpoint_Output
object
14 properties 5 required
IMetadataInputTextMetadataInput
object
3 properties 3 required
IAssetInput
object
1 required
IMetadataModelOriginalFilenameMetadataModel
object
2 properties 2 required
IAssetModel
object
1 required
AddExampleToAudienceEndpoint_Output
object
1 property
QueryExamplesForAudienceEndpoint_PagedResultOfOutput
object
5 properties 4 required
IExampleTruthTranscriptionExampleTruth
object
5 properties 2 required
FileType
IExampleTruthCompareExampleTruth
object
2 properties 2 required
IExampleTruthLocateExampleTruth
object
4 properties 2 required
MetadataInputCollection
object
IMetadataModelImageDimensionMetadataModel
object
3 properties 1 required
IMetadataModelCountMetadataModel
object
2 properties 2 required
ExampleVisibility
IMetadataModelLocationMetadataModel
object
3 properties 3 required
ExampleCategory
object
2 properties 2 required
ExampleTranscriptionWord
object
2 properties 2 required
IExamplePayload
object
1 required
IMetadataInput
object
1 required
IAssetInputExistingAssetInput
object
4 properties 2 required
IExamplePayloadLineExamplePayload
object
2 properties 2 required
ExampleScrubRange
object
2 properties 2 required
IAssetModelFileAssetModel
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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