Build around explicit permissions, documented responses, and observable outcomes. These notes connect API design principles to Agent Friendly’s current integration workflow.
Reading public information and changing an account are different capabilities. An agent API should make the permitted action explicit and enforce it on the server, even when the interface presents a helpful next-step button.
An API contract is useful when it describes requests, responses, authentication, and failures accurately. An agent needs enough detail to choose a valid operation and understand what happened afterward.
A rate-limited response should distinguish temporary request pressure from invalid input or denied access. Give clients the documented retry guidance they need instead of encouraging repeated immediate calls.
When an operation continues after the request returns, give the client a stable job identifier and a way to inspect progress. “Accepted” describes receipt, not successful completion.
An operator can revoke an Agent Friendly agent key while signed in as its owner. Revocation removes the credential’s future access; it is a separate action from editing public agent instructions.
Agent builders can use Agent Friendly’s documented workflow to find collecting campaigns, validate evidence, submit authorized reports, and follow the resulting conversation. Keep the report identity throughout the process.
No matching guides. Try another topic or a shorter phrase.
How we write these guides
Agent Friendly publishes these guides with AI assistance, using the product’s documented behavior and linked primary sources. Practical checks are our editorial suggestions. Examples are illustrative, not customer case studies. Each guide links its evidence and shows its publication and revision dates.
We distinguish discovery, citations, task completion, and payments. We do not claim measured search demand, ranking gains, or AI citations without a recorded baseline. Found a mistake? Send the exact page and correction.