---
title: "Search Content"
method: GET
path: "/search/content"
tags: ["search"]
---

# Search Content

`GET /search/content`

## Request

- Base URL: `https://api.os3robotics.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.os3robotics.com/search/content`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Search inside your content: the request messages and answers of your traces, the rows of
your datasets' latest versions and your robot episodes' tasks and outcomes. A hit holds
every word of `q`, the last one also as the start of a word, in any case. The best matches
come first: the words as a phrase, then every word apart, then those found only through the
last word's start; newest first within each. Each hit has a short passage around the words
found; a full page sets X-Next-Cursor, the `cursor` of the next page.

## Query parameters

- `q` string, required
- `kinds` string[], nullable
- `workspace_id` string, uuid, nullable
- `limit` integer
- `cursor` string, nullable

## Response `200`

Successful Response

- ContentHit[]
  - `type` 'trace' | 'dataset_row' | 'episode', required
  - `id` string, required
  - `name` string, required
  - `detail` string, nullable, required
  - `status` string, nullable, required
  - `workspace_id` string, uuid, required
  - `at` string, date-time, required
  - `ref` string, required
  - `version` integer, nullable, required
  - `item` integer, nullable, required
  - `match` 'content'
  - `snippet` Segment[], required
    - `text` string, required
    - `match` boolean, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/os3robotics/apis/os3-api.md) - [All operations](https://skmtc.dev/os3robotics/apis/os3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/os3robotics/apis/os3-api/revisions/af32cd4f14bb?raw)