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

The Participant API from Rapidata — 9 operation(s) for participant.

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

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

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

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

12 operations 9 paths 24 schemas 3 DELETE1 GET1 PATCH5 POST2 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 Participant 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 12

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

Participant 12
POST
/participant/{participantId}/sample
Adds a sample to a participant.
1 param body → 200400401403
POST
/participant/{participantId}/sample-new
Adds a sample to a participant.
1 param body → 200400401403
DELETE
/participant/{participantId}
Deletes a participant.
1 param → 204400401403
GET
/participant/{participantId}
Gets a participant by its id.
1 param → 200400401403
PATCH
/participant/{participantId}
Updates a participant using patch semantics.
1 param body → 204400401403
DELETE
/participant-sample/{sampleId}
Deletes a participant sample.
1 param → 204400401403
POST
/participant/{participantId}/disable
Disables a participant in a benchmark.
1 param → 204400401403
POST
/participant/{participantId}/enable
Enables a previously disabled participant in a benchmark.
1 param → 204400401403
DELETE
/participant/{participantId}/faucet
Removes the faucet configuration from a participant.
1 param → 204400401403
PUT
/participant/{participantId}/faucet
Sets the faucet used to auto-generate samples for a participant.
1 param body → 204400401403
POST
/participants/{participantId}/submit
Submits a participant to a benchmark.
1 param → 200400401403
PUT
/participant/{participantId}/name
Updates the name of a participant.
1 param body → 204400401403

Schemas 24

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

CreateSampleEndpoint_Output
object
1 property 1 required
CreateSampleEndpoint_Input
object
2 properties 2 required
MetadataVisibilities
array
IAssetInputMultiAssetInput
object
4 properties 2 required
ExistingAssetInput
object
3 properties 1 required
ValidationProblemDetails
object
6 properties
IAssetInputTextAssetInput
object
4 properties 2 required
ParticipantStatus
SubmitParticipantEndpoint_Output
object
2 properties 2 required
GetParticipantByIdEndpoint_Output
object
8 properties 4 required
CreateSampleNewEndpoint_Input
object
2 properties 2 required
IMetadataInputTextMetadataInput
object
3 properties 3 required
IFaucetOutputManagedFaucetOutput
object
2 properties 1 required
IAssetInput
object
1 required
UpdateParticipantNameEndpoint_Input
object
1 property 1 required
IFaucetOutputReplicateFaucetOutput
object
5 properties 4 required
IFaucetOutput
object
1 required
UpdateParticipantEndpoint_Input
object
5 properties
CreateSampleNewEndpoint_Output
object
1 property 1 required
MetadataInputCollection
object
IMetadataInput
object
1 required
IAssetInputExistingAssetInput
object
4 properties 2 required
IFaucetInputReplicateFaucetInput
object
Configures a faucet that generates samples via the Replicate API.
5 properties 3 required
IFaucetInput
object
Polymorphic request body describing a faucet to configure on a participant. The concrete type is selected by the t discriminator (e.g. "Replicate").
1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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