Participant

Updates a participant using patch semantics.

Changed on

Setting a faucet returns 403 unless the caller's organization has been granted the Faucets capability.

patch/participant/{participantId}

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/participant/{participantId}
  • Auth
    OpenID Connect (https://auth.rapidata.ai/.well-known/openid-configuration, scopes: openid, profile, email, offline_access, api)

Path parameters

participantIdstring required

The id of the participant to update.

Request body

namestring

The new name of the participant.

familystring nullable

The family the underlying model belongs to (e.g. "Flux", "GPT"). Pass null to clear.

labstring nullable

The lab that makes the model (e.g. "OpenAI", "Black Forest Labs"). Pass null to clear.

proprietaryNamestring nullable

The vendor-facing display name of the model. Pass null to clear.

licenseType'OpenSource' | 'Proprietary' nullable

The license classification of the underlying model behind a participant.

costnumber double nullable

The model's price in USD per costUnit. Pass null to clear. Set and cleared together with costUnit.

costUnit'UsdPerImage' | 'UsdPerVideoSecond' | 'UsdPerMillionTokens' | 'UsdPerSample' nullable

The unit a model's cost is quoted in. Costs are only comparable within one unit.

votesExcludedboolean

Whether the participant's already-collected votes are dropped from the scores. Only allowed while it is disabled; enabling it resets this to false.

Response

No Content

Changes

  • c72c9f1c8ef5Revision changes
    • breaking

      removed the enum value undefined of the request property ////

    • breaking

      removed the enum value undefined of the request property ////

  • ee9d3d550b23Revision changes
    • info

      added the new UsdPerSample enum value to the request property ////