---
title: "The read me file for the web service"
method: GET
path: "/readme"
---

# The read me file for the web service

`GET /readme`

## Request

- Base URL: `https://researchdata.tuwien.at` (the document declares no server; this is the origin it was published from)
- URL: `https://researchdata.tuwien.at/readme`
- Auth: none declared
- TypeScript: <https://skmtc.dev/tuwien/apis/resilient-web-service-api/docs/readme/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the read me file (text or markdown).

## Response `200`

Successful README file download

## Other responses

- `400`: Bad request
- `404`: ReadMe File not found

---

[API](https://skmtc.dev/tuwien/apis/resilient-web-service-api.md) - [All operations](https://skmtc.dev/tuwien/apis/resilient-web-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tuwien/apis/resilient-web-service-api/revisions/95d2c4a31179?raw)