Edit your project's metadata

patch

https://api.readme.com/v2/projects/me

Edit your project's metadata.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

object

AI configuration for the project.

allow_crawlers

string

enum

Defaults to enabled

Allow indexing by robots.

Allowed:

api_designer

object

appearance

object

canonical_url

uri | null

custom_domain

object

Custom domain that serves this project.

custom_login

object

End-user login that forwards readers to your own auth provider.

default_version

object

description

string | null

glossary

array of objects

Defaults to []

Glossary terms defined in this project that can be used within your documentation.

glossary

health_check

object

How this project reports API availability.

homepage_url

string | null

i18n

object

Internationalization settings for the project.

integrations

object

Third-party integrations configured for the project.

mcp

object

Configuration for the project's Model Context Protocol (MCP) server.

name

string

The name of the project.

onboarding_completed

object

Which setup checklist steps this project has finished.

pages

object

Default page behavior for the project.

parent

string | null

owner

object

Information about the project owner.

plan

object

The project's plan and trial state.

metrics

object

Developer Dashboard limits and page-quality settings.

privacy

object

Who can view the hub, and how branches and OpenAPI definitions are shared.

redirects

array of objects

A collection of page redirects that ReadMe will permanently redirect users to when attempting to render a 404. Check out our redirect docs for more information on how they are handled.

redirects

reference

object

Contains options to configure interactive sections on your API Reference pages.

seo

object

Search engine settings

sitemap

string

enum

Defaults to disabled

Expose a sitemap.xml directory on your project.

Allowed:

llms_txt

string

enum

Defaults to enabled

Expose an llms.txt file to help AI assistants understand your documentation structure. On an enterprise group parent this also controls the group-level llms.txt. A group child inherits the group parent value only while it has none of its own; a value set on the child takes precedence over the group.

Allowed:

llms_txt_options

object

Options that tune how llms.txt is generated. Has no effect unless llms_txt is enabled.

ssl

object

TLS settings for the auto-provisioned certificate.

hsts

object

HTTP Strict Transport Security header settings.

subdomain

string

length ≤ 30

[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*

The subdomain of your project.

suggested_edits

string

enum

Defaults to enabled

Allow users to suggest edits to your documentation.

Allowed:

variable_defaults

array of objects

Defaults to []

Default values for variables used in the API Reference and documentation.

variable_defaults

webhooks

array of objects

Defaults to []

Outbound webhooks this project sends.

webhooks

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK