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

The Benchmark API from Rapidata — 19 operation(s) for benchmark.

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

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

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

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

22 operations 19 paths 64 schemas 2 DELETE12 GET1 PATCH6 POST1 PUT

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 Benchmark 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 22

Across 19 paths, the API surfaces 22 operations — 2 DELETE, 12 GET, 1 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Benchmark 22
POST
/benchmark
Creates a benchmark.
body → 200400401403
POST
/benchmark/{benchmarkId}/participants
Creates a participant in a benchmark.
1 param body → 200400401403
GET
/benchmark/{benchmarkId}/participants
Queries all participants within a benchmark.
8 params → 200400401403
POST
/benchmark/{benchmarkId}/prompt
Adds a new prompt to a benchmark.
1 param body → 200400401403
DELETE
/benchmark/{benchmarkId}
Deletes a benchmark.
1 param → 204400401403
GET
/benchmark/{benchmarkId}
Returns a single benchmark by its id.
1 param → 200400401403
PATCH
/benchmark/{benchmarkId}
Updates a benchmark using patch semantics.
1 param body → 204400401403
DELETE
/benchmark/{benchmarkId}/participant/{participantId}
Deletes a participant on a benchmark.
2 params → 204400401403
POST
/benchmark/{benchmarkId}/fork
Creates a copy of a public benchmark and all of its related entities.
1 param → 200400401403
GET
/benchmark/{benchmarkId}/prompts
Returns the paged prompts of a benchmark.
10 params → 200400401403
GET
/benchmarks
Queries all benchmarks of the current user.
8 params → 200400401403
GET
/benchmark/combined-matrix/query
Queries the combined win matrix of multiple benchmarks.
14 params → 200400401403
GET
/benchmark/combined-standings/query
Queries the combined standings of multiple benchmarks.
14 params → 200400401403
GET
/benchmark/{benchmarkId}/leaderboards
Queries all leaderboards for the given benchmark.
7 params → 200400401403
GET
/benchmarks/managed
Queries the curated benchmarks available to every customer.
8 params → 200400401403
GET
/benchmark/{benchmarkId}/matrix/query
Queries the win matrix of a benchmark.
14 params → 200400401403
GET
/benchmarks/published
Queries the benchmarks surfaced in the public benchmark repository.
8 params → 200400401403
GET
/benchmark/{benchmarkId}/standings/query
Queries the standings of a benchmark.
14 params → 200400401403
GET
/benchmark/{benchmarkId}/tags
Queries all tags within a benchmark.
1 param → 200400401403
POST
/benchmark/{benchmarkId}/sample-generation
Starts an asynchronous sample generation run.
1 param body → 200400401403
POST
/benchmark/{benchmarkId}/participants/{participantId}/submit
Submits a participant to a benchmark.
2 params → 200400401403
PUT
/benchmark/{benchmarkId}/name
Updates the name of a benchmark.
1 param body → 204400401403

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are QueryLeaderboardsByBenchmarkEndpoint_Output (16 properties), QueryCombinedStandingsByBenchmarksEndpoint_OutputItem (11 properties), GetBenchmarkByIdEndpoint_Output (11 properties), QueryStandingsByBenchmarkEndpoint_OutputItem (11 properties). Each schema is shown below with its type and property counts.

