> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firma.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Actualizar Plantilla Parcialmente
> Actualiza las propiedades de la plantilla, un solo usuario, O un solo campo. No se pueden mezclar múltiples tipos de entidad en una sola solicitud. Usa PUT para actualizaciones integrales que incluyan usuarios, campos y recordatorios. Un `seal_participant` que nombra un sello responde 404 `NOT_FOUND` cuando el sello no existe o pertenece a otra empresa, y 400 `SEAL_UNAVAILABLE` cuando el sello está revocado, borrado o no es la versión actual de su linaje. Añadir un participante de sello o cambiar su sello responde 503 `SEALS_DISABLED` cuando los sellos de organización no están habilitados. Añadir un participante de sello requiere `order` (consulta el contrato de orden).
## OpenAPI
````yaml api-reference/v01.39.01/openapi-v01.39.01.es.json patch /templates/{id}
openapi: 3.0.3
info:
title: API de Socios de Firma
description: >-
API RESTful para firma de documentos y gestión de plantillas.
**Autenticación**: Todos los endpoints requieren autenticación mediante
clave API a través del encabezado `Authorization`. Usa tu clave API
directamente sin ningún prefijo (por ejemplo, `your-api-key`). El prefijo
Bearer es opcional pero no obligatorio.
**Características de Seguridad**:
- Validación de entrada usando esquemas Zod con mensajes de error detallados
a nivel de campo
- Tokens JWT firmados con RSA-256 para el acceso al Editor de Plantillas
incrustado
**Límite de Solicitudes**: Los límites de solicitudes están escalonados
según el tipo de operación:
- Operaciones de lectura (GET): 200 solicitudes por minuto
- Operaciones de escritura (POST/PUT/PATCH/DELETE): 120 solicitudes por
minuto
- Operaciones CRUD de webhooks: 60 solicitudes por minuto
- Prueba de webhook: 10 solicitudes por minuto
- Regeneración/expiración de clave API: 1 solicitud por minuto
- Rotación de secreto de webhook: 1 solicitud por minuto
Cuando se superan los límites de solicitudes, la API devuelve una respuesta
`429 Too Many Requests` con los encabezados:
- `X-RateLimit-Limit`: Máximo de solicitudes por minuto para este endpoint
- `X-RateLimit-Remaining`: Solicitudes restantes en la ventana actual
- `X-RateLimit-Reset`: Marca de tiempo Unix de cuándo se restablece el
límite
- `Retry-After`: Segundos hasta que se permita reintentar
**Manejo de Errores**: Todos los errores devuelven respuestas JSON
estructuradas con `error` (mensaje legible para humanos), `code`
(identificador legible por máquina) y `details` (errores de validación a
nivel de campo cuando corresponda).
**Integración del Editor de Plantillas Incrustado**: El Editor de Plantillas
de Firma se puede incrustar en tu aplicación usando una biblioteca
JavaScript independiente.
```html
```
**Encabezado X-Firma-Deprecation**: Algunas operaciones de creación de
sellos y de actualización de imagen devuelven un encabezado de respuesta
`X-Firma-Deprecation` cuando se invocan a través del edge gateway, indicando
que la operación debe realizarse en el host principal de la API.
**Documentos múltiples (API 01.39.00, requiere habilitación)**: una
plantilla o solicitud de firma puede contener hasta 20 documentos. Las rutas
del subrecurso `/documents` y las claves `documents`, `documents_version` y
`documents_layout_version` solo se ofrecen a las empresas habilitadas para
documentos múltiples; para cualquier otra empresa, las rutas responden `404
NOT_FOUND` y las claves no aparecen.
**Sellos de plantilla al crear (API 01.39.01)**: crear una solicitud de
firma a partir de una plantilla con `POST /signing-requests` o `POST
/signing-requests/create-and-send` ahora hereda los participantes de sello
de la plantilla, y los campos de la plantilla que les pertenecen, cuando
`seal_participants` está ausente o es `null`. Esto cambia el comportamiento
de v1 sin incrementar la versión; envía `seal_participants: []` para crear
la solicitud sin sellos. `POST /templates/{id}/duplicate` también traslada
los participantes de sello de la plantilla; consulta esa operación para ver
en qué se diferencia para las empresas habilitadas para documentos
múltiples. `GET /templates/{id}` devuelve `seal_participants`, y `POST
/templates` responde `warnings` cuando su cuerpo contiene claves que ignora.
version: 01.39.01
contact:
name: API Support
url: https://firma.com/support
servers:
- url: https://api.firma.dev/functions/v1/signing-request-api
description: API de Producción - Recomendada (Actual)
- url: https://api.firma.dev/api/v1
description: API de Producción - Planeada
security:
- ApiKeyAuth: []
tags:
- name: Company
description: Información y configuración de la empresa
- name: Workspaces
description: Operaciones de gestión de espacios de trabajo
- name: Templates
description: Operaciones de gestión de plantillas
- name: Signing Requests
description: Operaciones de solicitudes de firma de documentos
- name: Custom Fields
description: >-
Gestión de definiciones de campos personalizados para espacios de trabajo,
plantillas y solicitudes de firma
- name: Webhooks
description: Configuración y gestión de webhooks
- name: JWT Management
description: Generación y revocación de tokens JWT para plantillas incrustadas
- name: Workspace Settings
description: Configuración y ajustes del espacio de trabajo
- name: Email Domains
description: >-
Configuración y verificación de dominios de correo electrónico para enviar
correos de solicitudes de firma desde dominios personalizados
- name: Email Templates
description: >-
Gestión de plantillas de correo electrónico para personalización de
notificaciones de solicitudes de firma a nivel de espacio de trabajo y de
empresa
- name: Organization Seals
description: >-
Gestión de sellos de organización: crear, actualizar, revocar y borrar
sellos aplicados a solicitudes de firma
- name: Signer Terms
description: >-
Términos de servicio / declaraciones de consentimiento personalizadas del
firmante, a nivel de empresa con anulaciones por espacio de trabajo según
el idioma
paths:
/templates/{id}:
patch:
tags:
- Templates
summary: Actualizar Plantilla Parcialmente
description: >-
Actualiza las propiedades de la plantilla, un solo usuario, O un solo
campo. No se pueden mezclar múltiples tipos de entidad en una sola
solicitud. Usa PUT para actualizaciones integrales que incluyan
usuarios, campos y recordatorios. Un `seal_participant` que nombra un
sello responde 404 `NOT_FOUND` cuando el sello no existe o pertenece a
otra empresa, y 400 `SEAL_UNAVAILABLE` cuando el sello está revocado,
borrado o no es la versión actual de su linaje. Añadir un participante
de sello o cambiar su sello responde 503 `SEALS_DISABLED` cuando los
sellos de organización no están habilitados. Añadir un participante de
sello requiere `order` (consulta el contrato de orden).
operationId: patchTemplate
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: object
description: Actualizar propiedades de la plantilla
properties:
name:
type: string
description: Nombre de la plantilla
maxLength: 255
description:
type: string
description: Descripción de la plantilla
document:
type: string
format: byte
description: >-
PDF o DOCX codificado en base64 para reemplazar el
documento. Los archivos DOCX se convierten
automáticamente a PDF. Para documentos de más de 5 MB,
usa POST /documents y pasa el document_id en su lugar.
(mutuamente excluyente con document_id)
document_id:
type: string
format: uuid
description: >-
ID de un documento subido previamente (mutuamente
excluyente con document). Obténlo llamando primero a
POST /documents.
example: 123e4567-e89b-12d3-a456-426614174000
expiration_hours:
type: integer
minimum: 1
description: Horas hasta la expiración
settings:
type: object
properties:
allow_editing_before_sending:
type: boolean
attach_pdf_on_finish:
type: boolean
allow_download:
type: boolean
hand_drawn_only:
type: boolean
require_otp_verification:
type: boolean
nullable: true
description: >-
Exige a los firmantes verificar su correo
electrónico con un código de un solo uso; `null`
hereda la configuración del espacio de trabajo o de
la empresa.
disable_guided_navigation:
type: boolean
nullable: true
allow_presigning_download:
type: boolean
nullable: true
description: >-
Permite a los firmantes descargar el documento
original antes de firmar; `null` hereda la
configuración del espacio de trabajo o de la
empresa.
show_qr_code:
type: boolean
nullable: true
description: >-
Muestra un código QR en la página de firma que
permite a los firmantes continuar desde su teléfono.
Hereda la configuración del espacio de trabajo o de
la empresa cuando es null.
- type: object
description: Actualizar o crear un solo usuario
required:
- user
properties:
user:
type: object
required:
- first_name
- email
- designation
- order
properties:
id:
type: string
format: uuid
description: >-
Inclúyelo para actualizar un usuario existente,
omítelo para crear uno nuevo. Un destinatario
existente no puede cambiarse entre CC y
Firmante/Aprobador (400); elimínalo y créalo de
nuevo.
first_name:
type: string
maxLength: 255
last_name:
type: string
maxLength: 255
description: >-
Opcional, pero requerido si se usan las variables
prellenadas full_name o last_name
email:
type: string
format: email
designation:
type: string
enum:
- Signer
- Approver
- CC
order:
type: integer
minimum: 1
phone_number:
type: string
street_address:
type: string
city:
type: string
state_province:
type: string
postal_code:
type: string
country:
type: string
title:
type: string
company:
type: string
- type: object
description: Actualizar o crear un solo campo
required:
- field
properties:
field:
type: object
properties:
id:
type: string
format: uuid
description: >-
Inclúyelo para actualizar un campo existente,
omítelo para crear uno nuevo
type:
type: string
enum:
- text
- signature
- date
- checkbox
- initial
- initials
- dropdown
- radio_buttons
- textarea
- text_area
- url
- file
- stamp
- approval_signature
- approval_checkmark
- approval_date
description: >-
Tipo de campo. Acepta 'initial' o 'initials',
'textarea' o 'text_area'. Requerido para campos
nuevos. Los campos url son de solo lectura
automáticamente. Los campos file permiten a los
firmantes subir archivos adjuntos (imágenes/PDF).
Los campos stamp muestran una imagen preconfigurada.
x:
type: number
description: >-
Posición X en el documento. Requerido para campos
nuevos.
'y':
type: number
description: >-
Posición Y en el documento. Requerido para campos
nuevos.
width:
type: number
description: Ancho del campo. Requerido para campos nuevos.
height:
type: number
description: Alto del campo. Requerido para campos nuevos.
page:
type: integer
minimum: 1
description: >-
Número de página (indexado desde 1). Requerido para
campos nuevos.
required:
type: boolean
description: Si el campo es obligatorio
assigned_to_user_id:
type: string
format: uuid
nullable: true
description: >-
ID del usuario de plantilla al que asignar el campo;
`null` quita el usuario del campo y lo deja sin
asignar.
variable_name:
type: string
description: >-
Nombre de variable para el mapeo de datos
prellenados
variable_defined_name:
type: string
maxLength: 100
nullable: true
description: >-
Nombre legible personalizado para la definición del
campo. Se puede usar como alternativa a
variable_name para apuntar a campos en la creación
basada en plantillas.
options:
type: array
items:
type: string
description: Opciones para campos desplegables
format_rules:
type: object
description: >-
Reglas de formato (p. ej., formato de fecha,
urlDisplayText para campos url, acceptedFileTypes
para campos file)
multi_group_id:
type: string
format: uuid
description: ID de grupo para grupos de botones de radio
default_to_signing_date:
type: boolean
description: >-
Para campos de fecha, usar la fecha de firma como
valor predeterminado
read_only:
type: boolean
description: >-
Si el campo es de solo lectura (automáticamente true
para campos url)
read_only_value:
type: string
description: >-
Valor estático para campos de solo lectura. Para
campos url, esta es la URL a la que se enlaza.
documents_layout_version:
type: integer
minimum: 0
description: >-
El `documents_layout_version` de su última lectura
(multidocumento). Obligatorio para escribir un campo en
una plantilla con más de un documento o con una versión
de disposición superior a 1 (`409
DOCUMENTS_LAYOUT_VERSION_REQUIRED`); un valor obsoleto
responde `409 DOCUMENT_SET_VERSION_CONFLICT`; un valor
que no es un entero no negativo responde `400
VALIDATION_ERROR` con la clave
`documents_layout_version`.
- type: object
required:
- seal_participant
description: >-
Añade o actualiza un participante de sello de la plantilla.
Envía solo la clave `seal_participant`.
properties:
seal_participant:
type: object
description: >-
Uno de dos usos, según las claves enviadas; cada uno
responde `{ "seal_participant": ... }`. Añadir: envía
`seal_id` y `order` sin `id`; responde 201. Actualizar:
envía `id` con `order` para mover al participante, con
`seal_id` para cambiar su sello, o con ambos; responde
200. Un participante de sello de plantilla no se puede
intercambiar.
properties:
id:
type: string
format: uuid
description: >-
ID del participante de sello que se va a actualizar.
Omítelo para añadir un participante de sello.
seal_id:
type: string
format: uuid
description: >-
ID del sello de organización. Obligatorio para
añadir un participante de sello; en una
actualización pasa a ser el sello del participante.
El sello debe pertenecer a la empresa, ser la
versión actual de su linaje y no estar revocado ni
borrado.
order:
type: integer
minimum: 1
description: >-
Posición en el orden de la plantilla, compartido con
el espacio de orden de los usuarios. Obligatorio
para añadir un participante de sello; en una
actualización mueve al participante.
examples:
update-properties:
summary: Actualizar propiedades
value:
name: Updated Template Name
expiration_hours: 72
create-url-field:
summary: Crear campo URL
value:
field:
type: url
x: 100
'y': 200
width: 150
height: 30
page: 1
read_only_value: https://example.com/terms
format_rules:
urlDisplayText: View Terms & Conditions
create-file-field:
summary: Crear campo de subida de archivo
value:
field:
type: file
x: 100
'y': 300
width: 200
height: 40
page: 1
required: true
format_rules:
acceptedFileTypes: image_and_pdf
update-field:
summary: Actualizar campo existente
value:
field:
id: field123-e89b-12d3-a456-426614174000
x: 120
'y': 220
responses:
'200':
description: >-
Plantilla actualizada parcialmente con éxito. Actualizar un
participante de sello devuelve `{ "seal_participant":
}`.
headers:
X-RateLimit-Limit:
schema:
type: integer
description: 'Límite de solicitudes: 120 solicitudes por minuto'
X-RateLimit-Remaining:
schema:
type: integer
X-RateLimit-Reset:
schema:
type: integer
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/TemplatePatchResponse'
- type: object
description: Respuesta al actualizar un participante de sello
required:
- seal_participant
properties:
seal_participant:
$ref: '#/components/schemas/SealParticipantApi'
'201':
description: >-
Se creó un campo o un participante de sello. El cuerpo es el objeto
de campo creado; para un participante de sello es `{
"seal_participant": }`. Actualizar un
participante de sello responde 200 con el mismo cuerpo `{
"seal_participant": ... }`.
headers:
X-RateLimit-Limit:
schema:
type: integer
description: 'Límite de tasa: 120 solicitudes por minuto'
X-RateLimit-Remaining:
schema:
type: integer
X-RateLimit-Reset:
schema:
type: integer
content:
application/json:
schema:
anyOf:
- type: object
description: El campo creado
- type: object
description: El participante de sello creado
required:
- seal_participant
properties:
seal_participant:
$ref: '#/components/schemas/SealParticipantApi'
'400':
description: >-
Solicitud Incorrecta - La validación falló. Multidocumento:
`PAGE_COUNT_MISMATCH`, `DIMENSION_MISMATCH` (reemplazo de
documento). Escrituras de campos multidocumento: `VALIDATION_ERROR`
con la clave `page` (una página posterior al número de páginas del
documento) o `documents_layout_version`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: Validation Error
message: Invalid input data
details:
name: Name is required
email: Invalid email format
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
description: Plantilla o participante de sello no encontrado
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
not_found:
value:
error: Template not found
code: NOT_FOUND
seal_not_found:
value:
error: Seal not found
code: NOT_FOUND
'409':
description: >-
Conflicto: `MULTI_DOCUMENT_READ_ONLY`,
`MULTI_DOCUMENT_REPLACE_UNSUPPORTED`,
`DOCUMENT_SET_VERSION_CONFLICT`, `DOCUMENT_SET_BUSY`,
`DOCUMENT_SET_DISPATCH_STALE`, `DOCUMENT_CANDIDATE_EXPIRED`,
`DOCUMENT_SET_INCONSISTENT`, `DOCUMENTS_LAYOUT_VERSION_REQUIRED`
content:
application/json:
schema:
$ref: '#/components/schemas/MultiDocumentError'
'429':
$ref: '#/components/responses/RateLimitError'
'503':
description: >-
Los sellos de organización no están habilitados y se añade un
participante de sello o se cambia su sello (`SEALS_DISABLED`).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: TypeScript
label: '@firma-dev/sdk'
source: |-
import { FirmaClient } from "@firma-dev/sdk";
const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });
const response = await firma.templates.patchTemplate({
id: "id",
body: {
name: "Updated Template Name",
expiration_hours: 72
}
});
console.log(response);
components:
schemas:
TemplatePatchResponse:
type: object
properties:
message:
type: string
updated_fields:
type: array
items:
type: string
description: Se devuelve al actualizar propiedades
user:
type: object
description: Se devuelve al actualizar/crear un usuario
description: Resultado de la actualización parcial de la plantilla
required:
- message
- updated_fields
SealParticipantApi:
type: object
description: >-
Participante de sello tal como lo devuelve la API en una solicitud de
firma o en una plantilla. Todas las claves están siempre presentes; las
claves anulables son null cuando no tienen valor.
required:
- id
- order
- seal
- status
- applied_at
- paused_at
- pause_reason
- swapped_from_seal_id
- triggered_by_recipient_id
- sender_kind
- seal_out_of_scope
properties:
id:
type: string
format: uuid
order:
type: integer
minimum: 1
description: >-
Posición en el orden de firma, compartida con el espacio de orden de
los destinatarios.
seal:
type: object
description: El sello de organización que aplica este participante.
required:
- id
- lineage_id
- name
- version
- display_name
properties:
id:
type: string
format: uuid
lineage_id:
type: string
format: uuid
description: Compartido entre las versiones del mismo sello
name:
type: string
version:
type: integer
display_name:
type: string
status:
type: string
enum:
- pending
- paused
- applied
description: >-
applied cuando applied_at tiene valor; si no, paused cuando
paused_at tiene valor; si no, pending.
applied_at:
type: string
format: date-time
nullable: true
paused_at:
type: string
format: date-time
nullable: true
pause_reason:
type: string
nullable: true
enum:
- seal_revoked_stop_pending
- seal_integrity_mismatch
- null
swapped_from_seal_id:
type: string
format: uuid
nullable: true
triggered_by_recipient_id:
type: string
format: uuid
nullable: true
description: El destinatario cuya acción aplicó el sello.
sender_kind:
type: string
nullable: true
enum:
- dashboard
- api_key
- embedded
- null
seal_out_of_scope:
type: boolean
description: >-
Verdadero cuando el sello pertenece a un espacio de trabajo distinto
del de la solicitud de firma o de la plantilla.
Error:
type: object
properties:
error:
type: string
description: Mensaje de error legible para humanos
code:
type: string
description: >-
Código de error legible por máquina. Códigos relacionados con
sellos: SEALS_DISABLED, SEAL_ALREADY_REVOKED,
SEAL_CREATION_DISABLED_EDGE, SEAL_ERASE_NOT_ELIGIBLE,
SEAL_IMAGE_INVALID, SEAL_MUTATION_NOT_ALLOWED, SEAL_NOT_FOUND,
SEAL_NO_IMAGE_FIELD, SEAL_ORDER_COLLISION, SEAL_PAUSED,
SEAL_SCOPE_FORBIDDEN, SEAL_UNAVAILABLE Códigos multidocumento:
consulte MultiDocumentErrorCode (41 códigos).
errors:
type: array
description: >-
Todos los errores de validación cuando se notifican varios fallos a
la vez. El error de nivel superior repite el primer elemento por
compatibilidad con versiones anteriores.
items:
type: object
required:
- message
properties:
message:
type: string
message:
type: string
description: Descripción detallada del error
details:
type: object
description: Detalles adicionales del error
additionalProperties: true
required:
- error
description: >-
Códigos de error de sellos de organización: SEALS_DISABLED,
SEAL_ALREADY_REVOKED, SEAL_CREATION_DISABLED_EDGE,
SEAL_ERASE_NOT_ELIGIBLE, SEAL_IMAGE_INVALID, SEAL_MUTATION_NOT_ALLOWED,
SEAL_NOT_FOUND, SEAL_NO_IMAGE_FIELD, SEAL_ORDER_COLLISION, SEAL_PAUSED,
SEAL_SCOPE_FORBIDDEN, SEAL_UNAVAILABLE
MultiDocumentError:
description: Un error respondido por una ruta multidocumento.
allOf:
- $ref: '#/components/schemas/Error'
- type: object
required:
- error
- code
properties:
code:
$ref: '#/components/schemas/MultiDocumentErrorCode'
MultiDocumentErrorCode:
type: string
enum:
- ALREADY_CANCELLED
- ALREADY_FINISHED
- ALREADY_SENT
- ANCHOR_DOCUMENT_REQUIRED
- ANCHOR_MISMATCH
- CONFLICTING_DOCUMENT_SOURCE
- DIMENSION_MISMATCH
- DOCUMENTS_LAYOUT_VERSION_REQUIRED
- DOCUMENT_CANDIDATE_EXPIRED
- DOCUMENT_NOT_FOUND
- DOCUMENT_ORIGINAL_NOT_AVAILABLE
- DOCUMENT_SET_BUSY
- DOCUMENT_SET_DISPATCH_STALE
- DOCUMENT_SET_INCONSISTENT
- DOCUMENT_SET_LOCKED
- DOCUMENT_SET_TOO_LARGE
- DOCUMENT_SET_VERSION_CONFLICT
- DOCUMENT_SIGNED_NOT_AVAILABLE
- DOCUMENT_UPLOAD_NOT_FOUND
- DUPLICATE_DOCUMENT_ID
- FENCE_COLUMN_PROTECTED
- INSUFFICIENT_CREDITS
- INTERNAL
- INTERNAL_ERROR
- INVALID_DOCUMENT_ORDER
- INVALID_SIGNING_ORDER
- MAX_DOCUMENTS_EXCEEDED
- MIN_DOCUMENTS_REQUIRED
- MULTI_DOCUMENT_READ_ONLY
- MULTI_DOCUMENT_REPLACE_UNSUPPORTED
- NOT_FOUND
- PAGE_COUNT_MISMATCH
- PARTICIPANTS_CHANGED
- RATE_LIMIT_EXCEEDED
- SEAL_MUTATION_NOT_ALLOWED
- SEND_EFFECTS_EXIST
- SEND_IN_PROGRESS
- SIGNED_DATA_IMMUTABLE
- SIGNING_ORDER_LOCKED_APPLIED
- SIGNING_ORDER_LOCKED_SENDING
- SIGNING_ORDER_LOCKED_SENT
- VALIDATION_ERROR
description: >-
Códigos de error del contrato multidocumento y de las rutas que modifica
(generados a partir de las filas de la matriz de errores que expone la
API). Un fallo genuino del servidor responde 500 con INTERNAL_ERROR en
las rutas heredadas e INTERNAL en las rutas HttpError compartidas
(despacho multidocumento, el mapa de estados RPC, las rutas del conjunto
de documentos); ninguno de los dos incluye detalles.
responses:
UnauthorizedError:
description: No Autorizado - Clave API inválida o faltante
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: Unauthorized
message: Invalid API key
RateLimitError:
description: Demasiadas Solicitudes - Se superó el límite de solicitudes
headers:
X-RateLimit-Limit:
schema:
type: integer
description: Número máximo de solicitudes por minuto
X-RateLimit-Remaining:
schema:
type: integer
description: Solicitudes restantes
X-RateLimit-Reset:
schema:
type: integer
description: Marca de tiempo Unix del reinicio
Retry-After:
schema:
type: integer
description: Segundos hasta que se permita reintentar
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: Rate Limit Exceeded
message: Too many requests. Please wait before retrying.
details:
retry_after: 45
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: Authorization
description: >-
Clave API para autenticación. Usa tu clave API directamente sin ningún
prefijo (por ejemplo, 'your-api-key'). El prefijo Bearer es opcional
pero no obligatorio.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.