Skip to content
Brooklyn Solutions Developers

Use These Docs With AI

Every page in the portal is also published as plain Markdown, so the assistant you work with reads the same reference you do.

On Any Page

Open Use with AI next to the page title on any resource or guide.

  • Copy as MarkdownPaste the page into any assistant or editor.
  • View as MarkdownSee exactly what an assistant receives.
  • Open in ClaudeStart a new chat with the page already included.
  • Open in ChatGPTThe same, for ChatGPT.

Download the Whole Reference

For a Claude project, your editor’s docs, or an agent you’re building. Regenerated every time the spec changes.

  • llms.txt 229 lines · 26 KB

    An index of every guide and resource, one line each, linking to its Markdown page. Small enough for any context window.

    Download
  • llms-full.txt 15 categories · 174 resources · 206 KB

    Every guide, resource and endpoint in one Markdown file. The one to add to a Claude project or your editor’s docs.

  • OpenAPI spec YAML or JSON

    The machine-readable spec, with internal endpoints removed. Use it with code generators and agent frameworks.

What’s in llms.txt

A title, a one-line summary, then a section per category with a link and a sentence for each resource.

llms.txt First 28 of 229 lines 
# Brooklyn API

> Brooklyn is a platform for managing third-party relationships: contracts, vendors, services, risks, reviews, surveys and the workflows around them.

The complete reference in one file: https://brooklyn-flex.myshopify.com/pages/developers?view=llms-full

## Guides

- [Overview](https://brooklyn-flex.myshopify.com/pages/developer-guides/overview?view=markdown): Brooklyn is a platform for managing third-party relationships: contracts, vendors, services, risks, reviews, surveys and the workflows around them.
- [Authentication](https://brooklyn-flex.myshopify.com/pages/developer-guides/authentication?view=markdown): The Brooklyn API does not use static API keys.

## Contracts, vendors & services

- [Category plans](https://brooklyn-flex.myshopify.com/pages/api/category-plans?view=markdown): Category management: planning spend and strategy for a purchasing category, including one-page reports.
- [Vendors](https://brooklyn-flex.myshopify.com/pages/api/vendors?view=markdown): Vendors (suppliers) you work with, and how they are categorised.
- [Contracts](https://brooklyn-flex.myshopify.com/pages/api/contracts?view=markdown): The contract register: every agreement, its dates, value, parties and linked records.
- [Vendor tiers](https://brooklyn-flex.myshopify.com/pages/api/vendor-tiers?view=markdown): Tiers that rank vendors by importance (e.g. Strategic, Tactical).
- [Vendor file links](https://brooklyn-flex.myshopify.com/pages/api/vendor-file-links?view=markdown): Links between vendors and their documents.
- [Accounts](https://brooklyn-flex.myshopify.com/pages/api/accounts?view=markdown): The customer organisation (tenant) using Brooklyn, and its top-level settings.
- [Third-party issues](https://brooklyn-flex.myshopify.com/pages/api/third-party-issues?view=markdown): Issues raised against third parties (vendors), with a summary report.
- [Services](https://brooklyn-flex.myshopify.com/pages/api/services?view=markdown): Services a vendor delivers under a contract.
- [Service file links](https://brooklyn-flex.myshopify.com/pages/api/service-file-links?view=markdown): Links between services and their documents.
- [Relationship types](https://brooklyn-flex.myshopify.com/pages/api/relationship-types?view=markdown): The kinds of links allowed between records (parent, sub-contract, etc.).
- [Records](https://brooklyn-flex.myshopify.com/pages/api/records?view=markdown): Quick look-up of basic information about any record.
- [Relationships](https://brooklyn-flex.myshopify.com/pages/api/relationships?view=markdown): Links between records (e.g. this contract is a child of that master agreement).
- [Contracts — list screen](https://brooklyn-flex.myshopify.com/pages/api/contracts-list-screen?view=markdown): The contract list screen (newer version): filtering, sorting and exporting the contract grid.
- [Vendors — list screen](https://brooklyn-flex.myshopify.com/pages/api/vendors-list-screen?view=markdown): The vendor list screen (newer version).
- [Services — list screen](https://brooklyn-flex.myshopify.com/pages/api/services-list-screen?view=markdown): The services list screen (newer version).