Skip to main content
GET
/
v2
/
databases
List Databases
curl --request GET \
  --url https://api.jelou.ai/v2/databases \
  --header 'Authorization: Basic <encoded-value>'
{
  "message": [
    "<string>"
  ],
  "statusMessage": "<string>",
  "status": 123,
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "slug": "<string>",
      "driver": "<string>",
      "description": "<string>",
      "companyId": 123,
      "schema": {},
      "state": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
La estructura del esquema es clave para validar los datos antes de insertar o consultar registros desde tus flujos y skills.

​
Descripción

La API de Datum te permite consultar las bases de datos disponibles en Jelou y acceder a su estructura y metadatos.
Es útil para listar esquemas, validar campos y preparar operaciones de lectura o escritura desde tus flujos.

​
Obtener bases de datos

​
Endpoint

GET https://api.jelou.ai/v2/databases

​
Parámetros de consulta

​
shouldPaginate
string
Define si los resultados deben devolverse de forma paginada.

​
Respuestas

  • 200 – OK Solicitud exitosa.
  • 401 – Unauthorized Credenciales inválidas o faltantes.
  • 500 – Internal Server Error Error interno del servidor.

​
\

Ejemplo de respuesta
{
  "message": ["¡Bases de datos recuperadas exitosamente!"],
  "statusMessage": "success",
  "status": 1,
  "data": [
    {
      "id": 123456789,
      "name": "JELOU TEST",
      "slug": "jeloutest",
      "driver": "elastic",
      "description": "JELOU TEST",
      "companyId": 135,
      "schema": {
        "type": "object",
        "properties": {
          "total": { "type": "string", "database": "text" },
          "name": { "type": "string", "database": "text" }
        },
        "required": ["total", "name"]
      }
    }
  ]
}

​
Estructura de la base de datos

Cada base de datos en Datum está compuesta por los siguientes atributos:
PropiedadTipoDescripción
idstringIdentificador único de la base de datos.
namestringNombre de la base de datos.
descriptionstringDescripción funcional de la base de datos.
schemaobjectEsquema que define los campos y tipos de datos.
statebooleanEstado de la base de datos. true = activa, false = eliminada.
createdAtdateFecha de creación.
updatedAtdateFecha de última actualización.
columnsarrayColumnas visibles en Datum, con nombre, descripción y orden.
metadataarrayMetadatos adicionales asociados a la base de datos.

​
Estructura del esquema

Define la forma y validaciones de los datos almacenados.
PropiedadTipoDescripción
typestringTipo de esquema (normalmente object).
requiredarrayCampos obligatorios al insertar un registro.
propertiesobjectCada propiedad representa un campo y su tipo de dato.

​
Obtener información de una base de datos específica

​
Endpoint

GET https://api.jelou.ai/v2/databases/DATABASE_ID

​
Parámetros de ruta

​
DATABASE_ID
string
required
Identificador único de la base de datos.

​
Respuestas

  • 200 – OK Base de datos encontrada.
  • 401 – Unauthorized No autorizado.
  • 404 – Not Found Base de datos no encontrada.
  • 500 – Internal Server Error Error interno del servidor.

​
Ejemplo de respuesta

{
  "message": ["¡Base de datos recuperada exitosamente!"],
  "statusMessage": "success",
  "status": 1,
  "data": {
    "id": 123456789,
    "name": "JELOU TEST",
    "slug": "jeloutest",
    "schema": {
      "type": "object",
      "properties": {
        "total": { "type": "string", "database": "text" },
        "name": { "type": "string", "database": "text" }
      },
      "required": ["total", "name"]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication using Base64 encoded clientId:clientSecret

Query Parameters

​
shouldPaginate
string

Response

Databases retrieved

​
message
string[]
​
statusMessage
string
​
status
integer
​
data
object[]