---
title: "Filter Candidates"
method: POST
path: "/api/retrievals/filter"
tags: ["retrievals"]
---

# Filter Candidates

`POST /api/retrievals/filter`

## Request

- Base URL: `https://www.gateco.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://www.gateco.ai/api/retrievals/filter`
- Auth: OAuth 2 (password, token URL `/api/auth/login`)

## Request body

- FilterRequest: Request body for POST /api/retrievals/filter.
  - `principal_id` string, required
  - `connector_id` string, required
  - `candidates` FilterCandidate[], required
    - `vector_id` string, required
    - `score` number, nullable
    - `text` string, nullable
    - `resource_id` string, nullable
    - `metadata` CandidatePolicyMetadata: Typed inline metadata for policy evaluation. Only used when no registered resource_id is provided.
      - `classification` string, nullable
      - `sensitivity` string, nullable
      - `domain` string, nullable
      - `labels` string[], nullable
      - `encryption_mode` string, nullable
  - `include_trace` boolean

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/gateco/apis/gateco-api.md) · [All operations](https://skmtc.dev/gateco/apis/gateco-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gateco/apis/gateco-api/revisions/5debaf204950?raw)