> ## Documentation Index
> Fetch the complete documentation index at: https://docs.holydocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Endpoint

Compact operation header for method, path, auth requirements, rate limits, idempotency, SDK availability, and lifecycle metadata.

**Interactive playground** For isolated previews, theme switching, and sandbox editing, open [the Endpoint playground on holydocs.com](https://holydocs.com/components/endpoint).

## When to use

Use this component when endpoint documentation needs explicit request, response, schema, or lifecycle metadata.

## Live Examples

Every example below renders the real component directly inside HolyDocs, followed by the exact MDX you can paste into a page.

### Create Project

Endpoint header with lifecycle metadata.

**Create a project**

Creates a new project workspace and returns the project record with its generated identifier.

~~~mdx
<Endpoint
  title="Create a project"
  method="POST"
  path="/v1/projects"
  auth="Bearer token"
  rateLimit="60 requests / minute"
  idempotency="Idempotency-Key header supported"
  sdk="TypeScript | Python | Go"
  since="2025-01-14"
>
Creates a new project workspace and returns the project record with its generated identifier.
</Endpoint>
~~~

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `method` | `string` | `GET` | HTTP method label. |
| `path` | `string` | `/` | Endpoint path. |
| `auth` | `string` | `--` | Authentication requirement summary. |
| `rateLimit` | `string` | `--` | Rate limit guidance shown as a chip. |
| `sdk` | `string` | `--` | Comma or pipe separated SDK list. |

## Usage

Start from this baseline shape and then tailor the copy, data, or nesting to the page you are writing.

~~~mdx
<Endpoint
  title="Create a project"
  method="POST"
  path="/v1/projects"
  auth="Bearer token"
  rateLimit="60 requests / minute"
  idempotency="Idempotency-Key header supported"
  sdk="TypeScript | Python | Go"
  since="2025-01-14"
>
Creates a new project workspace and returns the project record with its generated identifier.
</Endpoint>
~~~

## Tips

- Keep naming and ordering consistent across fields, examples, and lifecycle notes so readers do not have to re-parse the endpoint surface on every page.
- Document the happy path and the sharp edges together. Request shape alone is not enough without auth, errors, and retry guidance.
- If a component renders into the right panel, verify the page on desktop width so you can confirm the supporting example is visible where readers expect it.

## Related Components

**[ParamField](/components/param-field)**

Documents a request parameter — path, query, or body — with type, requirement status, and description.
**[ResponseField](/components/response-field)**

Documents a field in an API response body with its name, type, and description.
**[Expandable](/components/expandable)**

Collapsible section for nested API fields, keeping complex response shapes readable.

## More

- Interactive playground: [Endpoint on holydocs.com](https://holydocs.com/components/endpoint)
- Component library index: [/components](/components)