---
title: "Get the README file for this artifact"
method: GET
path: "/channels/{channel_name}/artifacts/{artifact_family}/{artifact_name}/readme"
tags: ["channels"]
deprecated: true
---

# Get the README file for this artifact

`GET /channels/{channel_name}/artifacts/{artifact_family}/{artifact_name}/readme`

## Request

- Base URL: `https://api.anaconda.cloud/api`
- URL: `https://api.anaconda.cloud/api/channels/{channel_name}/artifacts/{artifact_family}/{artifact_name}/readme`
- Auth: none declared
- TypeScript: <https://skmtc.dev/anaconda/apis/anaconda-server-api/docs/channels/:channel_name/artifacts/:artifact_family/:artifact_name/readme/get.ts> (a function with typed inputs; its response is checked against the schema)

> **Deprecated.**

## Path parameters

- `channel_name` string, required
- `artifact_family` 'anaconda_project' | 'anaconda_env' | 'cve' | 'conda' | 'python' | 'cran' | 'notebook' | 'docker' | 'sbom', required
- `artifact_name` string, required

## Response `200`

successfully retrieved README for this artifact

- string

## Other responses

- `400`: Server cannot execute request due to something that is perceived to be a client error
- `401`: Unauthenticated, no token is provided or token is invalid
- `403`: Access is forbidden
- `500`: Internal server error

---

[API](https://skmtc.dev/anaconda/apis/anaconda-server-api.md) - [All operations](https://skmtc.dev/anaconda/apis/anaconda-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/anaconda/apis/anaconda-server-api/revisions/6aef0cb7a151?raw)