POST
/
admin
/
search
Admin Search
curl --request POST \
  --url https://cloud.onyx.app/api/admin/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "filters": {
    "source_type": [
      "ingestion_api"
    ],
    "document_set": [
      "<string>"
    ],
    "time_cutoff": "2023-11-07T05:31:56Z",
    "tags": [
      {
        "tag_key": "<string>",
        "tag_value": "<string>"
      }
    ],
    "kg_entities": [
      "<string>"
    ],
    "kg_relationships": [
      "<string>"
    ],
    "kg_terms": [
      "<string>"
    ],
    "kg_sources": [
      "<string>"
    ],
    "kg_chunk_id_zero_only": true
  }
}'
{
  "documents": [
    {
      "document_id": "<string>",
      "chunk_ind": 123,
      "semantic_identifier": "<string>",
      "link": "<string>",
      "blurb": "<string>",
      "source_type": "ingestion_api",
      "boost": 123,
      "hidden": true,
      "metadata": {},
      "score": 123,
      "is_relevant": true,
      "relevance_explanation": "<string>",
      "match_highlights": [
        "<string>"
      ],
      "updated_at": "2023-11-07T05:31:56Z",
      "primary_owners": [
        "<string>"
      ],
      "secondary_owners": [
        "<string>"
      ],
      "is_internet": false
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

200
application/json

Successful Response

The response is of type object.