Redacta ejemplos de solicitudes a partir de la documentación visible. Usa marcadores para las credenciales y los datos ausentes, y guarda el texto sin llamar a la API.
Qué necesitas: una página de referencia de API con el método, la ruta y el esquema visibles.
Necesitas la extensión de Chrome y una cuenta de WebAct. Incluye 25 tareas de automatización gratis al mes. También se aplican los límites de tu proveedor de IA.
INSTRUCCIONES PARA COPIAR
Conserva los hechos y deja visibles las dudas.
Copia esta instrucción en WebAct, en la pestaña de origen.
Prepara ejemplos de una APITAREA
Trabaja únicamente con esta fuente: una página de referencia de API con el método, la ruta y el esquema visibles. Redacta ejemplos de solicitudes a partir de la documentación visible. Usa marcadores para las credenciales y los datos ausentes, y guarda el texto sin llamar a la API. Crea un archivo TXT llamado webact-api-documentation-example-generator.txt. El archivo completo debe ocupar menos de 48.000 bytes en UTF-8. Usa solo el contenido observado y los datos que yo aporte. No inventes los valores que falten. Conserva los identificadores, fechas, unidades y monedas. Indica el contenido omitido, truncado o ilegible; no afirmes que se ha incluido todo. Comprueba el resultado con la fuente y detente si falta el contenido necesario. Antes de empezar, pídeme los ajustes necesarios o los datos de origen que falten. Empieza con hasta 25 registros o un documento breve. Indica exactamente qué contenido de origen se ha incluido. Usa solo campos documentados.
Pégalas en el modo Tarea, con la opción de IA en el navegador seleccionada.
Adapta la tarea a lo que necesitas. Indica los campos, el tono o el nivel de detalle que necesitas. Conserva los datos originales y marca lo que debas revisar.
● ● ●Del original al archivo.EJEMPLO
Datos de entrada de ejemplo
API documentation: POST /items. Required JSON field: name (string).
Authentication: Authorization: Bearer <token>.
API base URL not supplied.
POST /items
Authorization: Bearer <YOUR_TOKEN>
Content-Type: application/json
{"name":"Example item"}
Use your documented API base URL. This is a request example; no request has been sent.
TXT
Archivo de texto, listo para revisar.Un archivo aparte, sin modificar la página.
El ejemplo utiliza datos ficticios. Abre tu propia página y ejecuta la tarea en la extensión para crear el archivo.
GUÍA PRÁCTICA
Cómo redactar ejemplos de API a partir de la documentación proporcionada
Los ejemplos de API ayudan a conectar la descripción de un endpoint con una estructura concreta de solicitud y respuesta. La exactitud depende del método, los campos y los requisitos de autenticación realmente proporcionados.
Empieza con el material adecuado.
Qué aportas
una página de referencia de API con el método, la ruta y el esquema visibles.
El resultado previsto
Guarda ejemplos de solicitudes con credenciales de muestra y solo los campos documentados.
Cómo funciona el flujo de trabajo.
Utiliza el esquema documentado y valores de ejemplo claramente ficticios. Conserva los campos obligatorios y opcionales, y usa marcadores de posición para las credenciales en lugar de incluir secretos reales.
Qué comprobar en el resultado.
Valida el ejemplo en el entorno correspondiente antes de publicarlo como probado. Una solicitud o respuesta verosímil no demuestra que el endpoint exista ni que se comporte como se muestra.
Lee el texto como un resultado editable y contrástalo con la fuente. Conserva las referencias, nombres y condiciones importantes al copiarlo a otro documento o mensaje.
Aprende del ejemplo resuelto.
Usa el ejemplo descargable para comprender la estructura del resultado. Compáralo con el ejemplo de origen y aplica las mismas comprobaciones factuales al material que aportes para tu propia tarea.
El ejemplo proporcionado es ilustrativo. No es una ejecución registrada con tus datos.
Instala la extensión de Chrome y verifica tu cuenta de WebAct. Selecciona la opción de IA en el navegador, elige ChatGPT e inicia sesión si se te solicita.
02
Prepara el contenido de origen.
Ten disponible una página de referencia de API con el método, la ruta y el esquema visibles. Activa WebAct desde la barra de herramientas de Chrome, selecciona el contexto pertinente y cambia al modo Tarea.
03
Crea el archivo y comprueba el contenido.
Pega la instrucción, revisa las acciones propuestas y ejecuta la tarea. Compara el archivo descargado con el contenido seleccionado antes de usarlo o compartirlo.
La página de partida.
Una página de referencia de API con el método, la ruta y el esquema visibles.
El archivo que obtienes.
Redacta ejemplos de solicitudes a partir de la documentación visible. Usa marcadores para las credenciales y los datos ausentes, y guarda el texto sin llamar a la API. Archivo de texto.
Los límites de esta tarea.
La tarea se limita a la pestaña activa. Empieza con un máximo de 25 registros o un documento breve. El archivo completo debe ocupar menos de 48.000 bytes en UTF-8.
DUDAS FRECUENTES
Qué incluye el archivo y qué debes comprobar.
POST /items requiere name como cadena y una cabecera de autorización. El ejemplo conserva un marcador para el token; la URL base sigue pendiente y no se ha enviado ninguna solicitud.
Una página de referencia de API con el método, la ruta y el esquema visibles. Despliega el contenido pertinente y comparte solo el contexto necesario. Proporciona los hechos o criterios imprescindibles que no aparezcan en la fuente.
¿Qué debo comprobar en el archivo?
POST /items requiere name como cadena y una cabecera de autorización. El ejemplo conserva un marcador para el token; la URL base sigue pendiente y no se ha enviado ninguna solicitud.
¿Esto ejecuta pruebas o código?
Estas tareas preparan documentación, ejemplos o escenarios de revisión. No ejecutan las pruebas ni los comandos propuestos. La inspección de solo lectura de la página, cuando sea necesaria, requiere tu aprobación.
¿Puedo usarlo con el plan gratuito?
Sí. Puedes usar el plan Free de WebAct con tu sesión de ChatGPT en el navegador. Necesitas la extensión de Chrome, una cuenta de WebAct verificada y haber iniciado sesión en ChatGPT en el mismo perfil de Chrome. No hace falta contratar un plan de pago de WebAct ni disponer de una clave API de pago. Se siguen aplicando los límites de uso de ChatGPT. El plan Free incluye 25 tareas de automatización al mes, compartidas entre todas las herramientas. Una tarea se descuenta cuando empieza su primera acción. Los pasos intermedios y los reintentos necesarios para completarla no se cuentan por separado. El cupo se renueva cada mes natural, según la hora UTC. Si lo agotas, puedes contratar un plan de pago o esperar al mes siguiente. Chatear sin ejecutar automatizaciones no consume tareas y sigue siendo gratis, dentro de los límites de tu proveedor de IA.
¿La tarea se ejecuta en esta página?
No. Aquí tienes un ejemplo y las instrucciones para copiar. La tarea se ejecuta con WebAct en la página de origen que actives. El proveedor de IA que uses en el navegador procesa la información de la página compartida con la tarea. Una respuesta de chat sin automatización no consume tareas de WebAct; crear un archivo o modificar campos en el modo Tarea sí.
Consulta cómo tratamos el contexto de página compartido en nuestra política de privacidad.