Sample

Queries all samples of a participant.

Changed on
get/participant/{participantId}/samples

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/participant/{participantId}/samples
  • 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 query samples for.

Query parameters

fillMissingboolean

Whether to fill missing samples with placeholders.

tagsstring[]

The tags to filter the samples by; a sample matches when any of its prompt tags is in this list.

pageinteger

The 1-based page index.

page_sizeinteger

The number of items per page.

sortstring[]

Sort fields. Prefix with - for descending order (e.g. -created_at).

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by identifier.

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by created_at.

logic'and' | 'or'

How to combine the field filters: "and" (default) requires every filter to match, "or" requires any of them to match.

Response

OK

totalinteger required
pageinteger required
pageSizeinteger required
totalPagesinteger

Changes

  • bf98b6cb9b5aRevision changes
    • info

      added the optional property ////// to the response with the status

  • 21c16ab2e7abRevision changes
    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status