---
title: endpoint de API
slug: docs/es/endpoint-de-api
docTags: 
createdAt: 2026-06-05T11:12:18.527Z
---

[Punto Final de API](docId\:EQ6sRUnsHkZNQMrJTE9Rk) los bloques renderizan documentación interactiva de API, incluyendo parámetros de solicitud, ejemplos de código y muestras de respuesta.

## Sintaxis

Usted puede agregar este componente usando sintaxis Markdown o MDX.

::::Tabs
:::Tab{title="Markdown"}
```markdown
:::::ApiMethodV2
(JSON configuration with name, method, url, request, examples, results)
:::::
```
:::

:::Tab{title="MDX"}
```javascript
<ApiMethodV2>
(JSON configuration with name, method, url, request, examples, results)
</ApiMethodV2>
```
:::
::::

La configuración JSON admite los siguientes grupos de parámetros:

- `pathParameters`&#x20;
- `queryParameters`&#x20;
- `parámetros de encabezado`&#x20;
- `bodyDataParameters`
- `formDataParameters`&#x20;

Usted también puede incluir ejemplos de solicitud y muestras de respuesta en múltiples lenguajes.

Cuando se usa dentro de un diseño de dos columnas, los bloques de puntos finales de API se renderizan en la columna derecha.

## Ejemplo MDX

El siguiente ejemplo crea un punto final para recuperar un usuario, incluyendo parámetros de solicitud, múltiples ejemplos de código y muestras de respuesta.

```javascript
<ApiMethodV2>
{
  "name": "Get User",
  "method": "GET",
  "url": "https://api.example.com/users/{id}",
  "description": "Retrieve a user by their unique ID.",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "js-example",
        "language": "javascript",
        "code": "const res = await fetch('https://api.example.com/users/usr_abc123', {\n  headers: { 'Authorization': 'Bearer sk_live_xxx' }\n})\nconst user = await res.json()",
        "customLabel": ""
      },
      {
        "id": "curl-example",
        "language": "bash",
        "code": "curl https://api.example.com/users/usr_abc123 \\\n  -H 'Authorization: Bearer sk_live_xxx'",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "js-example"
  },
  "results": {
    "languages": [
      {
        "id": "res-200",
        "language": "200",
        "code": "{\n  \"id\": \"usr_abc123\",\n  \"name\": \"Jane Doe\",\n  \"email\": \"jane@example.com\",\n  \"role\": \"admin\"\n}",
        "customLabel": ""
      },
      {
        "id": "res-404",
        "language": "404",
        "code": "{\n  \"error\": \"Not found\",\n  \"message\": \"User does not exist\"\n}",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "res-200"
  },
  "request": {
    "pathParameters": [
      {
        "name": "id",
        "kind": "required",
        "type": "string",
        "description": "User ID (e.g. usr_abc123)"
      }
    ],
    "queryParameters": [
      {
        "name": "include",
        "kind": "optional",
        "type": "string",
        "description": "Comma-separated relations to include"
      }
    ],
    "headerParameters": [
      {
        "name": "Authorization",
        "kind": "required",
        "type": "string",
        "description": "Bearer token"
      }
    ],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Path Parameter",
    "value": "pathParameters"
  },
  "hasTryItOut": false
}
</ApiMethodV2>
```