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

The SampleGeneration API from Rapidata — 5 operation(s) for samplegeneration.

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

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

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

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

5 operations 5 paths 12 schemas 3 GET2 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 SampleGeneration 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 5

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

SampleGeneration 5
POST
/benchmark/{benchmarkId}/sample-generation
Starts an asynchronous sample generation run.
1 param body → 200400401403
GET
/benchmark/sample-generation/{sampleGenerationId}
Returns the current status and progress of a sample generation request.
1 param → 200400401403
GET
/benchmark/sample-generation/{sampleGenerationId}/items
Returns the per-item audit trail for a sample generation request.
9 params → 200400401403
GET
/benchmark/{benchmarkId}/sample-generations
Lists historical sample generation runs for the given benchmark.
6 params → 200400401403
POST
/benchmark/sample-generation/{sampleGenerationId}/retry
Re-queues failed items of a sample generation so they run again.
1 param body → 200400401403

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are QuerySampleGenerationsByBenchmarkEndpoint_Output (13 properties), GetSampleGenerationEndpoint_Output (13 properties), GetSampleGenerationItemsEndpoint_Output (12 properties), ValidationProblemDetails (6 properties). Each schema is shown below with its type and property counts.

GetSampleGenerationItemsEndpoint_Output
object
12 properties 10 required
GetSampleGenerationItemsEndpoint_PagedResultOfOutput
object
5 properties 4 required
RetrySampleGenerationEndpoint_Input
object
1 property
QuerySampleGenerationsByBenchmarkEndpoint_PagedResultOfOutput
object
5 properties 4 required
ValidationProblemDetails
object
6 properties
CreateSampleGenerationEndpoint_Input
object
4 properties 1 required
QuerySampleGenerationsByBenchmarkEndpoint_Output
object
13 properties 10 required
GetSampleGenerationEndpoint_Output
object
13 properties 10 required
CreateSampleGenerationEndpoint_Output
object
3 properties 3 required
SampleGenerationStatus
SampleGenerationItemStatus
RetrySampleGenerationEndpoint_Output
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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