TRILHA DE CONHECIMENTO · BETA
APIs and agents: connect systems with control
Connect catalogs, applications and processes: interpret contracts, handle failures and give agents tools with clear permissions. Practice lookups and quotes in an adaptable lab.
Abra o que quer entender. Marque o que já sabe. Aprofunde quando precisar.
- FundamentalNão marcado
What an integration must guaranteeDefine incoming information, the decision and the intended effect.
An integration lets systems exchange information or request operations through a contract. An API exposes operations; a client prepares requests and interprets responses. An agent adds a model decision about which tool to call. These three things can exist independently.
Consider a store: someone asks for two desk lamps; a catalog supplies price and availability; a function calculates a quote; a person decides whether to save a draft. Saying “eight units available” does not reserve stock. Saving a draft does not place an order either. Naming effects prevents promises the software has not fulfilled.
Before writing commands, specify:
- Input: product and quantity, without inventing missing information.
- Source: an authorized catalog with currency, price in minor units and a version.
- Output: two units × 7,900 minor units = 15,800 minor units, BRL 158.00.
- Effect: a lookup or an explicit draft creation; sending and payment are separate operations.
- Acceptable failure: explain what is missing or uncertain while preserving the intent for investigation.
A fixed rule is sufficient to multiply price by quantity. A model may interpret a request, but it must not invent prices or acquire purchasing authority merely by producing persuasive text. This guide develops the same case through real requests, failures and controls. If you replace the store catalog with a calendar, CRM or inventory system, reconsider fields and permissions; the distinction between information, decision and effect remains.
Confira se ficou claro
Use estas perguntas para conferir seu entendimento. Você decide quando marcar o assunto como entendido.
Conferência opcional, só enquanto este conteúdo estiver aberto.Como este conhecimento ajuda no objetivo
Define incoming information, the decision and the intended effect.
Materiais complementares
- ArquivoDesign the integration
Worked examples, criteria and questions for adapting an integration.
Abrir material
Referências
- RFC 9110: HTTP semanticsIETFTrecho consultado: Sections 9.2.1–9.2.2, methods, statuses and conditional requests; lab examples and policies are original.Consultada em
- OpenAPI 3.1.1: describing HTTP APIsOpenAPI InitiativeTrecho consultado: Introduction, Paths, Operation, Request Body, Responses, Schema and Security Scheme. Artifact version pinned, not claimed as latest.Consultada em
- FundamentalReservado
Separate APIs, workflows and agents
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Define fields, types and contract rules
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- ImportanteReservado
Map IDs, units, currencies and dates
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Read methods, URLs, headers and bodies
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Interpret errors before retrying
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Traverse pages without losing or duplicating records
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- ImportanteReservado
Recognize contract changes and stale data
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Authenticate without spreading credentials
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Check object access on every operation
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Treat external responses as data
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Handle timeouts with bounded retries
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Use one key for the same intent
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- ImportanteReservado
Handle duplicate and out-of-order events
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- ImportanteReservado
Record enough to diagnose failures
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Understand the tool-calling loop
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Validate arguments beyond the schema
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Bind approval to the exact effect
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- RelevanteReservado
Distinguish APIs, function calling and MCP
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- ImportanteReservado
Estimate operation cost, latency and limits
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Run the lookup and save a local draft
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Locate the failure at the right layer
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- ImportanteReservado
Adapt to a CRM, calendar or another catalog
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- ImportanteReservado
Evaluate correctness and failure behavior
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Quick reference: define the operation and access
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Quick reference: retry, reconcile or stop
Este conteúdo faz parte da compra. Consulte o acesso à trilha.
- FundamentalReservado
Quick reference: provide tools with boundaries
Este conteúdo faz parte da compra. Consulte o acesso à trilha.