---
title: "Gets navigation context (previous, next, related samples) for a sample."
method: GET
path: "/benchmark-sample/{sampleId}/navigation"
tags: ["Sample"]
---

# Gets navigation context (previous, next, related samples) for a sample.

`GET /benchmark-sample/{sampleId}/navigation`

Returns 400 when relatedLimit is outside 1..500. Use
 GET /benchmark/{benchmarkId}/samples/{identifier} to page through identifiers
 that carry more related samples than a single navigation response can hold.

## Path parameters

- `sampleId` string, required

## Query parameters

- `relatedLimit` integer

## Response `200`

OK

- GetSampleNavigationEndpointOutput
  - `current` GetSampleNavigationEndpointSample, required
    - `id` string, required
    - `identifier` string, required
    - `participantId` string, required
    - `participantName` string, required
    - `asset` union, required
      - object
        - `_t` 'FileAsset', required
        - `fileName` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - object
        - `_t` 'MultiAsset', required
        - `assets` IAsset[], required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - object
        - `_t` 'NullAsset', required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - object
        - `_t` 'TextAsset', required
        - `text` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
    - `englishPrompt` string, nullable
    - `originalPrompt` string, nullable
    - `promptAsset` union
      - IAssetFileAsset
        - `_t` 'FileAsset', required
        - `fileName` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - IAssetMultiAsset
        - `_t` 'MultiAsset', required
        - `assets` IAsset[], required
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - IAssetNullAsset
        - `_t` 'NullAsset', required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - IAssetTextAsset
        - `_t` 'TextAsset', required
        - `text` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
    - `tags` string[], required
    - `createdAt` string, date-time
    - `ownerId` string, uuid
    - `ownerMail` string, required
    - `organizationId` string, required
  - `previous` GetSampleNavigationEndpointSample[], required — Up to three samples of the same participant preceding the current sample, ordered ascending by identifier. Empty when the current sample is the first of its participant.
    - `id` string, required
    - `identifier` string, required
    - `participantId` string, required
    - `participantName` string, required
    - `asset` union, required
      - object
        - `_t` 'FileAsset', required
        - `fileName` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - object
        - `_t` 'MultiAsset', required
        - `assets` IAsset[], required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - object
        - `_t` 'NullAsset', required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - object
        - `_t` 'TextAsset', required
        - `text` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
    - `englishPrompt` string, nullable
    - `originalPrompt` string, nullable
    - `promptAsset` union
      - IAssetFileAsset
        - `_t` 'FileAsset', required
        - `fileName` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - IAssetMultiAsset
        - `_t` 'MultiAsset', required
        - `assets` IAsset[], required
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - IAssetNullAsset
        - `_t` 'NullAsset', required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - IAssetTextAsset
        - `_t` 'TextAsset', required
        - `text` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
    - `tags` string[], required
    - `createdAt` string, date-time
    - `ownerId` string, uuid
    - `ownerMail` string, required
    - `organizationId` string, required
  - `next` GetSampleNavigationEndpointSample[], required — Up to three samples of the same participant following the current sample, ordered ascending by identifier. Empty when the current sample is the last of its participant.
    - `id` string, required
    - `identifier` string, required
    - `participantId` string, required
    - `participantName` string, required
    - `asset` union, required
      - object
        - `_t` 'FileAsset', required
        - `fileName` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - object
        - `_t` 'MultiAsset', required
        - `assets` IAsset[], required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - object
        - `_t` 'NullAsset', required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - object
        - `_t` 'TextAsset', required
        - `text` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
    - `englishPrompt` string, nullable
    - `originalPrompt` string, nullable
    - `promptAsset` union
      - IAssetFileAsset
        - `_t` 'FileAsset', required
        - `fileName` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - IAssetMultiAsset
        - `_t` 'MultiAsset', required
        - `assets` IAsset[], required
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - IAssetNullAsset
        - `_t` 'NullAsset', required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - IAssetTextAsset
        - `_t` 'TextAsset', required
        - `text` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
    - `tags` string[], required
    - `createdAt` string, date-time
    - `ownerId` string, uuid
    - `ownerMail` string, required
    - `organizationId` string, required
  - `related` GetSampleNavigationEndpointSample[], required — Samples of other participants in the same benchmark that share the current sample's identifier, ordered by participant name and capped at the requested related limit.
    - `id` string, required
    - `identifier` string, required
    - `participantId` string, required
    - `participantName` string, required
    - `asset` union, required
      - object
        - `_t` 'FileAsset', required
        - `fileName` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - object
        - `_t` 'MultiAsset', required
        - `assets` IAsset[], required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - object
        - `_t` 'NullAsset', required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - object
        - `_t` 'TextAsset', required
        - `text` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
    - `englishPrompt` string, nullable
    - `originalPrompt` string, nullable
    - `promptAsset` union
      - IAssetFileAsset
        - `_t` 'FileAsset', required
        - `fileName` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - IAssetMultiAsset
        - `_t` 'MultiAsset', required
        - `assets` IAsset[], required
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - IAssetNullAsset
        - `_t` 'NullAsset', required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
      - IAssetTextAsset
        - `_t` 'TextAsset', required
        - `text` string, required
        - `metadata` MetadataModelCollection, required
        - `identifier` string, required
    - `tags` string[], required
    - `createdAt` string, date-time
    - `ownerId` string, uuid
    - `ownerMail` string, required
    - `organizationId` string, required

## Other responses

- `400` — Bad Request
- `401` — Unauthenticated
- `403` — Forbidden

---

[API](https://skmtc.net/rapidata/apis/rapidata-api.md) · [All operations](https://skmtc.net/rapidata/apis/rapidata-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rapidata/rapidata-api/revisions/d779de93a5ee/schema)