canonical: https://jentic.com/apis/swaggerhub.gmf-tech/api-filter

# Gmf Tech API Filter

Swagger da API responsável pela filtragem de editais. The API exposes 7 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically filtrar editais coletados considerando parâmetros de filtragem | scope-> filter:, retornar as configurações de filtragem do cliente (portais, estados e palavras-c. Covers 7 operations with oauth2 authentication.

## Scope

Does not handle payments, communications, or crm - use for data enrichment only.

## Capabilities

- Filtrar editais coletados considerando parâmetros de filtragem | scope-> filter:
- Retornar as configurações de filtragem do cliente (portais, estados e palavras-c
- Incluir/atualizar palavra-chave e termos includentes e excludentes para um clien
- Remover palavra-chave e termos includentes e excludentes para um cliente | scope
- Simular a filtragem de editais considerando parâmetros de filtragem e textos hip

## Use cases

### Data Enrichment Operations

Use the API Filter to perform data enrichment operations programmatically. The API provides 7 endpoints covering core functionality including filtrar editais coletados considerando parâmetros de filtragem | scope-> filter:, retornar as configurações de filtragem do cliente (portais, estados e palavras-c, filtrar editais coletados, de forma básica, considerando parâmetros de filtragem.

Example prompt: Call POST /filter to filtrar editais coletados considerando parâmetros de filtragem | scope-> filter:

### Automated Filtering configurations Management

Automate filtering configurations operations by combining multiple API Filter endpoints. Agents can retornar as configurações de filtragem do cliente (portais, estados e palavras-c and then filtrar editais coletados, de forma básica, considerando parâmetros de filtragem in a single workflow.

Example prompt: Call GET /filter to retornar as configurações de filtragem do cliente (portais, estados e palavras-c, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call API Filter endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle oauth2 tokens manually.

Example prompt: Search Jentic for 'filtrar editais coletados considerando parâmetros de filtragem | scope-> filter:', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /filter | Filtrar editais coletados considerando parâmetros de filtragem \| scope-> filter: |
| GET | /filter | Retornar as configurações de filtragem do cliente (portais, estados e palavras-c |
| POST | /filter/basic | Filtrar editais coletados, de forma básica, considerando parâmetros de filtragem |
| PUT | /filter/keyword | Incluir/atualizar palavra-chave e termos includentes e excludentes para um clien |
| DELETE | /filter/keyword | Remover palavra-chave e termos includentes e excludentes para um cliente \| scope |
| PUT | /filter/global | Incluir/atualizar informações globais de filtro para um cliente \| scope-> filte |
| POST | /filter/simulation | Simular a filtragem de editais considerando parâmetros de filtragem e textos hip |

## Key resources

- **Filtering configurations** — Endpoints relacionados à configuração de informações utilizadas na filtragem de editais
- **Filtering on-demand** — Endpoints que realizarão o filtro de editais e retornará os resultados em tempo real
- **Filtering simulation** — Endpoints relacionados à simulação de filtragem de editais

## Why Jentic

- **Setup:** Wiring the Bidbr API Filter service by hand means running its OAuth2 password flow against api-login.bidbr.com.br, mapping the right ACL scopes, and handling token refresh and retries yourself. Through Jentic you install once, import API Filter from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** The filter operations carry their target in the request body rather than the URL path, so scoping is operations-only: you limit the agent to the operations it needs, such as reading filters or running a simulation, and leave out writes like deleting a keyword or setting a global filter unless you add them.
- **Credential handling:** Your API Filter OAuth2 credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'filter collected notices by parameters' or 'run a filter simulation', and Jentic returns the matching API Filter operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Clearbit** — Alternative data enrichment API
- **Fullcontact** — Alternative data enrichment API
- **Hunter** — Complementary data enrichment API

## FAQ

### What authentication does the API Filter use?

The API Filter uses OAuth 2.0 for authorization. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I filtrar editais coletados considerando parâmetros de filtragem | scope-> filter: with the API Filter?

Yes. Use the POST /filter endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the API Filter?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I filtrar editais coletados considerando parâmetros de filtragem | scope-> filter: through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'filtrar editais coletados considerando parâmetros de filtragem | scope-> filter:'. Jentic returns the matching API Filter operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the API Filter have?

The API Filter exposes 7 endpoints covering filtering configurations, filtering on-demand, filtering simulation operations.

### Can I limit what my agent is allowed to do with the API Filter?

Yes. Because you run Jentic One yourself, your own rules decide which API Filter operations the agent may call and which stored credentials it may use. Since each filter operation carries its target in the request body rather than the URL path, scoping is per operation: you can grant read-only access such as GET /filter to fetch configurations or POST /filter/simulation to test filtering, while withholding writes like PUT /filter/keyword, DELETE /filter/keyword, or PUT /filter/global. The agent can only invoke the operations you have allowed, and its OAuth2 secrets stay encrypted in your own instance rather than in the agent context.