---
title: "Gets the anchor rapid and its surrounding rapids within the results slice, in the order
 and filter the results grid renders, so the explorer can step neighbour-to-neighbour."
method: GET
path: "/rapid/{rapidId}/navigation"
tags: ["Rapid"]
---

# Gets the anchor rapid and its surrounding rapids within the results slice, in the order
 and filter the results grid renders, so the explorer can step neighbour-to-neighbour.

`GET /rapid/{rapidId}/navigation`

Navigation follows the grid's default order (flagged rapids first, then by id) over the
 given correlation slice. Returns 404 when the rapid is not part of the filtered slice.

## Path parameters

- `rapidId` string, required

## Query parameters

- `correlationId` string, required
- `states` RapidState[]
- `window` integer
- `includeNotAccepted` boolean
- `includeOverflow` boolean

## Response `200`

OK

- GetRapidNavigationEndpointOutput
  - `current` GetRapidNavigationEndpointCard, required
    - `rapidId` 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
    - `state` 'Labeling' | 'Paused' | 'Incomplete' | 'Flagged' | 'Done' | 'None' | 'Rejected', required
    - `payload` union, required
      - object
        - `_t` 'BoundingBoxPayload', required
        - `target` string, required
      - object
        - `_t` 'ClassifyPayload', required
        - `categories` ClassifyPayloadCategory[], required
          - `label` string, required
          - `value` string, nullable
        - `title` string, required
      - object
        - `_t` 'ComparePayload', required
        - `criteria` string, required
      - object
        - `_t` 'FreeTextPayload', required
        - `question` string, required
        - `shouldValidateResponse` boolean
        - `validationSystemPrompt` string, nullable
      - object
        - `_t` 'LinePayload', required
        - `target` string, required
      - object
        - `_t` 'LocatePayload', required
        - `target` string, required
      - object
        - `_t` 'NamedEntityPayload', required
        - `target` string, required
        - `classes` string[], required
      - object
        - `_t` 'PolygonPayload', required
        - `target` string, required
      - object
        - `_t` 'ScrubPayload', required
        - `target` string, required
      - object
        - `_t` 'TranscriptionPayload', required
        - `title` string, required
        - `transcription` TranscriptionPayloadTranscriptionWord[], required
          - `word` string, required
          - `wordIndex` integer, required
    - `responses` GetRapidNavigationEndpointCardResponse[], required
      - `id` string, required
      - `userId` string, required
      - `country` string, required
      - `language` string, required
      - `result` union, required
        - object
          - `_t` 'AttachCategoryResult', required
          - `rapidId` string, required
          - `category` string, required
        - object
          - `_t` 'BoundingBoxResult', required
          - `rapidId` string, required
          - `boundingBoxes` BoundingBoxResultBox[], required
            - `xMin` number, double, nullable
            - `yMin` number, double, nullable
            - `xMax` number, double, nullable
            - `yMax` number, double, nullable
        - object
          - `_t` 'CompareResult', required
          - `rapidId` string, required
          - `winners` string[]
        - object
          - `_t` 'FreeTextResult', required
          - `rapidId` string, required
          - `answer` string, required
        - object
          - `_t` 'LineResult', required
          - `rapidId` string, required
          - `lines` LineResultLine[], required
            - `size` number, double, required
            - `points` LineResultLinePoint[], required
              - …
        - object
          - `_t` 'LocateResult', required
          - `rapidId` string, required
          - `coordinates` LocateCoordinate[], required
            - `x` number, double, required
            - `y` number, double, required
        - object
          - `_t` 'NamedEntityResult', required
          - `rapidId` string, required
          - `classifications` NamedEntityResultNamedClassification[], required
            - `start` integer, required
            - `end` integer, required
            - `classification` string, required
        - object
          - `_t` 'PolygonResult', required
          - `rapidId` string, required
          - `shapes` PolygonResultShape[], required
            - `edges` PolygonResultCoordinate[], required
              - …
        - object
          - `_t` 'ScrubResult', required
          - `rapidId` string, required
          - `timestamps` integer[], required
        - object
          - `_t` 'SkipResult', required
          - `rapidId` string, required
        - object
          - `_t` 'TranscriptionResult', required
          - `rapidId` string, required
          - `selectedWords` TranscriptionResultTranscriptionWord[], required
            - `word` string, required
            - `wordIndex` integer, required
      - `userScore` number, double, required
      - `userScores` object, required
      - `demographicInformation` object, required
    - `totalResponseCount` integer, required
    - `context` string, nullable
    - `contextAsset` 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
    - `decisiveness` number, double, nullable
    - `aggregation` union
      - IResponseAggregationClassifyAggregation
        - `_t` 'ClassifyAggregation', required
        - `categoryTallies` object, required
      - IResponseAggregationCompareAggregation
        - `_t` 'CompareAggregation', required
        - `winnerTallies` object, required
  - `previous` GetRapidNavigationEndpointItem[], required — The rapids preceding the anchor in grid order, at most window entries, ordered ascending with the neighbour adjacent to the anchor last.
    - `rapidId` 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
    - `state` 'Labeling' | 'Paused' | 'Incomplete' | 'Flagged' | 'Done' | 'None' | 'Rejected', required
  - `next` GetRapidNavigationEndpointItem[], required — The rapids following the anchor in grid order, at most window entries, in ascending order.
    - `rapidId` 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
    - `state` 'Labeling' | 'Paused' | 'Incomplete' | 'Flagged' | 'Done' | 'None' | 'Rejected', required
  - `index` integer, required — The 1-based position of the anchor within the filtered slice.
  - `total` integer, required — The total number of rapids in the filtered slice.

## 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/e42ec51c7b88/schema)