Skip to content

search

ChatGPT connector alias for shine_search, with the ChatGPT-expected output shape.

What it does

Thin alias over shine_search that returns results in the shape ChatGPT connectors expect: { results: [{ id, title, url }] }.

Use shine_search directly if you need the full response shape with chunks and scores. Use search if you’re writing a ChatGPT connector or any client that follows the ChatGPT Apps SDK contract.

Required scope

search:read

Input

Field Type Required Description
query string yes The search query

Output

{
  "results": [
    {
      "id": "de2e3b54-388b-47d1-a27a-445af0a7df02",
      "title": "soc2-controls.md",
      "url": "https://shineai.io/files/de2e3b54-388b-47d1-a27a-445af0a7df02"
    }
  ]
}

Companion

Use with fetch — ChatGPT’s convention is search returns ids, fetch returns full content by id.

Type to search…

↑↓ navigate↵ selectEsc close