Objetos
Error
Respuesta de error estándar. detail es una cadena, un objeto con code (por ejemplo, choose_org, org_suspended, códigos de invitación) o una lista de errores de validación (422). error es una descripción estructurada: un código del catálogo de errores, un mensaje en inglés, detalles estructurados y el ID de la solicitud.
Campos
Mensaje de error, un objeto con un código o una lista de errores de validación.
errorErrorInfo
Se usa en
- GET
/v1/healthObtener el estado y la versión del servicio - GET
/v1/usersListar los usuarios de la organización - POST
/v1/usersCrear un usuario - PATCH
/v1/users/{user_id}Actualizar un usuario - GET
/v1/api-keysListar las claves de API de la organización - POST
/v1/api-keysCrear una clave de API - DELETE
/v1/api-keys/{key_id}Revocar una clave de API - PATCH
/v1/api-keys/{key_id}Actualizar una clave de API - POST
/v1/api-keys/{key_id}/rollRotar una clave de API - POST
/v1/api-keys/{key_id}/revoke-previousRevocar el valor anterior de una clave de API - GET
/v1/auditListar las entradas del registro de auditoría - GET
/v1/audit/actionsListar las acciones del registro de auditoría con sus recuentos - GET
/v1/audit/export.csvExportar el registro de auditoría como CSV - GET
/v1/orgObtener la organización - GET
/v1/categoriesListar las categorías de documentos - POST
/v1/categoriesCrear una categoría - DELETE
/v1/categories/{key}Eliminar una categoría personalizada - PATCH
/v1/categories/{key}Actualizar una categoría - GET
/v1/collectionsListar las colecciones disponibles para el usuario - POST
/v1/collectionsCrear una colección - DELETE
/v1/collections/{name}Eliminar una colección - PATCH
/v1/collections/{name}Actualizar una colección - POST
/v1/collections/{name}/reindexReindexar una colección - GET
/v1/collections/{name}/statsObtener el resumen de la colección: estadísticas, categorías, tarjetas recientes, permisos - GET
/v1/cardsListar tarjetas - POST
/v1/cardsSubir un archivo como tarjeta - GET
/v1/jobsListar los trabajos de indexación - GET
/v1/jobs/summaryObtener el resumen de la cola - GET
/v1/jobs/streamTransmitir los cambios de los trabajos (SSE) - GET
/v1/jobs/{job_id}Obtener un trabajo - DELETE
/v1/jobs/{job_id}Cancelar un trabajo en cola - GET
/v1/cards/countContar tarjetas - GET
/v1/cards/export.xlsxExportar la lista de tarjetas a XLSX - POST
/v1/cards/bulkEjecutar una acción masiva sobre tarjetas - GET
/v1/cards/{card_id}Obtener una tarjeta con sus versiones, comentarios, tablas y eventos - DELETE
/v1/cards/{card_id}Eliminar una tarjeta - PATCH
/v1/cards/{card_id}Actualizar una tarjeta - GET
/v1/cards-by-external-id/{external_id}Obtener una tarjeta por su ID externo - PUT
/v1/cards-by-external-id/{external_id}Crear o reemplazar una tarjeta por su ID externo - GET
/v1/cards/{card_id}/contentObtener el texto de la tarjeta por secciones - PUT
/v1/cards/{card_id}/contentReemplazar el contenido de una tarjeta - GET
/v1/cards/{card_id}/tables/{table_id}/rowsListar las filas de una tabla de hechos - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Comparar dos versiones de una tarjeta - GET
/v1/cards/{card_id}/usageListar las preguntas cuyas respuestas usaron la tarjeta - POST
/v1/cards/{card_id}/usageRegistrar un evento de uso de una tarjeta - POST
/v1/cards/{card_id}/reindexReindexar una tarjeta - DELETE
/v1/cards/{card_id}/comments/{comment_id}Eliminar un comentario - GET
/v1/cards/{card_id}/fileDescargar el archivo original de una tarjeta - GET
/v1/cards/{card_id}/exportExportar una tarjeta a un documento - POST
/v1/cards/{card_id}/verifyConfirmar que una tarjeta está actualizada - POST
/v1/cards/{card_id}/commentsAñadir un comentario - GET
/v1/conversationsListar conversaciones - GET
/v1/conversations/{conv_id}Obtener una conversación con sus turnos - POST
/v1/searchBuscar en las colecciones - POST
/v1/askObtener una respuesta del asistente sin transmisión - POST
/v1/chatTransmitir una respuesta del asistente (SSE) - POST
/v1/questions/{question_id}/feedbackValorar una respuesta - GET
/v1/questions/export.csvExportar el registro de preguntas a CSV - GET
/v1/questions/{question_id}Obtener una pregunta guardada con su respuesta - GET
/v1/questions/{question_id}/followupsObtener preguntas de seguimiento sugeridas - GET
/v1/questionsListar el registro de preguntas - GET
/v1/questions/{question_id}/exportExportar una respuesta a un documento - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportExportar un conjunto de datos de una respuesta - GET
/v1/questions/{question_id}/answer-tables/{index}/exportExportar una tabla del texto de la respuesta - POST
/v1/questions/{question_id}/refreshActualizar los conjuntos de datos de una respuesta (respuesta dinámica) - POST
/v1/questions/{question_id}/save-cardGuardar una respuesta como tarjeta - POST
/v1/cards/textCrear una tarjeta de texto (Markdown) - GET
/v1/filesListar los archivos de exportación - GET
/v1/files/authorsListar los autores de los archivos (para el filtro del administrador) - GET
/v1/files/{file_id}Obtener los datos de un archivo - DELETE
/v1/files/{file_id}Eliminar un archivo - GET
/v1/files/{file_id}/downloadDescargar un archivo - GET
/v1/files/{file_id}/previewObtener la vista previa de un archivo - POST
/v1/files/{file_id}/extendAmpliar el período de conservación de un archivo - POST
/v1/files/{file_id}/regenerateVolver a generar un archivo a partir de sus parámetros guardados - GET
/v1/tasksListar las tareas de un usuario o de un equipo - POST
/v1/sourcesCrear una fuente - GET
/v1/sources/{source_id}Obtener una fuente - DELETE
/v1/sources/{source_id}Eliminar una fuente - PATCH
/v1/sources/{source_id}Actualizar una fuente - PATCH
/v1/sources/{source_id}/settingsActualizar la configuración de una fuente - GET
/v1/cards/{card_id}/similarListar las tarjetas similares - GET
/v1/insights/gapsListar los vacíos de conocimiento (grupos de preguntas sin respuesta) - GET
/v1/permissionsListar el registro de permisos - POST
/v1/uploadsIniciar una subida por partes - GET
/v1/uploads/{upload_id}Obtener una subida - DELETE
/v1/uploads/{upload_id}Cancelar una subida - PUT
/v1/uploads/{upload_id}/parts/{n}Enviar una parte de la subida - POST
/v1/uploads/{upload_id}/completeCompletar una subida - GET
/v1/meObtener los datos de quien llama a la API - GET
/v1/me/permissionsObtener los permisos del usuario actual sobre la organización - GET
/v1/rolesListar los roles (integrados y personalizados) - POST
/v1/rolesCrear un rol personalizado - DELETE
/v1/roles/{role_id}Eliminar un rol personalizado - PATCH
/v1/roles/{role_id}Actualizar un rol personalizado - GET
/v1/groupsListar los grupos de la organización - POST
/v1/groupsCrear un grupo - GET
/v1/groups/{group_id}Obtener un grupo con sus miembros - DELETE
/v1/groups/{group_id}Eliminar un grupo - PATCH
/v1/groups/{group_id}Cambiar el nombre de un grupo - PUT
/v1/groups/{group_id}/members/{user_id}Añadir un miembro a un grupo - DELETE
/v1/groups/{group_id}/members/{user_id}Quitar un miembro de un grupo - GET
/v1/org/permissionsObtener los permisos sobre la organización (quién es administrador) - PUT
/v1/org/permissionsConceder roles sobre la organización - DELETE
/v1/org/permissionsRevocar roles sobre la organización - GET
/v1/collections/{name}/permissionsObtener los permisos sobre una colección (directos y heredados) - PUT
/v1/collections/{name}/permissionsConceder roles sobre una colección - DELETE
/v1/collections/{name}/permissionsRevocar roles sobre una colección - GET
/v1/cards/{card_id}/permissionsObtener los permisos sobre una tarjeta (directos y heredados) - PUT
/v1/cards/{card_id}/permissionsConceder roles sobre una tarjeta - DELETE
/v1/cards/{card_id}/permissionsRevocar roles sobre una tarjeta - GET
/v1/sources/{source_id}/permissionsObtener los permisos sobre una fuente (directos y heredados) - PUT
/v1/sources/{source_id}/permissionsConceder roles sobre una fuente - DELETE
/v1/sources/{source_id}/permissionsRevocar roles sobre una fuente - POST
/v1/users/{user_id}/offboardDar de baja a un usuario - GET
/v1/collections/{name}/foldersObtener el árbol de carpetas de una colección - POST
/v1/collections/{name}/foldersCrear una carpeta - GET
/v1/foldersObtener los árboles de carpetas de todas las colecciones - GET
/v1/folders/{folder_id}Obtener una carpeta - DELETE
/v1/folders/{folder_id}Eliminar una carpeta y subir su contenido de nivel - PATCH
/v1/folders/{folder_id}Cambiar el nombre, mover o reordenar una carpeta - GET
/v1/folders/{folder_id}/cardsListar las tarjetas de una carpeta - GET
/v1/folders/{folder_id}/permissionsObtener los permisos sobre una carpeta (directos y heredados) - PUT
/v1/folders/{folder_id}/permissionsConceder roles sobre una carpeta - DELETE
/v1/folders/{folder_id}/permissionsRevocar roles sobre una carpeta - GET
/v1/catalog/servicesListar los servicios del catálogo - GET
/v1/catalog/services/{service_id}Obtener un servicio del catálogo - GET
/v1/catalog/services/{service_id}/iconObtener el icono de un servicio - GET
/v1/catalog/categoriesListar las categorías del catálogo - GET
/v1/catalog/spend-taxonomyObtener la taxonomía de gastos e ingresos - POST
/v1/catalog/resolveAsociar nombres con servicios del catálogo - GET
/v1/draftsListar borradores - POST
/v1/draftsCrear un borrador - GET
/v1/drafts/{draft_id}Obtener un borrador - PATCH
/v1/drafts/{draft_id}Actualizar un borrador - POST
/v1/drafts/{draft_id}/request-publishSolicitar la publicación - POST
/v1/drafts/{draft_id}/approveAprobar la publicación - GET
/v1/tagsListar las etiquetas de las tarjetas de la organización - POST
/v1/cards/archiveSubir un archivo comprimido de documentos - GET
/v1/archives/{job_id}Obtener un trabajo de extracción de un archivo comprimido - GET
/v1/cards/{card_id}/verificationObtener el bloque de verificación de una tarjeta - POST
/v1/cards/{card_id}/verification/verifyVerificar una tarjeta - POST
/v1/cards/{card_id}/verification/unverifyRetirar la confianza o enviar un recordatorio al verificador - PUT
/v1/cards/{card_id}/verification/verifiersEstablecer los verificadores de una tarjeta - PUT
/v1/cards/{card_id}/verification/intervalCambiar el tipo de verificación y la fecha límite - GET
/v1/verification/queueObtener la cola de verificación - GET
/v1/collections/{name}/trustObtener el «Trust Score» de una colección - GET
/v1/org/trustObtener el «Trust Score» de la organización - GET
/v1/announcementsListar los avisos - POST
/v1/announcementsEnviar un aviso de lectura obligatoria - GET
/v1/announcements/{announcement_id}Obtener un aviso - GET
/v1/announcements/{announcement_id}/statsObtener el informe de un aviso - POST
/v1/announcements/{announcement_id}/remindEnviar un recordatorio a quienes no han leído el aviso - GET
/v1/cards/{card_id}/threadsListar los hilos de comentarios de una tarjeta - POST
/v1/cards/{card_id}/threadsAñadir un comentario o una respuesta en un hilo - DELETE
/v1/cards/{card_id}/threads/{comment_id}Eliminar un comentario con sus respuestas - PATCH
/v1/cards/{card_id}/threads/{comment_id}Editar el texto, resolver o reabrir un hilo - GET
/v1/openapi-public.jsonObtener la especificación OpenAPI pública - GET
/v1/webhooksListar los webhooks de la organización - POST
/v1/webhooksCrear un webhook - GET
/v1/webhooks/catalogListar los tipos de evento - GET
/v1/webhooks/{webhook_id}Obtener un webhook - DELETE
/v1/webhooks/{webhook_id}Eliminar un webhook - PATCH
/v1/webhooks/{webhook_id}Actualizar un webhook - POST
/v1/webhooks/{webhook_id}/testEnviar un evento de prueba - POST
/v1/webhooks/{webhook_id}/rotate-secretRotar el secreto de firma - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretRevocar el secreto anterior - POST
/v1/webhooks/{webhook_id}/resumeReanudar un webhook - POST
/v1/webhooks/{webhook_id}/redeliverReenviar las entregas de un período - GET
/v1/webhooks/{webhook_id}/attemptsListar los intentos de entrega - GET
/v1/webhooks/{webhook_id}/deliveriesListar las entregas de un webhook - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Obtener una entrega con sus cuerpos e intentos - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverReenviar un evento - GET
/v1/webhook-eventsListar los eventos - GET
/v1/webhook-events/{event_id}Obtener un evento - GET
/v1/api-usageObtener el uso de la API - GET
/v1/api-logsListar las solicitudes a la API - GET
/v1/api-logs/{request_id}Obtener una solicitud a la API - GET
/v1/appsListar las aplicaciones OAuth - POST
/v1/appsCrear una aplicación OAuth - GET
/v1/apps/{app_id}Obtener una aplicación OAuth - DELETE
/v1/apps/{app_id}Eliminar una aplicación OAuth - PATCH
/v1/apps/{app_id}Actualizar una aplicación OAuth - POST
/v1/apps/{app_id}/rotate-secretRotar el secreto de cliente - GET
/v1/app-authorizationsListar las autorizaciones de las aplicaciones - DELETE
/v1/app-authorizations/{authorization_id}Revocar la autorización de un empleado - GET
/v1/analytics/healthObtener el panel de salud del conocimiento - GET
/v1/analytics/usageObtener el panel de uso - GET
/v1/analytics/contributionObtener el panel de contribución - GET
/v1/analytics/cards/{card_id}Obtener las métricas de una tarjeta - GET
/v1/audit/verifyVerificar la integridad del registro de auditoría de la organización - POST
/v1/users/importImportar usuarios desde CSV - GET
/v1/quality/gaps/followupsListar los vacíos de conocimiento en curso - POST
/v1/quality/gaps/followupsEmpezar a trabajar en un vacío de conocimiento - PATCH
/v1/quality/gaps/followups/{followup_id}Actualizar un vacío de conocimiento en curso - GET
/v1/access-requestsListar las solicitudes de acceso propias o recibidas - GET
/v1/access-requests/{request_id}Obtener una solicitud de acceso para la persona que decide - POST
/v1/access-requests/{request_id}/grantConceder acceso en respuesta a una solicitud - POST
/v1/access-requests/{request_id}/denyDenegar el acceso - POST
/v1/finance/reportObtener un informe financiero resumido - POST
/v1/finance/report/exportExportar el informe financiero resumido - POST
/v1/finance/invoicesListar las facturas - POST
/v1/finance/invoices/exportExportar la lista de facturas - POST
/v1/finance/paymentsListar los pagos - POST
/v1/finance/payments/exportExportar la lista de pagos - GET
/v1/sources/{source_id}/push-keysListar las claves de API de una fuente personalizada - POST
/v1/sources/{source_id}/push-keysCrear una clave de API para una fuente personalizada - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Revocar una clave de API de una fuente personalizada - GET
/v1/sources/{source_id}/push-syncsListar las sincronizaciones de una fuente personalizada - GET
/v1/push/sources/{source_id}Comprobar la clave y obtener el estado de una fuente personalizada - POST
/v1/push/sources/{source_id}/syncsAbrir una sincronización - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Obtener una sincronización - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsListar los resultados de los documentos de una sincronización - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeCerrar una sincronización - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchConfirmar documentos sin volver a enviarlos - POST
/v1/push/sources/{source_id}/documentsEnviar un documento (crear o reemplazar) - POST
/v1/push/sources/{source_id}/documents/batchEnviar un lote de documentos - GET
/v1/push/sources/{source_id}/documents/{external_id}Obtener el resultado de un documento - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Eliminar un documento