{"components":{"schemas":{"AutomationSearchCriteriaSchema":{"properties":{"automation_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"doc_types":{"items":{"enum":["assets","collections","segments","saved_searches","saved_search_groups"],"type":"string"},"type":"array"},"execution_time":{"format":"date-time","type":"string"},"filter":{"$ref":"#/components/schemas/CriteriaFilter"}},"required":["automation_ids"],"type":"object"},"BaseQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":0,"nullable":true,"type":"integer"},"sort":{"description":"A comma separated list of fieldnames with order (asc/desc)","type":"string"}},"type":"object"},"BulkAddToFavoritesSchema":{"properties":{"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["object_ids"],"type":"object"},"BulkDeleteFromFavoritesSchema":{"properties":{"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["object_ids"],"type":"object"},"BulkSavedSearchActionSchema":{"properties":{"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["job_id","search_ids"],"type":"object"},"BulkSavedSearchFaceExtractionSchema":{"properties":{"include_assets":{"type":"boolean"},"include_collections":{"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["include_assets","include_collections","job_id","search_ids"],"type":"object"},"BulkSavedSearchFilesDeleteSchema":{"properties":{"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"storage_id":{"format":"uuid","type":"string"}},"required":["job_id","search_ids","storage_id"],"type":"object"},"BulkSavedSearchMetadataUpdateSchema":{"properties":{"include_assets":{"type":"boolean"},"include_collections":{"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["include_assets","include_collections","job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsACLUpdateSchema":{"properties":{"include_assets":{"type":"boolean"},"include_collections":{"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["include_assets","include_collections","job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsAnalyzeSchema":{"properties":{"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsDeleteSchema":{"properties":{"content_only":{"default":true,"type":"boolean","writeOnly":true},"include_assets":{"type":"boolean"},"include_collections":{"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["include_assets","include_collections","job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsMetadataFillingSchema":{"properties":{"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsSetApprovalSchema":{"properties":{"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsTranscodeSchema":{"properties":{"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsTranscribeSchema":{"properties":{"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsTransferSchema":{"properties":{"include_assets":{"type":"boolean"},"include_collections":{"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["include_assets","include_collections","job_id","search_ids"],"type":"object"},"BulkSavedSearchReindexSchema":{"properties":{"include_assets":{"type":"boolean"},"include_collections":{"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["job_id","search_ids"],"type":"object"},"ConnectionTestSchema":{"description":"Result of testing one configured backend against its remote provider.\n\n``supported`` is ``False`` when the plugin implements no connection check \u2014\nthe config may still be perfectly valid, there is just nothing to probe.","properties":{"message":{"default":"","type":"string"},"ok":{"type":"boolean"},"supported":{"type":"boolean"}},"required":["supported","ok"],"type":"object"},"CriteriaFilter":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/CriteriaFilter"},"type":"array"},"operator":{"type":"string"},"path":{"description":"Nested field path. Required for the `NESTED` operator.","type":"string"},"terms":{"items":{"$ref":"#/components/schemas/CriteriaTerm"},"type":"array"}},"required":["operator"],"type":"object"},"CriteriaFilterSchema":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/CriteriaFilterSchema"},"type":"array"},"operator":{"type":"string"},"path":{"description":"Nested field path. Required for the `NESTED` operator.","type":"string"},"terms":{"items":{"$ref":"#/components/schemas/CriteriaTerm"},"type":"array"}},"required":["operator"],"type":"object"},"CriteriaRangeFilter":{"properties":{"max":{"nullable":true,"type":"string"},"min":{"nullable":true,"type":"string"},"timezone":{"description":"Format: +02:00. Results returned in UTC by default","nullable":true,"type":"string"}},"type":"object"},"CriteriaRangeFilterSchema":{"properties":{"max":{"type":"string"},"min":{"type":"string"},"timezone":{"description":"Format: +02:00. Results returned in UTC by default","type":"string"}},"type":"object"},"CriteriaSortSchema":{"properties":{"name":{"type":"string"},"order":{"type":"string"}},"required":["name"],"type":"object"},"CriteriaTerm":{"properties":{"exists":{"type":"boolean"},"missing":{"type":"boolean"},"name":{"type":"string"},"range":{"$ref":"#/components/schemas/CriteriaRangeFilter"},"value":{"type":"string"},"value_in":{"items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"CriteriaTermSchema":{"properties":{"exists":{"type":"boolean"},"missing":{"type":"boolean"},"name":{"type":"string"},"range":{"$ref":"#/components/schemas/CriteriaRangeFilterSchema"},"value":{"type":"string"},"value_in":{"items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"DiscoveryEntitiesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/DiscoveryEntity"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"type":"object"},"DiscoveryEntity":{"properties":{"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"metadata":{"type":"object"},"object_id":{"format":"uuid","type":"string"},"object_type":{"enum":["COLLECTION","SAVED_SEARCH"],"type":"string"},"title":{"type":"string"},"user_id":{"type":"string"}},"required":["object_id","object_type","title","user_id"],"type":"object"},"DiscoveryEntitySchema":{"properties":{"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"metadata":{"type":"object"},"object_id":{"format":"uuid","type":"string"},"object_type":{"enum":["COLLECTION","SAVED_SEARCH"],"type":"string"},"title":{"type":"string"},"user_id":{"type":"string"}},"required":["object_id","object_type","title","user_id"],"type":"object"},"DiscoveryViewSettingsSchema":{"properties":{"entity_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"id":{"format":"uuid","readOnly":true,"type":"string"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"}},"required":["entity_ids"],"type":"object"},"ErrorResponse":{"description":"Common iconik error envelope.\n\n``errors`` is either a flat list of messages or a mapping of field name to\nits list of messages, matching the shapes returned across the v2 endpoints.","properties":{"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"}],"example":["Bad request: Invalid JSON"]}},"type":"object"},"Evidence":{"description":"One reason a hit is in the list, from one source.\n\nA hit carries a list of these. `field` is the backend's own name for where\nthis came from (`transcription_text.analyzed`); `location` is the same\nthing in the words a person reads (`transcript`). `text` carries the\nhighlight markers `[[mark]]` / `[[/mark]]` around the matched terms.\n\nAn empty list means nothing matched textually \u2014 the filters alone selected\nthe hit. `match.quality` says so as a value you can branch on.","properties":{"field":{"nullable":true,"type":"string"},"kind":{"default":"text","description":"`text` \u2014 an excerpt of a field the query matched, the only kind that can point at where in a document the match landed. `clause` \u2014 a named structured clause matched (\"exact file name\"); there is no excerpt, only the name of what matched, in `location`. `rationale` \u2014 a backend's own account of why it returned the hit (a retrieved passage, a clip transcription), tied to no field of ours and carrying no markers.","enum":["text","clause","rationale"],"type":"string"},"location":{"nullable":true,"type":"string"},"source":{"description":"Which backend gave this account, as its internal key.","nullable":true,"type":"string"},"source_label":{"description":"That backend's display name (\"iconik\", \"TwelveLabs\").","nullable":true,"type":"string"},"text":{"nullable":true,"type":"string"}},"type":"object"},"FacetFilter":{"properties":{"name":{"type":"string"},"value_in":{"items":{"type":"string"},"nullable":true,"type":"array"}},"required":["name"],"type":"object"},"FacetFilterSchema":{"properties":{"name":{"type":"string"},"value_in":{"items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"FilterDisposition":{"description":"Whether a filter may be loosened during zero-hit recovery.","enum":["mandatory","relaxable"],"type":"string"},"FilterModifier":{"enum":["include_any_of","include_all_of","exclude_any_of","exclude_all_of"],"type":"string"},"FilterRole":{"description":"What a reported filter did: excluded (``FILTER``) or only ranked (``SCORING``).\n\nNot :class:`Tier`, which is what the compiler was free to do.","enum":["filter","scoring"],"type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array"}},"type":"object"},"KeywordPredicate":{"description":"Exact keyword / metadata constraint.\n\nOps: ``eq`` (scalar), ``in`` (any of a list), ``all`` (every value of a\nlist), ``range``, ``exists`` (``value`` ignored) and ``any_of``: branches on\nthe same field, at least one matching (e.g. an OR of date windows; plain\nclauses AND together). ``negate`` inverts any op.","properties":{"kind":{"const":"keyword","default":"keyword","type":"string"},"negate":{"default":false,"type":"boolean"},"op":{"enum":["eq","in","all","range","exists","any_of"],"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"$ref":"#/components/schemas/RangeBound"},{"items":{"anyOf":[{"$ref":"#/components/schemas/RangeBound"},{"items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"type":"array"},{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"type":"array"}]}},"required":["op","value"],"type":"object"},"KindDescriptorSchema":{"description":"One installed plugin kind and the JSON schema of its options.\n\n``options_schema`` is the pydantic JSON schema of the plugin's options\nmodel \u2014 secret fields carry ``format: password`` / ``writeOnly: true``,\nwhich is exactly what an onboarding UI needs to render them.","properties":{"kind":{"type":"string"},"options_schema":{"additionalProperties":true,"type":"object"}},"required":["kind","options_schema"],"type":"object"},"KindsListSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/KindDescriptorSchema"},"type":"array"}},"required":["objects"],"type":"object"},"ListObjectsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"type":"object"},"MatchAssessment":{"description":"How a hit was reached \u2014 a mechanical fact, not a relevance score.","properties":{"basis":{"default":"retrieval","enum":["retrieval","reranker","judge"],"type":"string"},"quality":{"enum":["exact","related","approximate","filters_only"],"type":"string"},"round_index":{"default":0,"type":"integer"}},"required":["quality"],"type":"object"},"Modality":{"description":"The perceptual signal a field carries, orthogonal to :class:`RetrievalKind`.\n\n``None`` (no member) means structured metadata perceived in no media.","enum":["visual","spoken","audio","document"],"type":"string"},"MultiSelectFilterGroup":{"properties":{"items":{"items":{"type":"string"},"type":"array"},"modifier":{"$ref":"#/components/schemas/FilterModifier"}},"required":["modifier","items"],"type":"object"},"MultiSelectFilterGroupSchema":{"properties":{"items":{"items":{"type":"string"},"readOnly":true,"type":"array"},"modifier":{"enum":["include_any_of","include_all_of","exclude_any_of","exclude_all_of"],"readOnly":true,"type":"string"}},"type":"object"},"NaturalSearchDocument":{"description":"A natural-search hit: the regular search document plus its ranking story.\n\nIdentical to what ``/v2/search/`` returns for the same object \u2014 same\npost-processing, same signed URLs \u2014 so a client renders both result sets\nwith one code path.","properties":{"date_created":{"format":"date-time","nullable":true,"type":"string"},"date_modified":{"format":"date-time","nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"evidence":{"description":"Why this hit matched: every account, from every source that found it, each naming its own `source`. Empty when nothing matched textually and the filters alone selected the hit \u2014 see `match`.","items":{"$ref":"#/components/schemas/Evidence"},"type":"array"},"id":{"format":"uuid","nullable":true,"type":"string"},"match":{"allOf":[{"$ref":"#/components/schemas/MatchAssessment"}],"description":"How this hit was retrieved, not how relevant it is: `quality` is `exact` when the query as typed matched, `related` when the query asked for what a result shows and it was matched by stand-in words, `approximate` when only a recovery round matched (fuzzed terms, a broadened phrase), and `filters_only` when no text matched and the filters alone selected it. `basis` names the evidence behind that verdict \u2014 `retrieval` today.","nullable":true},"metadata":{"additionalProperties":true,"nullable":true,"type":"object"},"object_type":{"type":"string"},"score":{"default":0.0,"type":"number"},"segments":{"description":"Matched moments within this hit, best first. Empty for a hit with no sub-structure, and always empty when `nested_results` is false.","items":{"$ref":"#/components/schemas/NaturalSearchSegment"},"type":"array"},"title":{"type":"string"}},"required":["object_type","title"],"type":"object"},"NaturalSearchImage":{"properties":{"asset_id":{"format":"uuid","type":"string"},"similarity":{"default":"semantic","description":"How the reference image is matched: `visual` or `semantic`.","enum":["semantic","visual"],"type":"string"}},"required":["asset_id"],"type":"object"},"NaturalSearchMoment":{"description":"A matched moment standing as a result of its own.\n\nWhat `objects` holds when `result_unit` is `segment`: the search ranked\nmoments, so each result *is* a moment rather than an asset that contains\nsome. The asset it belongs to is named by `asset_id` and its document is in\nthe response's `assets` map \u2014 several moments commonly share one asset, so\nrepeating a whole document per moment would be most of the payload.","properties":{"asset_id":{"description":"The asset this moment is part of; its key in `assets`.","type":"string"},"end_s":{"nullable":true,"type":"number"},"evidence":{"description":"Why this moment matched: every account, from every source that found it. Empty when nothing matched textually \u2014 see `match`.","items":{"$ref":"#/components/schemas/Evidence"},"type":"array"},"id":{"type":"string"},"match":{"allOf":[{"$ref":"#/components/schemas/MatchAssessment"}],"description":"How this hit was retrieved, not how relevant it is: `quality` is `exact` when the query as typed matched, `related` when the query asked for what a result shows and it was matched by stand-in words, `approximate` when only a recovery round matched (fuzzed terms, a broadened phrase), and `filters_only` when no text matched and the filters alone selected it. `basis` names the evidence behind that verdict \u2014 `retrieval` today.","nullable":true},"score":{"default":0.0,"type":"number"},"start_s":{"nullable":true,"type":"number"},"thumbnail_s":{"nullable":true,"type":"number"}},"required":["id","asset_id"],"type":"object"},"NaturalSearchReplay":{"description":"The response `filters` block sent back as-is; only what a replay needs is read.","properties":{"applied":{"description":"The query to run. Each entry's `role` is honoured, so the block as received reproduces the same search; drop an entry to drop that filter.","items":{"$ref":"#/components/schemas/ResponseFilter-Input"},"type":"array"},"exact_text":{"default":true,"type":"boolean"},"meaning_led":{"default":false,"type":"boolean"},"order":{"enum":["relevance","recent"],"nullable":true,"type":"string"},"ranking_unit":{"enum":["asset","segment","collection","post"],"nullable":true,"type":"string"},"search_id":{"description":"The block's `search_id`, sent back as received: ties this request to the search it continues. Has no effect on the results.","nullable":true,"type":"string"},"version":{"description":"The block's `version`. One this server no longer replays is a 400.","type":"integer"}},"required":["version"],"type":"object"},"NaturalSearchRequest":{"properties":{"filters":{"description":"Filters to enforce on top of the query, in the same shape the response reports them under `filters.applied` \u2014 so a filter from a previous response can be edited and sent straight back. Each is applied as given and wins over whatever the query text would have implied for the same field; omitting one is how you drop it. A filter on an unknown or reserved field is not enforced and comes back under `filters.rejected`, never under `filters.applied`.\n\nEvery filter you send is enforced whatever its `role`, so echoing back all of `filters.applied` searches more narrowly than the original search: send only the filters you mean to pin. To reproduce a search, send its block as `replay` instead.","items":{"$ref":"#/components/schemas/ResponseFilter-Input"},"type":"array"},"image":{"allOf":[{"$ref":"#/components/schemas/NaturalSearchImage"}],"description":"Optional reference image for visual search. **Not supported yet**: a request carrying one is rejected with a 400 until a visual-similarity backend serves it.","nullable":true},"limit":{"default":20,"description":"**Deprecated** alias of `per_page`. When both are given, `per_page` wins.","minimum":1.0,"type":"integer"},"max_sub_items":{"default":20,"description":"Cap on how many finer-grain sub-items (e.g. localized segments) each nested result keeps, trimming the low-signal tail to the top-N most relevant. `null` keeps every matched sub-item. Only affects nested results; never changes which items surface or their ranking.","minimum":0.0,"nullable":true,"type":"integer"},"nested_results":{"default":true,"description":"Return items with sub-items instead of a flat list.","type":"boolean"},"page":{"default":1,"description":"1-based page to return. Above 1, requires `replay` (the `filters` of the response being continued), or the request is rejected with a 400. Ignored when `search_after` is given.","minimum":1.0,"type":"integer"},"per_page":{"description":"Number of results per page; replaces `limit`. Exact on a paginated answer (`pagination.supported` true); an unpaginated answer may return more ranked results than this.","minimum":1.0,"nullable":true,"type":"integer"},"query":{"description":"Free-text natural-language query.","nullable":true,"type":"string"},"replay":{"allOf":[{"$ref":"#/components/schemas/NaturalSearchReplay"}],"description":"A response's `filters` block (or an `interpretations[].filters` one), sent back as received, possibly with entries removed from `applied`. The search then runs that interpretation instead of reading the query again: no language-model call, one retrieval round, no zero-result recovery. Use it to page through an answer, run another reading, or re-run it with a filter dropped. An entry this server cannot honour is a 400. Cannot be combined with `filters`.","nullable":true},"result_unit":{"description":"Grain the result list should be expressed in (e.g. `asset`, `segment`). Omit to let the search decide. When coarser than the interesting grain (e.g. `asset` while ranking on the best `segment`s), each item carries its matched finer hits as sub-items and `limit` counts the coarser items.","enum":["asset","segment","collection","post"],"nullable":true,"type":"string"},"search_after":{"description":"Infinite-scroll pagination key, as on `/v2/search/`: the `_sort` of the last object of the previous response. Wins over `page`. Requires `replay` (the previous response's `filters`), or the request is rejected with a 400.","items":{},"nullable":true,"type":"array"}},"type":"object"},"NaturalSearchResponse":{"description":"Natural-language search results.\n\nSame envelope as ``/v2/search/`` \u2014 `objects` and the pagination fields \u2014 so\nboth endpoints feed one rendering path.\n\nWhen `pagination.supported` is true, `page` / `pages` / `total` mean what\nthey do on ``/v2/search/``; otherwise the answer is a single ranked set\n(`page` and `pages` are 1) and `pagination.reason` says why.\n\nThe navigation urls are always null: pagination is driven by re-posting the\nrequest body (see `pagination`).","properties":{"assets":{"additionalProperties":{"$ref":"#/components/schemas/SearchDocument"},"description":"The documents `objects` refer to but do not contain, keyed by asset id. Empty unless the results are moments. Plain documents: the ranking story (`score`, `evidence`, `match`) belongs to the moment that matched, not to the asset it happens to sit in.","type":"object"},"degraded":{"default":false,"description":"True when at least one search backend failed, timed out or answered partially. The results are still usable, just not the full picture.","type":"boolean"},"facets":{"additionalProperties":true,"description":"Always null here; natural search computes no aggregations.","nullable":true,"type":"object"},"filters":{"$ref":"#/components/schemas/ResponseFilters","description":"The whole query behind these results. Send it back as the request's `replay` (as received, or with entries removed from `applied`) to continue or re-run this search.\n\n`applied` built the query that produced these results; each entry either excluded results (`role: filter`) or only ranked them (`role: scoring`). The words and meaning searched are ordinary entries on the fields they ran against. `relaxed` holds restrictions an earlier attempt enforced and this answer does not; re-sending one will probably empty the search. `rejected` could not be honoured; re-sending one changes nothing.\n\nThese are not a partition: a field can be in `applied` as a scoring signal and in `relaxed` as an abandoned restriction (\"nothing matched X, here is what we widened to\").\n\n`exact_text` / `meaning_led` say how the answering query matched; a replay reads them back so a later page grades its hits the same."},"first_url":{"nullable":true,"type":"string"},"interpretations":{"description":"Every way the query was read, best first; more than one when the query is ambiguous (e.g. a name to filter on, or a word in the content). The search stops at the first reading that finds something; `answered` marks it.\n\nShow another entry's `why` as a \"did you mean ...?\" and, if picked, re-post with that entry's `filters` as `replay`. Each is shaped like this response's `filters`; the `answered` entry carries it unchanged.","items":{"$ref":"#/components/schemas/ResponseInterpretation"},"type":"array"},"language":{"default":"","description":"BCP-47 tag of the query's language, which the `interpretations` sentences are written in. Empty when unknown.","type":"string"},"last_url":{"nullable":true,"type":"string"},"match_quality":{"description":"The best `match.quality` among `objects` \u2014 what the search can claim about this answer as a whole. Null when there are no results. `related` means stand-in words matched a question about what a result shows. Below that, the query as typed matched nothing and these are recovered results: worth showing and labelling, not presenting as the answer.","enum":["exact","related","approximate","filters_only"],"nullable":true,"type":"string"},"next_url":{"nullable":true,"type":"string"},"objects":{"description":"The ranked results, at the requested `result_unit`. Documents for an asset/collection grain; moments (see `NaturalSearchMoment`) when `result_unit` is `segment`.","items":{"anyOf":[{"$ref":"#/components/schemas/NaturalSearchDocument"},{"$ref":"#/components/schemas/NaturalSearchMoment"}]},"type":"array"},"page":{"nullable":true,"type":"integer"},"pages":{"nullable":true,"type":"integer"},"pagination":{"$ref":"#/components/schemas/ResponsePagination","description":"Whether this answer can be walked page by page (`supported`, known from the first response), and where in it you are. To fetch the next page, re-post the same body with this response's `filters` as `replay`, and either `page + 1` or the last object's `_sort` as `search_after`."},"per_page":{"nullable":true,"type":"integer"},"prev_url":{"nullable":true,"type":"string"},"scroll_id":{"nullable":true,"type":"string"},"total":{"nullable":true,"type":"integer"}},"type":"object"},"NaturalSearchSegment":{"description":"One matched moment inside a natural-search hit.\n\nA hit ranked on its best moments carries them here, in descending relevance,\ncapped by the request's ``max_sub_items``. ``thumbnail_s`` is the frame that\nbest represents the moment (the midpoint when nothing better is known), so a\nUI has a poster without computing one.","properties":{"end_s":{"nullable":true,"type":"number"},"evidence":{"description":"Why this moment matched: every account, from every source that found it. Empty when nothing matched textually \u2014 see `match`.","items":{"$ref":"#/components/schemas/Evidence"},"type":"array"},"id":{"type":"string"},"match":{"allOf":[{"$ref":"#/components/schemas/MatchAssessment"}],"description":"How this hit was retrieved, not how relevant it is: `quality` is `exact` when the query as typed matched, `related` when the query asked for what a result shows and it was matched by stand-in words, `approximate` when only a recovery round matched (fuzzed terms, a broadened phrase), and `filters_only` when no text matched and the filters alone selected it. `basis` names the evidence behind that verdict \u2014 `retrieval` today.","nullable":true},"score":{"default":0.0,"type":"number"},"start_s":{"nullable":true,"type":"number"},"thumbnail_s":{"nullable":true,"type":"number"}},"required":["id"],"type":"object"},"NltfContext":{"properties":{"displayed_filters":{"allOf":[{"$ref":"#/components/schemas/NltfDisplayedFilters"}],"nullable":true}},"type":"object"},"NltfContextSchema":{"properties":{"displayed_filters":{"$ref":"#/components/schemas/NltfDisplayedFilters"}},"type":"object"},"NltfDisplayedFilters":{"properties":{"facets":{"additionalProperties":true,"nullable":true,"type":"object"},"filters":{"additionalProperties":true,"nullable":true,"type":"object"}},"type":"object"},"NltfDisplayedFiltersSchema":{"properties":{"facets":{"additionalProperties":{"items":{"oneOf":[{"type":"string"},{"type":"number"}]},"type":"array"},"type":"object"},"filters":{"additionalProperties":{"items":{"oneOf":[{"type":"string"},{"type":"number"}]},"type":"array"},"type":"object"}},"type":"object"},"NltfParseMetadata":{"properties":{"model":{"nullable":true,"type":"string"},"original_query":{"nullable":true,"type":"string"},"provider":{"nullable":true,"type":"string"},"source_trace_id":{"nullable":true,"type":"string"}},"type":"object"},"NltfParseMetadataSchema":{"properties":{"model":{"readOnly":true,"type":"string"},"original_query":{"readOnly":true,"type":"string"},"provider":{"readOnly":true,"type":"string"}},"type":"object"},"NltfParseRequest":{"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/NltfContext"}],"nullable":true},"query":{"maxLength":500,"minLength":1,"type":"string"}},"required":["query"],"type":"object"},"NltfParseRequestSchema":{"properties":{"context":{"$ref":"#/components/schemas/NltfContextSchema"},"query":{"maxLength":500,"minLength":1,"type":"string"}},"required":["query"],"type":"object"},"NltfParseResponse":{"properties":{"metadata":{"allOf":[{"$ref":"#/components/schemas/NltfParseMetadata"}],"nullable":true},"result":{"allOf":[{"$ref":"#/components/schemas/NltfParseResult"}],"nullable":true}},"type":"object"},"NltfParseResponseSchema":{"properties":{"metadata":{"allOf":[{"$ref":"#/components/schemas/NltfParseMetadataSchema"}],"readOnly":true},"result":{"allOf":[{"$ref":"#/components/schemas/NltfParseResult"}],"readOnly":true}},"type":"object"},"NltfParseResult":{"properties":{"facets_filters":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"nullable":true,"type":"object"},"field_types":{"additionalProperties":{"type":"string"},"nullable":true,"type":"object"},"filter":{"additionalProperties":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"items":{"$ref":"#/components/schemas/MultiSelectFilterGroup"},"type":"array"},{"$ref":"#/components/schemas/CriteriaRangeFilter"}]},"nullable":true,"type":"object"},"filter_options":{"additionalProperties":{"items":{"anyOf":[{"type":"string"},{"type":"number"}]},"type":"array"},"nullable":true,"type":"object"},"query":{"nullable":true,"type":"string"},"query_mapping":{"additionalProperties":{"type":"string"},"nullable":true,"type":"object"}},"type":"object"},"NltfParseResultSchema":{"properties":{"facets_filters":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"readOnly":true,"type":"object"},"field_types":{"additionalProperties":{"type":"string"},"readOnly":true,"type":"object"},"filter":{"additionalProperties":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"items":{"$ref":"#/components/schemas/MultiSelectFilterGroupSchema"},"type":"array"},{"$ref":"#/components/schemas/CriteriaRangeFilterSchema"}]},"readOnly":true,"type":"object"},"filter_options":{"additionalProperties":{"items":{"oneOf":[{"type":"string"},{"type":"number"}]},"type":"array"},"readOnly":true,"type":"object"},"query":{"readOnly":true,"type":"string"},"query_mapping":{"additionalProperties":{"type":"string"},"readOnly":true,"type":"object"}},"type":"object"},"PaginationRefusal":{"description":"Why an answer cannot be paginated: the cursor is the internal engine's, so\nits single list must be the whole answer.\n\n``UNEXPRESSIBLE_QUERY``: the public filters cannot state the query (a soft\nOR over probes). ``SEGMENT_RESULT_UNIT``: the cursor walks assets, not moments.","enum":["multiple_rounds","external_backend","unexpressible_query","rerank_applied","segment_result_unit","no_results"],"type":"string"},"PingResponse":{"properties":{"service":{"default":"search-v2","type":"string"},"status":{"default":"ok","type":"string"},"version":{"default":"v2","type":"string"}},"type":"object"},"PublicLexicalPredicate-Input":{"description":"A lexical clause as the API states it: its outcome is :class:`FilterRole`, not ``tier``.","properties":{"any_of":{"items":{"type":"string"},"type":"array"},"fuzziness":{"nullable":true,"type":"string"},"kind":{"const":"lexical","default":"lexical","type":"string"},"operator":{"enum":["and","or"],"nullable":true,"type":"string"},"sub_field":{"nullable":true,"type":"string"},"terms":{"default":"","type":"string"},"tier":{"$ref":"#/components/schemas/Tier","default":"prefer"}},"type":"object"},"PublicLexicalPredicate-Output":{"description":"A lexical clause as the API states it: its outcome is :class:`FilterRole`, not ``tier``.","properties":{"any_of":{"items":{"type":"string"},"type":"array"},"fuzziness":{"nullable":true,"type":"string"},"kind":{"const":"lexical","default":"lexical","type":"string"},"operator":{"enum":["and","or"],"nullable":true,"type":"string"},"sub_field":{"nullable":true,"type":"string"},"terms":{"default":"","type":"string"}},"type":"object"},"PublicSemanticPredicate-Input":{"description":"A semantic clause as the API states it: without ``tier`` (always ``SCORING``).","properties":{"kind":{"const":"semantic","default":"semantic","type":"string"},"text":{"type":"string"},"tier":{"$ref":"#/components/schemas/Tier","default":"prefer"}},"required":["text"],"type":"object"},"PublicSemanticPredicate-Output":{"description":"A semantic clause as the API states it: without ``tier`` (always ``SCORING``).","properties":{"kind":{"const":"semantic","default":"semantic","type":"string"},"text":{"type":"string"}},"required":["text"],"type":"object"},"RangeBound":{"description":"Optional, AND-ed bounds of a ``range`` predicate (Elasticsearch names).\n\nRedundant bounds are accepted (``gte=1, gt=5`` is ``x > 5``): the producer is\noften an LLM. Read them with :meth:`bounds`, so no adapter skips one.","properties":{"gt":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"nullable":true},"gte":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"nullable":true},"lt":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"nullable":true},"lte":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"nullable":true}},"type":"object"},"RankingUnit":{"description":"The unit results are rolled up to and ranked on.","enum":["asset","segment","collection","post"],"type":"string"},"ReindexSavedSearchGroupSchema":{"properties":{"sync_to_another_dc":{"type":"boolean"}},"type":"object"},"ReindexSavedSearchSchema":{"properties":{"sync_to_another_dc":{"type":"boolean"}},"type":"object"},"ResponseFilter-Input":{"description":"One filter or retrieval clause as the answering round ran it, re-sendable as-is.\n\n``disposition`` is not serialized: ``applied`` vs ``relaxed`` says it.","properties":{"disposition":{"$ref":"#/components/schemas/FilterDisposition","default":"relaxable"},"facetable":{"default":false,"type":"boolean"},"field":{"type":"string"},"field_type":{"default":"","type":"string"},"label":{"nullable":true,"type":"string"},"predicate":{"discriminator":{"propertyName":"kind"},"oneOf":[{"$ref":"#/components/schemas/KeywordPredicate"},{"$ref":"#/components/schemas/PublicLexicalPredicate-Input"},{"$ref":"#/components/schemas/PublicSemanticPredicate-Input"}]},"pushed_down":{"default":false,"type":"boolean"},"reason":{"nullable":true,"type":"string"},"role":{"allOf":[{"$ref":"#/components/schemas/FilterRole"}],"nullable":true},"value_labels":{"additionalProperties":{"type":"string"},"type":"object"},"weight":{"default":1.0,"minimum":0.0,"type":"number"}},"required":["field","predicate"],"type":"object"},"ResponseFilter-Output":{"description":"One filter or retrieval clause as the answering round ran it, re-sendable as-is.\n\n``disposition`` is not serialized: ``applied`` vs ``relaxed`` says it.","properties":{"facetable":{"default":false,"type":"boolean"},"field":{"type":"string"},"field_type":{"default":"","type":"string"},"label":{"nullable":true,"type":"string"},"predicate":{"discriminator":{"propertyName":"kind"},"oneOf":[{"$ref":"#/components/schemas/KeywordPredicate"},{"$ref":"#/components/schemas/PublicLexicalPredicate-Output"},{"$ref":"#/components/schemas/PublicSemanticPredicate-Output"}]},"pushed_down":{"default":false,"type":"boolean"},"reason":{"nullable":true,"type":"string"},"role":{"allOf":[{"$ref":"#/components/schemas/FilterRole"}],"nullable":true},"value_labels":{"additionalProperties":{"type":"string"},"type":"object"},"weight":{"default":1.0,"minimum":0.0,"type":"number"}},"required":["field","predicate"],"type":"object"},"ResponseFilters":{"description":"The query behind these results, editable and sent back whole as ``replay``.\n\nThe lists may overlap (a demoted facet is ``applied`` as ``SCORING`` and\n``relaxed``):\n\n- ``applied`` built the answering query; ``role`` says whether each excluded;\n- ``relaxed`` were enforced by an earlier round and found too narrow;\n- ``rejected`` could not be honoured.\n\nA filter not honoured is never reported as applied. A multi-round answer\nreports its last round.","properties":{"applied":{"items":{"$ref":"#/components/schemas/ResponseFilter-Output"},"type":"array"},"exact_text":{"default":true,"type":"boolean"},"meaning_led":{"default":false,"type":"boolean"},"modalities":{"items":{"$ref":"#/components/schemas/Modality"},"type":"array"},"order":{"allOf":[{"$ref":"#/components/schemas/ResultOrder"}],"nullable":true},"query":{"nullable":true,"type":"string"},"ranking_unit":{"allOf":[{"$ref":"#/components/schemas/RankingUnit"}],"nullable":true},"rejected":{"items":{"$ref":"#/components/schemas/ResponseFilter-Output"},"type":"array"},"relaxed":{"items":{"$ref":"#/components/schemas/ResponseFilter-Output"},"type":"array"},"result_unit":{"allOf":[{"$ref":"#/components/schemas/RankingUnit"}],"nullable":true},"scoring":{"$ref":"#/components/schemas/ResponseScoring"},"search_id":{"nullable":true,"type":"string"},"sources":{"items":{"$ref":"#/components/schemas/ResponseSource"},"type":"array"},"version":{"default":1,"type":"integer"}},"type":"object"},"ResponseInterpretation":{"description":"One reading; those not ``answered`` are \"did you mean\" suggestions to replay.","properties":{"answered":{"default":false,"type":"boolean"},"confidence":{"default":1.0,"type":"number"},"filters":{"$ref":"#/components/schemas/ResponseFilters"},"why":{"default":"","type":"string"}},"type":"object"},"ResponsePagination":{"description":"Whether the answer can be paginated (else :attr:`reason`), and where we are.","properties":{"page":{"default":1,"type":"integer"},"pages":{"default":1,"type":"integer"},"per_page":{"default":20,"type":"integer"},"reason":{"allOf":[{"$ref":"#/components/schemas/PaginationRefusal"}],"nullable":true},"supported":{"default":false,"type":"boolean"},"total":{"nullable":true,"type":"integer"}},"type":"object"},"ResponseScoring":{"description":"How these results were ranked: the fusion / rerank methods that ran.","properties":{"methods":{"items":{"$ref":"#/components/schemas/ScoringMethod"},"type":"array"}},"type":"object"},"ResponseSource":{"description":"One backend queried for these results, and how it fared.","properties":{"display_name":{"type":"string"},"ref":{"type":"string"},"state":{"$ref":"#/components/schemas/SourceState"}},"required":["ref","display_name","state"],"type":"object"},"ResultOrder":{"description":"The order a query asks its backend for: by score, or newest first.\n\nApplied within one backend query only, not across backends.","enum":["relevance","recent"],"type":"string"},"SavedSearch":{"properties":{"criteria":{"$ref":"#/components/schemas/SearchCriteriaSaved"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"favoured":{"readOnly":true,"type":"boolean"},"group_id":{"format":"uuid","nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"permissions":{"items":{"type":"string"},"type":"array"}},"required":["criteria","name"],"type":"object"},"SavedSearchConvertCollectionSchema":{"properties":{"collection_id":{"format":"uuid","type":"string"}},"required":["collection_id"],"type":"object"},"SavedSearchCopyFromTemplateSchema":{"properties":{"from_domain":{"format":"uuid","type":"string"},"metadata_view_map":{"additionalProperties":{"format":"uuid","type":"string"},"type":"object"},"to_domain":{"format":"uuid","type":"string"}},"required":["from_domain","metadata_view_map","to_domain"],"type":"object"},"SavedSearchElasticSchema":{"properties":{"criteria":{"type":"string"},"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"favoured":{"readOnly":true,"type":"boolean"},"group_id":{"format":"uuid","nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"permissions":{"items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"SavedSearchGroupQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":0,"nullable":true,"type":"integer"},"sort":{"description":"A comma separated list of fieldnames with order (asc/desc)","type":"string"}},"type":"object"},"SavedSearchGroupSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"saved_searches_count":{"type":"integer"},"system_domain_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}},"required":["name"],"type":"object"},"SavedSearchGroupsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/SavedSearchGroupSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"type":"object"},"SavedSearchQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":0,"nullable":true,"type":"integer"},"scroll":{"type":"boolean"},"scroll_id":{"format":"uuid","type":"string"},"search_after":{"description":"This parameter is used for infinite scroll pagination instead of deprecatedscroll API. It accepts a list of sort keys that will be used for getting a next page and it can be obtained from `_sort` key of the last object of the previous response","items":{"nullable":true},"nullable":true,"type":"array"},"sort":{"description":"A comma separated list of fieldnames with order (asc/desc)","type":"string"},"types":{"default":["ASSET","SEQUENCE","NLE_PROJECT","PLACEHOLDER","CUSTOM","LINK","SUBCLIP"],"description":"Comma-separated list of asset types to include in results. Defaults to all except POST.","items":{"enum":["ASSET","SEQUENCE","NLE_PROJECT","PLACEHOLDER","CUSTOM","LINK","SUBCLIP","POST"],"type":"string"},"type":"array"}},"type":"object"},"SavedSearchResultsSchema":{"properties":{"facets":{"type":"object"},"first_url":{"readOnly":true,"type":"string"},"id":{"format":"uuid","type":"string"},"last_url":{"readOnly":true,"type":"string"},"name":{"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/SearchDocument"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"search_criteria_document":{"$ref":"#/components/schemas/SavedSearch"},"total":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"type":"object"},"SavedSearchSchema":{"properties":{"criteria":{"$ref":"#/components/schemas/SearchCriteriaSaved"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"favoured":{"readOnly":true,"type":"boolean"},"group_id":{"format":"uuid","nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"permissions":{"items":{"type":"string"},"type":"array"}},"required":["criteria","name"],"type":"object"},"SavedSearchesSchema":{"properties":{"facets":{"type":"object"},"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/SavedSearchElasticSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"type":"object"},"ScoringMethod":{"description":"One scoring method applied at one stage.","properties":{"method":{"type":"string"},"model":{"nullable":true,"type":"string"},"params":{"additionalProperties":{"type":"string"},"type":"object"},"stage":{"$ref":"#/components/schemas/ScoringStage"}},"required":["stage","method"],"type":"object"},"ScoringStage":{"description":"Which stage of the ranking pipeline a :class:`ScoringMethod` describes.","enum":["fusion","rerank"],"type":"string"},"SearchBackendCreateSchema":{"description":"POST body: onboard one backend plugin instance for the domain.","properties":{"enabled":{"default":true,"type":"boolean"},"kind":{"type":"string"},"name":{"default":"","type":"string"},"options":{"additionalProperties":true,"type":"object"}},"required":["kind"],"type":"object"},"SearchBackendReadSchema":{"properties":{"date_created":{"format":"date-time","nullable":true,"type":"string"},"date_modified":{"format":"date-time","nullable":true,"type":"string"},"enabled":{"default":true,"type":"boolean"},"id":{"format":"uuid","type":"string"},"kind":{"type":"string"},"name":{"default":"","type":"string"},"options":{"additionalProperties":true,"type":"object"}},"required":["id","kind"],"type":"object"},"SearchBackendUpdateSchema":{"description":"PUT/PATCH body. ``kind`` is immutable: it may be echoed back unchanged\n(clients often resend what they read) but never altered.","properties":{"enabled":{"nullable":true,"type":"boolean"},"kind":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"options":{"additionalProperties":true,"nullable":true,"type":"object"}},"type":"object"},"SearchBackendsListSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/SearchBackendReadSchema"},"type":"array"}},"required":["objects"],"type":"object"},"SearchContentInfoInternalSchema":{"properties":{"assets_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"collections_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"media_formats":{"items":{"readOnly":true,"type":"object"},"type":"array"},"media_types":{"items":{"readOnly":true,"type":"object"},"type":"array"},"storage_info":{"items":{"$ref":"#/components/schemas/StorageContentInfo"},"readOnly":true,"type":"array"},"title":{"readOnly":true,"type":"string"},"total_duration_milliseconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"total_size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"SearchContentInfoSchema":{"properties":{"assets_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"collections_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"storage_info":{"items":{"$ref":"#/components/schemas/StorageContentInfo"},"readOnly":true,"type":"array"},"title":{"readOnly":true,"type":"string"},"total_duration_milliseconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"total_size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"SearchConvertCollectionSchema":{"properties":{"collection_id":{"format":"uuid","type":"string"},"doc_types":{"items":{"enum":["assets","collections","segments","saved_searches","saved_search_groups"],"type":"string"},"type":"array"},"exclude_fields":{"items":{"type":"string"},"type":"array"},"facets":{"items":{"type":"string"},"type":"array"},"facets_filters":{"items":{"$ref":"#/components/schemas/FacetFilterSchema"},"type":"array"},"filter":{"$ref":"#/components/schemas/CriteriaFilterSchema"},"include_fields":{"items":{"type":"string"},"type":"array"},"metadata_view_id":{"format":"uuid","type":"string"},"query":{"type":"string"},"search_fields":{"items":{"type":"string"},"type":"array"},"sort":{"items":{"$ref":"#/components/schemas/CriteriaSortSchema"},"type":"array"}},"required":["collection_id"],"type":"object"},"SearchCriteria":{"properties":{"doc_types":{"items":{"type":"string"},"nullable":true,"type":"array"},"exclude_fields":{"items":{"type":"string"},"nullable":true,"type":"array"},"facets":{"items":{"type":"string"},"nullable":true,"type":"array"},"facets_filters":{"items":{"$ref":"#/components/schemas/FacetFilter"},"nullable":true,"type":"array"},"filter":{"allOf":[{"$ref":"#/components/schemas/SearchCriteriaFilter"}],"nullable":true},"include_fields":{"items":{"type":"string"},"nullable":true,"type":"array"},"metadata_view_id":{"nullable":true,"type":"string"},"query":{"nullable":true,"type":"string"},"search_after":{"description":"Infinite-scroll pagination key (replaces the deprecated scroll API). A list of sort keys taken from the `_sort` of the last object of the previous response.","items":{},"nullable":true,"type":"array"},"search_fields":{"items":{"type":"string"},"nullable":true,"type":"array"},"sort":{"items":{"$ref":"#/components/schemas/SortField"},"nullable":true,"type":"array"}},"type":"object"},"SearchCriteriaBaseSchema":{"properties":{"doc_types":{"items":{"enum":["assets","collections","segments","saved_searches","saved_search_groups"],"type":"string"},"type":"array"},"exclude_fields":{"items":{"type":"string"},"type":"array"},"facets":{"items":{"type":"string"},"type":"array"},"facets_filters":{"items":{"$ref":"#/components/schemas/FacetFilterSchema"},"type":"array"},"filter":{"$ref":"#/components/schemas/CriteriaFilterSchema"},"include_fields":{"items":{"type":"string"},"type":"array"},"metadata_view_id":{"format":"uuid","type":"string"},"query":{"type":"string"},"search_fields":{"items":{"type":"string"},"type":"array"},"sort":{"items":{"$ref":"#/components/schemas/CriteriaSortSchema"},"type":"array"}},"type":"object"},"SearchCriteriaFilter":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/SearchCriteriaFilter"},"nullable":true,"type":"array"},"operator":{"enum":["AND","OR","NOT","NESTED"],"type":"string"},"path":{"description":"Nested field path. Required for the `NESTED` operator.","nullable":true,"type":"string"},"terms":{"items":{"$ref":"#/components/schemas/SearchTerm"},"nullable":true,"type":"array"}},"required":["operator"],"type":"object"},"SearchCriteriaSaved":{"properties":{"doc_types":{"items":{"enum":["assets","collections","segments","saved_searches","saved_search_groups"],"type":"string"},"type":"array"},"exclude_fields":{"items":{"type":"string"},"type":"array"},"facets":{"items":{"type":"string"},"type":"array"},"facets_filters":{"items":{"$ref":"#/components/schemas/FacetFilterSchema"},"type":"array"},"filter":{"$ref":"#/components/schemas/CriteriaFilterSchema"},"include_fields":{"items":{"type":"string"},"type":"array"},"metadata_view_id":{"format":"uuid","type":"string"},"query":{"type":"string"},"search_fields":{"items":{"type":"string"},"type":"array"},"sort":{"items":{"$ref":"#/components/schemas/CriteriaSortSchema"},"type":"array"}},"type":"object"},"SearchCriteriaSavedSchema":{"properties":{"doc_types":{"items":{"enum":["assets","collections","segments","saved_searches","saved_search_groups"],"type":"string"},"type":"array"},"exclude_fields":{"items":{"type":"string"},"type":"array"},"facets":{"items":{"type":"string"},"type":"array"},"facets_filters":{"items":{"$ref":"#/components/schemas/FacetFilterSchema"},"type":"array"},"filter":{"$ref":"#/components/schemas/CriteriaFilterSchema"},"include_fields":{"items":{"type":"string"},"type":"array"},"metadata_view_id":{"format":"uuid","type":"string"},"query":{"type":"string"},"search_fields":{"items":{"type":"string"},"type":"array"},"sort":{"items":{"$ref":"#/components/schemas/CriteriaSortSchema"},"type":"array"}},"type":"object"},"SearchCriteriaSchema":{"properties":{"doc_types":{"items":{"enum":["assets","collections","segments","saved_searches","saved_search_groups"],"type":"string"},"type":"array"},"exclude_fields":{"items":{"type":"string"},"type":"array"},"facets":{"items":{"type":"string"},"type":"array"},"facets_filters":{"items":{"$ref":"#/components/schemas/FacetFilterSchema"},"type":"array"},"filter":{"$ref":"#/components/schemas/CriteriaFilterSchema"},"include_fields":{"items":{"type":"string"},"type":"array"},"metadata_view_id":{"format":"uuid","type":"string"},"query":{"type":"string"},"search_after":{"description":"This parameter is used for infinite scroll pagination instead of deprecatedscroll API. It accepts a list of sort keys that will be used for getting a next page and it can be obtained from `_sort` key of the last object of the previous response","items":{"nullable":true},"type":"array"},"search_fields":{"items":{"type":"string"},"type":"array"},"sort":{"items":{"$ref":"#/components/schemas/CriteriaSortSchema"},"type":"array"}},"type":"object"},"SearchDocument":{"description":"A single search hit (ported from v1 ``SearchDocumentSchema``).","properties":{"date_created":{"format":"date-time","nullable":true,"type":"string"},"date_modified":{"format":"date-time","nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"id":{"format":"uuid","nullable":true,"type":"string"},"metadata":{"additionalProperties":true,"nullable":true,"type":"object"},"object_type":{"type":"string"},"title":{"type":"string"}},"required":["object_type","title"],"type":"object"},"SearchDocumentInputSchema":{"properties":{"fields":{"items":{"type":"object"},"type":"array"}},"required":["fields"],"type":"object"},"SearchDocumentSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"metadata":{"type":"object"},"object_type":{"type":"string"},"title":{"type":"string"}},"required":["object_type","title"],"type":"object"},"SearchDocumentsResponse":{"description":"Search results envelope (ported from v1 ``SearchDocumentsSchema``).","properties":{"facets":{"additionalProperties":true,"nullable":true,"type":"object"},"first_url":{"nullable":true,"type":"string"},"last_url":{"nullable":true,"type":"string"},"next_url":{"nullable":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/SearchDocument"},"type":"array"},"page":{"nullable":true,"type":"integer"},"pages":{"nullable":true,"type":"integer"},"per_page":{"nullable":true,"type":"integer"},"prev_url":{"nullable":true,"type":"string"},"scroll_id":{"nullable":true,"type":"string"},"search_criteria_document":{"additionalProperties":true,"nullable":true,"type":"object"},"total":{"nullable":true,"type":"integer"}},"type":"object"},"SearchDocumentsSchema":{"properties":{"facets":{"type":"object"},"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/SearchDocumentSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"type":"object"},"SearchHistory":{"properties":{"criteria":{"type":"object"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","type":"string"}},"required":["criteria","id"],"type":"object"},"SearchHistoryListSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/SearchHistory"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"type":"object"},"SearchHistorySchema":{"properties":{"criteria":{"type":"object"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","type":"string"}},"required":["criteria","id"],"type":"object"},"SearchQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":0,"nullable":true,"type":"integer"},"scroll":{"type":"boolean"},"scroll_id":{"format":"uuid","type":"string"},"sort":{"description":"A comma separated list of fieldnames with order (asc/desc)","type":"string"},"types":{"default":["ASSET","SEQUENCE","NLE_PROJECT","PLACEHOLDER","CUSTOM","LINK","SUBCLIP"],"description":"Comma-separated list of asset types to include in results. Defaults to all except POST.","items":{"enum":["ASSET","SEQUENCE","NLE_PROJECT","PLACEHOLDER","CUSTOM","LINK","SUBCLIP","POST"],"type":"string"},"type":"array"}},"type":"object"},"SearchRangeFilter":{"properties":{"max":{"nullable":true,"type":"string"},"min":{"nullable":true,"type":"string"},"timezone":{"description":"Format: +02:00. Results returned in UTC by default","nullable":true,"type":"string"}},"type":"object"},"SearchSuggestRequest":{"properties":{"doc_types":{"items":{"type":"string"},"nullable":true,"type":"array"},"field_name":{"type":"string"},"metadata_view_id":{"nullable":true,"type":"string"},"query":{"type":"string"}},"required":["field_name","query"],"type":"object"},"SearchSuggestResponseItem":{"properties":{"value":{"nullable":true,"type":"string"}},"type":"object"},"SearchSuggestResponseSchema":{"properties":{"value":{"type":"string"}},"type":"object"},"SearchSuggestSchema":{"properties":{"doc_types":{"items":{"enum":["assets","collections","segments","saved_searches","saved_search_groups"],"type":"string"},"type":"array"},"field_name":{"type":"string"},"metadata_view_id":{"format":"uuid","type":"string"},"query":{"type":"string"}},"required":["field_name","query"],"type":"object"},"SearchSuggestsResponse":{"description":"Suggestions envelope (ported from v1 ``SearchSuggestsResponseSchema``).","properties":{"objects":{"items":{"$ref":"#/components/schemas/SearchSuggestResponseItem"},"type":"array"}},"type":"object"},"SearchSuggestsResponseSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/SearchSuggestResponseSchema"},"readOnly":true,"type":"array"}},"type":"object"},"SearchTerm":{"properties":{"exists":{"nullable":true,"type":"boolean"},"missing":{"nullable":true,"type":"boolean"},"name":{"type":"string"},"range":{"allOf":[{"$ref":"#/components/schemas/SearchRangeFilter"}],"nullable":true},"value":{"nullable":true,"type":"string"},"value_in":{"items":{"type":"string"},"nullable":true,"type":"array"}},"required":["name"],"type":"object"},"SearchViewFieldTypeSchema":{"properties":{"facetable":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"origin_field_name":{"type":"string"},"sortable":{"type":"boolean"},"type":{"type":"string"},"width":{"$ref":"#/components/schemas/SearchViewFieldTypeWidth"}},"type":"object"},"SearchViewFieldTypeWidth":{"properties":{"auto_resize":{"type":"boolean"},"current":{"type":"integer"},"fixed":{"type":"integer"},"max":{"type":"integer"},"min":{"type":"integer"}},"type":"object"},"SearchViewFieldTypeWidthSchema":{"properties":{"auto_resize":{"type":"boolean"},"current":{"type":"integer"},"fixed":{"type":"integer"},"max":{"type":"integer"},"min":{"type":"integer"}},"type":"object"},"SearchViewSchema":{"properties":{"auto_resize_title_column":{"type":"boolean"},"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"description":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"view_fields":{"items":{"$ref":"#/components/schemas/SearchViewFieldTypeSchema"},"type":"array"}},"type":"object"},"SearchViewsIDSchema":{"properties":{"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["object_ids"],"type":"object"},"SearchViewsSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/SearchViewSchema"},"readOnly":true,"type":"array"}},"type":"object"},"SortField":{"properties":{"name":{"type":"string"},"order":{"nullable":true,"type":"string"}},"required":["name"],"type":"object"},"SourceState":{"description":"Per-source execution outcome (a slow/down source must not fail us).","enum":["ok","partial","timeout","unavailable","error"],"type":"string"},"StorageContentInfo":{"properties":{"assets_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"file_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"storage_id":{"format":"uuid","readOnly":true,"type":"string"},"total_duration_milliseconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"total_size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"StorageContentInfoSchema":{"properties":{"assets_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"file_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"storage_id":{"format":"uuid","readOnly":true,"type":"string"},"total_duration_milliseconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"total_size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"Tier":{"description":"How hard a clause binds; relaxation demotes down this scale.\n\nDeclared strongest first (``_find_selection`` relies on the order).","enum":["require","try","prefer"],"type":"string"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array"},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"type":"object"}}},"info":{"title":"Iconik Search","version":"2.0.0"},"openapi":"3.0.3","paths":{"/":{},"/ip/":{},"/livez/":{},"/readyz/":{},"/spec/":{},"/static/{filename}":{},"/v1/discovery/default/":{"put":{"deprecated":true,"description":"\nRequired roles:\n - can_write_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryViewSettingsSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryViewSettingsSchema"}}},"description":"Returns updated default discovery view"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update default discovery view"}},"/v1/discovery/default/entities/":{"get":{"deprecated":true,"description":"\nRequired roles:\n - can_read_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitiesSchema"}}},"description":"Returns the configured discovery entities"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns the discovery entities that are used to build the discovery view."},"post":{"deprecated":true,"description":"<br/>This creates an entry for the discovery view to show collections and saved searches.<br/>Object Type should be one of COLLECTION, SAVED_SEARCH, ASSET, RECOMMENDATION or TRENDING<br/>Object ID is only needed in the case of COLLECTION, SAVED_SEARCH or ASSET<br/>metadata is for user defined extra data.<br/><br/>This creates an entry for the discovery view to show collections and saved searches.<br/>Object Type should be one of COLLECTION, SAVED_SEARCH, ASSET, RECOMMENDATION or TRENDING<br/>Object ID is only needed in the case of COLLECTION, SAVED_SEARCH or ASSET<br/>metadata is for user defined extra data.<br/>\nRequired roles:\n - can_write_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"Returns the created discovery entity"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Access denied to the object of the discovery entity"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Adds a new discovery entity."}},"/v1/discovery/default/entities/admin/":{"get":{"deprecated":true,"description":"\nRequired roles:\n - can_write_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitiesSchema"}}},"description":"Returns the configured discovery entities"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns the discovery entities that are used to build the discovery view."}},"/v1/discovery/default/entities/{entity_id}/":{"delete":{"deprecated":true,"description":"\nRequired roles:\n - can_delete_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"entity_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Access denied to the object of the discovery entity"},"404":{"description":"Discovery entity does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a discovery entity by id"},"get":{"deprecated":true,"description":"\nRequired roles:\n - can_read_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"entity_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"Returns Discovery entity"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Access denied to the object of the discovery entity"},"404":{"description":"Discovery entity does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns discovery entity"},"patch":{"deprecated":true,"description":"\nRequired roles:\n - can_write_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"entity_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"Returns updated entity"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Access denied to the object of the discovery entity"},"404":{"description":"Discovery entity does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a discovery entity by id"},"put":{"deprecated":true,"description":"\nRequired roles:\n - can_write_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"entity_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"Returns updated entity"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Access denied to the object of the discovery entity"},"404":{"description":"Discovery entity does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a discovery entity by id"}},"/v1/discovery/entities/{object_type}/{object_id}/":{"patch":{"deprecated":true,"description":"\nRequired roles:\n - can_write_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Returns updated entity"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Access denied to the object of the discovery entity"},"404":{"description":"Discovery entity does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a discovery entity by object's type and id"},"put":{"deprecated":true,"description":"\nRequired roles:\n - can_write_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Returns updated entity"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Access denied to the object of the discovery entity"},"404":{"description":"Discovery entity does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a discovery entity by object's type and id"}},"/v1/favorites/":{"delete":{"description":"\nRequired roles:\n - can_delete_favorites\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Set to true to reindex the saved searches immediately instead of in the background\n","in":"query","name":"index_immediately","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteFromFavoritesSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteFromFavoritesSchema"}}},"description":"Returns a list of saved search IDs that were removed from favorites"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission check failed"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Deletes multiple saved searches from a list of favorites"},"post":{"description":"\nRequired roles:\n - can_write_favorites\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Set to true to reindex the saved searches immediately instead of in the background\n","in":"query","name":"index_immediately","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkAddToFavoritesSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkAddToFavoritesSchema"}}},"description":"Returns a list of saved search IDs that were added to favorites"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission check failed"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Adds multiple saved searches to a list of favorites"}},"/v1/nltf_parse/":{"post":{"description":"\nRequired roles:\n - can_search\n- can_search_with_ai\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NltfParseRequestSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NltfParseResponseSchema"}}},"description":"Returns the parsed query result with metadata"},"400":{"description":"Bad request - missing or invalid query"},"403":{"description":"NLTF is not enabled for this domain"},"429":{"description":"AI service rate-limited \u2014 frontend should retry with backoff"},"500":{"description":"Internal server error during parsing"},"502":{"description":"Upstream error (LLM authentication failed or unparseable output)\n"},"503":{"description":"NLTF client not initialized or unhealthy"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Parse a natural language query into structured search filters"}},"/v1/search/":{"post":{"description":"\nRequired roles:\n - can_search\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of documents for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"},"style":"form"},{"deprecated":true,"description":"If true, use scroll pagination instead of the default pagination. Deprecated, use the search_after body parameter instead.\n","in":"query","name":"scroll","schema":{"type":"boolean"},"style":"form"},{"deprecated":true,"description":"In order to get next batch of results using scroll pagination the scroll_id is required","in":"query","name":"scroll_id","schema":{"type":"string"},"style":"form"},{"description":"Set to false if you don't need a URL, will speed things up","in":"query","name":"generate_signed_url","schema":{"default":true,"type":"boolean"},"style":"form"},{"description":"Set to true if you also want the file download URLs generated","in":"query","name":"generate_signed_download_url","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"Set to true if you want to generate signed proxy urls","in":"query","name":"generate_signed_proxy_url","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"Set to false if you don't want to save the search to the history","in":"query","name":"save_search_history","schema":{"default":true,"type":"boolean"},"style":"form"},{"description":"Comma-separated list of asset types to include in results. Defaults to all except POST.","in":"query","name":"types","schema":{"type":"string"},"style":"form"},{"description":"Set to true to include the users who created the objects in the results","in":"query","name":"include_users","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchCriteriaSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchDocumentsSchema"}}},"description":"Returns the result of search"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"422":{"description":"The search query was rejected by Elasticsearch"},"504":{"description":"Connection timed out"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Search"}},"/v1/search/content/info/":{"post":{"description":"<br/>The returned information includes count of assets and collections,<br/>total size of all assets (in bytes) and total duration of video and audio<br/>assets (in milliseconds).<br/>The returned information includes count of assets and collections,<br/>total size of all assets (in bytes) and total duration of video and audio<br/>assets (in milliseconds).\nRequired roles:\n - can_search\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Compute total size only for files with the specified format name (default - ORIGINAL)","in":"query","name":"format_name","schema":{"default":"ORIGINAL","type":"string"},"style":"form"},{"description":"Group results by storage_id / storage_method","in":"query","name":"by_storage_id","schema":{"default":true,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchCriteriaSavedSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchContentInfoSchema"}}},"description":"Returns aggregated information about the search results"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"422":{"description":"The search query was rejected by Elasticsearch"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get aggregated information about search results"}},"/v1/search/convert_to_collection/":{"post":{"description":"\nRequired roles:\n - can_search\n- can_create_collections\n- can_write_collections\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchConvertCollectionSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Schedules all the assets of the search to be added to a collection"},"400":{"description":"Bad request, or the search does not have any results, or it has more results than `CONVERT_SEARCH_TO_COLLECTION_MAX_HITS`\n"},"401":{"description":"Token is invalid"},"403":{"description":"Access denied"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Copies the results of a search to a collection"}},"/v1/search/history/":{"get":{"description":"\nRequired roles:\n - can_read_search_history\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchHistoryListSchema"}}},"description":"Returns list of last 25 searches"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns the current search history"}},"/v1/search/history/{search_history_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_search_history\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_history_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Search History does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a search from history by its id"},"get":{"description":"\nRequired roles:\n - can_read_search_history\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_history_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of documents for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"},"style":"form"},{"description":"Set to false if you don't need a URL, will speed things up","in":"query","name":"generate_signed_url","schema":{"default":true,"type":"boolean"},"style":"form"},{"description":"Set to true if you want to generate signed download urls","in":"query","name":"generate_signed_download_url","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"Set to true if you want to generate signed proxy urls","in":"query","name":"generate_signed_proxy_url","schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchDocumentsSchema"}}},"description":"Returns results of search history"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"422":{"description":"The search query was rejected by Elasticsearch"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns results of search history"}},"/v1/search/saved/":{"get":{"description":"\nRequired roles:\n - can_read_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"},"style":"form"},{"description":"If true passed then uses scroll pagination instead of default one","in":"query","name":"scroll","schema":{"type":"boolean"},"style":"form"},{"description":"In order to get next batch of results using scroll pagination the scroll_id is required","in":"query","name":"scroll_id","schema":{"type":"string"},"style":"form"},{"description":"A comma separated list of fieldnames with order. For example - name,asc;group_id,desc","in":"query","name":"sort","schema":{"type":"string"},"style":"form"},{"description":"Group ID","in":"query","name":"group_id","schema":{"type":"string"},"style":"form"},{"description":"Filter list of id:s (comma separated)","in":"query","name":"ids","schema":{"type":"string"},"style":"form"},{"description":"Search using query","in":"query","name":"query","schema":{"type":"string"},"style":"form"},{"description":"If true, only returns favorite saved searches","in":"query","name":"favorites","schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchesSchema"}}},"description":"Returns results of saved search"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns list of saved searches"},"post":{"description":"\nRequired roles:\n - can_write_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Set to true to index the saved search immediately instead of in the background\n","in":"query","name":"index_immediately","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchSchema"}}},"description":"Returns the created saved search"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Search, save and return result of this search"}},"/v1/search/saved/copy/":{},"/v1/search/saved/group/":{"post":{"description":"\nRequired roles:\n - can_write_saved_search_groups\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Set to true to index the saved search group immediately instead of in the background\n","in":"query","name":"index_immediately","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupSchema"}}},"description":"Returns the result of creation of search group instance"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create and return saved search group data"}},"/v1/search/saved/group/{group_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_saved_search_groups\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"group_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"401":{"description":"Token is invalid"},"403":{"description":"Permission to some searches is denied"},"404":{"description":"Saved search group does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a saved search group by its id"},"get":{"description":"\nRequired roles:\n - can_read_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"group_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupSchema"}}},"description":"Returns saved search group info"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search group does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns saved search group data"},"patch":{"description":"\nRequired roles:\n - can_write_saved_search_groups\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"group_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupSchema"}}},"description":"Returns the result of updating group"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search group does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update and return saved search group data"},"put":{"description":"\nRequired roles:\n - can_write_saved_search_groups\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"group_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupSchema"}}},"description":"Returns the result of updating group"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search group does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update and return saved search group data"}},"/v1/search/saved/group/{group_id}/search/{search_id}/":{"delete":{"description":"\nRequired roles:\n - can_write_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"group_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete saved search from search group"},"post":{"description":"\nRequired roles:\n - can_write_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"group_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Set to true to index the saved search immediately instead of in the background\n","in":"query","name":"index_immediately","schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Adds saved search to group"}},"/v1/search/saved/groups/":{"get":{"description":"\nRequired roles:\n - can_read_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"},"style":"form"},{"description":"A comma separated list of IDs. for example - 3c2db7d8-1f39-46e3-8c77-992101e5e616,683a2c63-63a0-42b0-aed8-5b62dedba840","in":"query","name":"ids","schema":{"type":"string"},"style":"form"},{"description":"A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc","in":"query","name":"sort","schema":{"type":"string"},"style":"form"},{"description":"Search using query","in":"query","name":"query","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupsSchema"}}},"description":"Returns a list of groups info"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Page number does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns paginated list of search groups"}},"/v1/search/saved/groups/{group_id}/reindex/":{"post":{"description":"\nRequired roles:\n - can_reindex_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"group_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReindexSavedSearchGroupSchema"}}},"description":"body","required":true},"responses":{"201":{"description":"Returns a job info"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Group does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Reindex a particular saved search group by id"}},"/v1/search/saved/{search_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a saved search by its id"},"get":{"description":"\nRequired roles:\n - can_read_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"},"style":"form"},{"description":"Set to false if you only want the search definition","in":"query","name":"include_results","schema":{"default":true,"type":"boolean"},"style":"form"},{"description":"Set to true if you want to generate signed download urls","in":"query","name":"generate_signed_download_url","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"Set to true if you want to generate signed proxy urls","in":"query","name":"generate_signed_proxy_url","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"If true passed then uses scroll pagination instead of default one","in":"query","name":"scroll","required":false,"schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"In order to get next batch of results using scroll pagination the scroll_id is required","in":"query","name":"scroll_id","required":false,"schema":{"default":null,"nullable":true,"type":"string"},"style":"form"},{"description":"A serialised list of values from _sort field of a last returned record (encoded). For example - [1729527028527, \"fd273ce8-8fc6-11ef-a762-cac08d6e9f12\"]","in":"query","name":"search_after","required":false,"schema":{"default":null,"nullable":true,"type":"object"},"style":"form"},{"description":"Comma-separated list of asset types to include in results. Defaults to all except POST.\n","in":"query","name":"types","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchResultsSchema"}}},"description":"Returns results of saved search"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"422":{"description":"The search query was rejected by Elasticsearch"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns results of saved search"},"patch":{"description":"\nRequired roles:\n - can_write_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchSchema"}}},"description":"Returns the updated saved search"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Search and save this search"},"put":{"description":"\nRequired roles:\n - can_write_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchSchema"}}},"description":"Returns the updated saved search"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Search and save this search"}},"/v1/search/saved/{search_id}/content/info/":{"get":{"description":"<br/>The returned information includes count of assets and collections,<br/>total size of all assets (in bytes) and total duration of video and audio<br/>assets (in milliseconds).<br/>The returned information includes count of assets and collections,<br/>total size of all assets (in bytes) and total duration of video and audio<br/>assets (in milliseconds).\nRequired roles:\n - can_read_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Compute total size only for files with the specified format name (default - ORIGINAL)","in":"query","name":"format_name","schema":{"default":"ORIGINAL","type":"string"},"style":"form"},{"description":"Group results by storage_id / storage_method","in":"query","name":"by_storage_id","schema":{"default":true,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchContentInfoSchema"}}},"description":"Returns aggregated information about the saved search results"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"422":{"description":"The search query was rejected by Elasticsearch"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get aggregated information about saved search results"}},"/v1/search/saved/{search_id}/convert_to_collection/":{"post":{"description":"\nRequired roles:\n - can_read_saved_searches\n- can_create_collections\n- can_write_collections\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchConvertCollectionSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Schedules all the objects of the saved search to be added to a collection"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Access denied"},"404":{"description":"Saved search / Collection does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Converts the saved search to a collection"}},"/v1/search/saved/{search_id}/reindex/":{"post":{"description":"\nRequired roles:\n - can_reindex_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReindexSavedSearchSchema"}}},"description":"body","required":true},"responses":{"201":{"description":"Returns a job"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Reindex a particular saved search by id"}},"/v1/search/suggest/":{"post":{"description":"\nRequired roles:\n - can_search\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSuggestSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSuggestsResponseSchema"}}},"description":"Returns search suggestions for a particular query."},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns search suggestions for a particular query."}},"/v1/views/":{"delete":{"description":"\nRequired roles:\n - can_delete_search_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchViewsIDSchema"}}},"description":"body","required":false},"responses":{"200":{"description":"Delete was successful"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"All Views missing or not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete Views for the system domain."},"get":{"description":"\nRequired roles:\n - can_read_search_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchViewsSchema"}}},"description":"Returns all Views"},"204":{"description":"No Views found"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all Views for the system domain."},"post":{"description":"\nRequired roles:\n - can_write_search_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchViewSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchViewSchema"}}},"description":"Returns a View"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Insert a View for the system domain."}},"/v1/views/{view_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_search_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The ID of the View to delete.","in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"View is missing or not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a View for the system domain."},"get":{"description":"\nRequired roles:\n - can_read_search_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The ID of the view to retrieve.","in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchViewSchema"}}},"description":"Returns a View"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"View is missing or not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get a View for the system domain."},"put":{"description":"\nRequired roles:\n - can_write_search_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The ID of the view to replace.","in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchViewSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchViewSchema"}}},"description":"Returns a View"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"View is missing or not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Replace a View for the system domain."}},"/v2/nltf_parse/":{"post":{"description":"Required roles:\n- can_search\n- can_search_with_ai","operationId":"nltf_parse_v2_nltf_parse__post","parameters":[{"in":"header","name":"App-ID","required":false,"schema":{"nullable":true,"type":"string"}},{"in":"header","name":"Auth-Token","required":false,"schema":{"nullable":true,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NltfParseRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NltfParseResponse"}}},"description":"Parsed natural-language query"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Upstream service error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Service unavailable"}},"summary":"NLTF Parse"}},"/v2/ping/":{"get":{"description":"Lightweight endpoint to verify gateway routing to search-v2.","operationId":"ping_v2_ping__get","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PingResponse"}}},"description":"Successful Response"}},"summary":"Routing health check"}},"/v2/search/":{"post":{"description":"Required roles:\n- can_search","operationId":"search_v2_search__post","parameters":[{"in":"query","name":"per_page","required":false,"schema":{"default":10,"minimum":0,"type":"integer"}},{"in":"query","name":"page","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},{"deprecated":true,"in":"query","name":"scroll","required":false,"schema":{"default":false,"deprecated":true,"type":"boolean"}},{"deprecated":true,"in":"query","name":"scroll_id","required":false,"schema":{"deprecated":true,"nullable":true,"type":"string"}},{"in":"query","name":"generate_signed_url","required":false,"schema":{"default":true,"type":"boolean"}},{"in":"query","name":"generate_signed_download_url","required":false,"schema":{"default":false,"type":"boolean"}},{"in":"query","name":"generate_signed_proxy_url","required":false,"schema":{"default":false,"type":"boolean"}},{"in":"query","name":"save_search_history","required":false,"schema":{"default":true,"type":"boolean"}},{"in":"query","name":"types","required":false,"schema":{"nullable":true,"type":"string"}},{"in":"query","name":"include_users","required":false,"schema":{"default":false,"type":"boolean"}},{"in":"header","name":"App-ID","required":false,"schema":{"nullable":true,"type":"string"}},{"in":"header","name":"Auth-Token","required":false,"schema":{"nullable":true,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchCriteria"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchDocumentsResponse"}}},"description":"Returns the result of search"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Token is invalid"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Gateway timeout"}},"summary":"Search"}},"/v2/search/natural/":{"post":{"description":"Required roles:\n- can_search\n- can_search_with_ai","operationId":"natural_search_v2_search_natural__post","parameters":[{"in":"query","name":"generate_signed_url","required":false,"schema":{"default":true,"type":"boolean"}},{"in":"query","name":"generate_signed_download_url","required":false,"schema":{"default":false,"type":"boolean"}},{"in":"query","name":"generate_signed_proxy_url","required":false,"schema":{"default":false,"type":"boolean"}},{"in":"query","name":"include_users","required":false,"schema":{"default":false,"type":"boolean"}},{"in":"header","name":"App-ID","required":false,"schema":{"nullable":true,"type":"string"}},{"in":"header","name":"Auth-Token","required":false,"schema":{"nullable":true,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NaturalSearchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NaturalSearchResponse"}}},"description":"Natural-search results and the filters that produced them"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Gateway timeout"}},"summary":"Natural language search"}},"/v2/search/suggest/":{"post":{"description":"Required roles:\n- can_search","operationId":"suggest_v2_search_suggest__post","parameters":[{"in":"header","name":"App-ID","required":false,"schema":{"nullable":true,"type":"string"}},{"in":"header","name":"Auth-Token","required":false,"schema":{"nullable":true,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSuggestRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSuggestsResponse"}}},"description":"Returns search suggestions for a particular query"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Token is invalid"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Search suggestions"}},"/v2/search_backends/":{"get":{"description":"Required roles:\n- can_read_search_backends","operationId":"list_search_backends_v2_search_backends__get","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchBackendsListSchema"}}},"description":"Configured search backends"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Service unavailable"}},"summary":"List the configured search backends of the domain"},"post":{"description":"Required roles:\n- can_write_search_backends","operationId":"create_search_backend_v2_search_backends__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchBackendCreateSchema"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchBackendReadSchema"}}},"description":"The created search backend"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Service unavailable"}},"summary":"Configure a new search backend for the domain"}},"/v2/search_backends/kinds/":{"get":{"description":"Required roles:\n- can_read_search_backends","operationId":"list_search_backend_kinds_v2_search_backends_kinds__get","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KindsListSchema"}}},"description":"Installed backend kinds"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"List the installed search backend kinds and their options schemas"}},"/v2/search_backends/{backend_id}/":{"delete":{"description":"Required roles:\n- can_delete_search_backends","operationId":"delete_search_backend_v2_search_backends__backend_id___delete","parameters":[{"in":"path","name":"backend_id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The search backend was deleted"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Service unavailable"}},"summary":"Delete a configured search backend"},"get":{"description":"Required roles:\n- can_read_search_backends","operationId":"get_search_backend_v2_search_backends__backend_id___get","parameters":[{"in":"path","name":"backend_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchBackendReadSchema"}}},"description":"The configured search backend"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Service unavailable"}},"summary":"Get one configured search backend"},"patch":{"description":"Required roles:\n- can_write_search_backends","operationId":"update_search_backend_v2_search_backends__backend_id___patch","parameters":[{"in":"path","name":"backend_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchBackendUpdateSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchBackendReadSchema"}}},"description":"The updated search backend"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Service unavailable"}},"summary":"Update a configured search backend"},"put":{"description":"Required roles:\n- can_write_search_backends","operationId":"update_search_backend_v2_search_backends__backend_id___put","parameters":[{"in":"path","name":"backend_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchBackendUpdateSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchBackendReadSchema"}}},"description":"The updated search backend"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Service unavailable"}},"summary":"Replace a configured search backend"}},"/v2/search_backends/{backend_id}/test/":{"post":{"description":"Required roles:\n- can_write_search_backends","operationId":"test_search_backend_v2_search_backends__backend_id__test__post","parameters":[{"in":"path","name":"backend_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionTestSchema"}}},"description":"The connection test outcome"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Token is invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Service unavailable"}},"summary":"Test a configured search backend against its remote provider"}}},"servers":[{"url":"/API/search/"}]}