# Thoughtworks API

> JSON API to search and read the pages, hubs and documents Thoughtworks publishes at https://thoughtworks.relayto.com/. No API key, and nothing you call changes the site.

Base URL: https://thoughtworks.relayto.com/api/site/v1; sandbox with fixed sample data: https://thoughtworks.relayto.com/api/site/sandbox/v1. Served by RELAYTO, the platform this site is published on.

## Docs

- [Developer documentation](https://thoughtworks.relayto.com/developers.md): authentication (none), every endpoint with an example request, pagination, errors, rate limits and versioning
- [OpenAPI 3.1 description](https://thoughtworks.relayto.com/openapi.json): machine-readable description of every operation
- [API catalog](https://thoughtworks.relayto.com/.well-known/api-catalog): RFC 9727 linkset pointing at the API and its descriptions

## Endpoints

- [Get the site and its API links](https://thoughtworks.relayto.com/developers#get-site): `GET /api/site/v1` (`getSite`)
- [Search the site by keyword](https://thoughtworks.relayto.com/developers#search-site): `GET /api/site/v1/search` (`searchSite`)
- [List the pages of the site](https://thoughtworks.relayto.com/developers#list-pages): `GET /api/site/v1/pages` (`listPages`)
- [List the hubs of the site](https://thoughtworks.relayto.com/developers#list-hubs): `GET /api/site/v1/hubs` (`listHubs`)
- [Get a hub](https://thoughtworks.relayto.com/developers#get-hub): `GET /api/site/v1/hubs/{hubSlug}` (`getHub`)
- [List the items in a hub](https://thoughtworks.relayto.com/developers#list-hub-items): `GET /api/site/v1/hubs/{hubSlug}/items` (`listHubItems`)
- [List the documents of the site](https://thoughtworks.relayto.com/developers#list-contents): `GET /api/site/v1/contents` (`listContents`)
- [Get a document or page with its text](https://thoughtworks.relayto.com/developers#get-content): `GET /api/site/v1/contents/{contentSlug}` (`getContent`)
- [Start an export of several documents](https://thoughtworks.relayto.com/developers#create-export): `POST /api/site/v1/exports` (`createExport`)
- [Get an export job and its result](https://thoughtworks.relayto.com/developers#get-export): `GET /api/site/v1/exports/{exportId}` (`getExport`)
- [Ask in natural language](https://thoughtworks.relayto.com/developers#ask-in-natural-language-nlweb): `POST https://thoughtworks.relayto.com/ask` (NLWeb v0.55, same search)

## Optional

- [Site index for agents](https://thoughtworks.relayto.com/llms.txt): every page, hub and document of the site, linked to its Markdown version
