Job

Gets the anchor rapid plus its neighbours within the job's filtered results.

Changed on

The job scopes the results server-side; returns 404 when the job has no labelling task.

get/job/{jobId}/results/{rapidId}/navigation

Request

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

Path parameters

jobIdstring required

The id of the job.

rapidIdstring required

The anchor rapid id.

Query parameters

statesRapidState[]

Optional rapid states to filter the slice by.

windowinteger

The number of neighbours to return on each side.

includeNotAcceptedboolean

Whether to include not-yet-accepted rapids.

includeOverflowboolean

Whether to include overflow rapids.

sortstring[]

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

Response

OK

indexinteger required

The 1-based position of the anchor within the filtered slice.

totalinteger required

The total number of rapids in the filtered slice.

Changes

  • c72c9f1c8ef5Revision changes
    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      added to the /////// response property oneOf list for the response status

    • breaking

      added to the /////// response property oneOf list for the response status

  • bf98b6cb9b5aRevision changes
    • info

      added the new optional query request parameter sort