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

# Gmf Tech API Proposal

Swagger da API responsável pelo gerenciamento das propostas. The API exposes 27 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically retornar as propostas vinculadas ao cliente | scope-> proposal:read
, retornar os indicadores para dar uma visão geral das propostas disponíveis | sco. Covers 27 operations with oauth2 authentication.

## Scope

Does not handle payments, communications, or crm - use for social media only.

## Capabilities

- Retornar as propostas vinculadas ao cliente | scope-> proposal:read
- Atualizar informações de uma proposta específica | scope-> proposal:write
- Enviar proposta para cadastro | scope-> proposal:write
- Rejeita uma proposta específica e seus itens | scope-> proposal:write
- Monitor API Proposal operational status and events

## Use cases

### Social Media Operations

Use the API Proposal to perform social media operations programmatically. The API provides 27 endpoints covering core functionality including retornar as propostas vinculadas ao cliente | scope-> proposal:read
, retornar os indicadores para dar uma visão geral das propostas disponíveis | sco, retornar todas as propostas em um status específico | scope-> proposal:read
.

Example prompt: Call GET /proposals to retornar as propostas vinculadas ao cliente | scope-> proposal:read

### Automated Proposals overview Management

Automate proposals overview operations by combining multiple API Proposal endpoints. Agents can retornar os indicadores para dar uma visão geral das propostas disponíveis | sco and then retornar todas as propostas em um status específico | scope-> proposal:read
 in a single workflow.

Example prompt: Call GET /proposals/overview to retornar os indicadores para dar uma visão geral das propostas disponíveis | sco, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call API Proposal 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 'retornar as propostas vinculadas ao cliente | scope-> proposal:read
', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /proposals | Retornar as propostas vinculadas ao cliente \| scope-> proposal:read |
| GET | /proposals/overview | Retornar os indicadores para dar uma visão geral das propostas disponíveis \| sco |
| GET | /proposals/status | Retornar todas as propostas em um status específico \| scope-> proposal:read |
| GET | /proposal | Retornar informações de uma proposta específica \| scope-> proposal:read |
| PUT | /proposal | Atualizar informações de uma proposta específica \| scope-> proposal:write |
| PUT | /proposal/approve | Enviar proposta para cadastro \| scope-> proposal:write |
| PUT | /proposal/reject | Rejeita uma proposta específica e seus itens \| scope-> proposal:write |
| PUT | /proposal/reject/reverse | Estorna a rejeição de uma proposta específica e seus itens \| scope-> proposal:wr |

## Key resources

- **Proposals overview** — Visão geral das propostas
- **Proposal analysis** — Análise de proposta
- **Items analysis** — Análise dos itens da proposta
- **Documents attachment** — Gerenciamento de documentos anexados à proposta

## Why Jentic

- **Setup:** Wiring the Bidbr API Proposal 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 Proposal from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** The proposal 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 proposals or their overview, and leave out state changes like approving or rejecting a proposal unless you add them.
- **Credential handling:** Your API Proposal 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 'list proposals for a customer' or 'get a proposal overview', and Jentic returns the matching API Proposal operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Facebook** — Alternative social media API
- **Twitter** — Alternative social media API
- **Linkedin** — Complementary social media API

## FAQ

### What authentication does the API Proposal use?

The API Proposal 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 retornar as propostas vinculadas ao cliente | scope-> proposal:read
 with the API Proposal?

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

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

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 retornar as propostas vinculadas ao cliente | scope-> proposal:read
 through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'retornar as propostas vinculadas ao cliente | scope-> proposal:read
'. Jentic returns the matching API Proposal operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

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

The API Proposal exposes 27 endpoints covering proposals overview, proposal analysis, items analysis operations.

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

Yes. Because these proposal operations carry their target in the request body rather than the URL path, scoping is done at the operation level in your self-hosted Jentic One instance, where your own rules decide which operations and credentials the agent may use. You can allow the agent only the read operations it needs, such as GET /proposals or GET /proposals/overview, and leave out state changes like PUT /proposal/approve or PUT /proposal/reject unless you explicitly grant them. This keeps the agent within a read-only view of proposals while you control access to the write operations.