QueryLeaderboardsByBenchmarkEndpoint_PagedResultOfOutput
object
5 properties 4 required
QueryStandingsByBenchmarkEndpoint_Output
object
The queried standings output.
1 property 1 required
MetadataModelCollection
object
CreateBenchmarkEndpoint_Output
object
1 property 1 required
IMetadataModelClassificationMetadataModel
object
2 properties 2 required
CreatePromptForBenchmarkEndpoint_Output
object
1 property 1 required
FeatureFlag
object
2 properties 2 required
QueryCombinedMatrixByBenchmarksEndpoint_Output
object
3 properties 3 required
CreateBenchmarkEndpoint_Input
object
5 properties 1 required
QueryTagsByBenchmarkEndpoint_Output
object
1 property 1 required
MetadataVisibilities
array
IMetadataModelTextMetadataModel
object
2 properties 2 required
IAssetModelNullAssetModel
object
3 properties 3 required
QueryCombinedStandingsByBenchmarksEndpoint_Output
object
The queried standings output.
1 property 1 required
IAssetInputMultiAssetInput
object
4 properties 2 required
IMetadataModelFileTypeMetadataModel
object
2 properties 2 required
IMetadataModel
object
1 required
IAssetModelMultiAssetModel
object
4 properties 4 required
CreatePromptForBenchmarkEndpoint_Input
object
4 properties 1 required
QueryManagedBenchmarksEndpoint_Output
object
7 properties 7 required
IMetadataModelSourceUrlMetadataModel
object
2 properties 2 required
IMetadataModelVideoDurationMetadataModel
object
2 properties 2 required
QueryParticipantsByBenchmarkEndpoint_PagedResultOfOutput
object
5 properties 4 required
IMetadataModelStreamsMetadataModel
object
4 properties 4 required
ExistingAssetInput
object
3 properties 1 required
StandingStatus
ForkBenchmarkEndpoint_Output
object
1 property 1 required
QueryStandingsByBenchmarkEndpoint_OutputItem
object
11 properties 7 required
CreateSampleGenerationEndpoint_Output
object
3 properties 3 required
ValidationProblemDetails
object
6 properties
IAssetInputTextAssetInput
object
4 properties 2 required
QueryLeaderboardsByBenchmarkEndpoint_Output
object
16 properties 15 required
IAssetModelTextAssetModel
object
4 properties 4 required
ParticipantStatus
CreateBenchmarkParticipantEndpoint_Output
object
2 properties 2 required
GetPromptsByBenchmarkEndpoint_PagedResultOfOutput
object
5 properties 4 required
IMetadataInputTextMetadataInput
object
3 properties 3 required
IAssetInput
object
1 required
IMetadataModelOriginalFilenameMetadataModel
object
2 properties 2 required
IAssetModel
object
1 required
QueryParticipantsByBenchmarkEndpoint_Output
object
7 properties 4 required
FileType
CreateSampleGenerationEndpoint_Input
object
4 properties 1 required
QueryMatrixByBenchmarkEndpoint_Output
object
3 properties 3 required
CreateBenchmarkParticipantEndpoint_Input
object
4 properties 1 required
MetadataInputCollection
object
GetPromptsByBenchmarkEndpoint_Output
object
7 properties 4 required
QueryManagedBenchmarksEndpoint_PagedResultOfOutput
object
5 properties 4 required
QueryBenchmarksEndpoint_PagedResultOfOutput
object
5 properties 4 required
UpdateBenchmarkEndpoint_Input
object
7 properties
IMetadataModelImageDimensionMetadataModel
object
3 properties 1 required
IMetadataModelCountMetadataModel
object
2 properties 2 required
GetBenchmarkByIdEndpoint_Output
object
11 properties 11 required
IMetadataModelLocationMetadataModel
object
3 properties 3 required
ConfidenceInterval
object
2 properties 2 required
QueryBenchmarksEndpoint_Output
object
7 properties 7 required
UpdateBenchmarkNameEndpoint_Input
object
1 property 1 required
IMetadataInput
object
1 required
IAssetInputExistingAssetInput
object
4 properties 2 required
QueryCombinedStandingsByBenchmarksEndpoint_OutputItem
object
11 properties 7 required
SubmitParticipantByBenchmarkEndpoint_Output
object
2 properties 2 required
QueryPublishedBenchmarksEndpoint_PagedResultOfOutput
object
5 properties 4 required
IAssetModelFileAssetModel
object
4 properties 4 required
QueryPublishedBenchmarksEndpoint_Output
object
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapidata-benchmark-api-openapi.yml Raw ↑

Other APIs Rapidata publishes across the network.

Rapidata Asset API
Rapidata Audience API
Rapidata BatchUpload 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
Rapidata Datapoints API