Apiary Connector for AI agents.

It connects your agent directly to your Apiary workspace, allowing it to read, update, and publish your blueprints. This means your documentation stays current without you having to manually edit files in a browser.

Yes, the Connector can trigger Dredd-style tests against your Apiary project. This lets your agent verify that your actual backend implementation matches the specifications defined in your blueprints.

Yes, when you use the Connector to publish a new blueprint, Apiary automatically syncs your mock servers and public documentation URLs to match the new specification.

The Connector allows your agent to list all APIs for a specific team, list team members, and retrieve team details. It's a way to manage your engineering ecosystem through natural conversation.

This Connector is specifically for users of the Apiary platform who use their Markdown-based blueprints or Swagger files. It won't work with other documentation platforms.

You just need to subscribe to the Connector and provide your Personal Apiary Token. From there, your agent can start querying your projects and performing actions.

Yes. You can use the get_doc_url capability to retrieve both the public facing documentation url and the private mock server endpoint string. Your agent can immediately use this url to simulate requests internally using other modules or tests.

Absolutely. Instruct your AI agent to fetch the blueprint with get_api. Once read into context, prompt the agent to make your desired changes (e.g. 'Add a new POST route for user creation'). Then, instruct it to use publish_blueprint to upload the newly revised markdown.

Apiary enables collaboration. Utilizing list_teams, the agent finds the slugs of your organizations. Then, using list_team_apis, it fetches all collaborative APIs available for that precise team. This hierarchy avoids hallucinating random endpoint repositories.