Documentación

Referencia de API

Obtener contrato de herramienta

GET/v1/tools/{id}

Admite flat constante por llamada, input precalculado por entradas y usage según uso final. pricing.quote_required determina si se exige cotización; requires_usage, si se exige límite de coste y uso final confirmado. Ninguno se deduce de schema_version. Con metered_pricing apagado solo se restringen llamadas nuevas que requieren uso final; reglas constantes/por entrada sin ese requisito siguen disponibles. La clave actual necesita autorización de herramientas; identidad y resultados quedan limitados a la clave original. Con el interruptor general apagado el catálogo está vacío; el catálogo anónimo no autoriza la ejecución.

Autenticación y permisos

Usa tu clave actual de GloopAPI. Los modelos, capacidades y permisos dependen de su catálogo y de la documentación del endpoint.

Authorization: Bearer $GLOOP_API_KEY

Esquemas de autenticación: BearerAuth

Solicitud

Parámetros de ruta

  • idstringObligatorio

    ID de herramienta del catálogo o ejecución original, según objeto de la operación.

Parámetros de consulta

  • versionstringOpcional

    Omitir usa la versión actual; crear exige especificar la versión del catálogo.

Respuestas y errores

HTTP 200

Contrato de herramienta obtenido correctamente

application/json

Tipo
object
Campos obligatorios
category_idcollection_idtagsidnamedescriptionversionpricinginput_schemaoutput_schemaread_only
  • category_idstringObligatorio

    Identificador de categoría de herramienta.

  • collection_idstringObligatorio

    Identificador de colección de herramientas.

  • tagsarrayObligatorio

    Etiquetas públicas de búsqueda.

    Campos secundarios de tags (1)
    • []stringOpcional
  • idstringObligatorio

    Identificador público del objeto, usado en su ruta de detalles.

  • namestringObligatorio

    Nombre legible para el usuario.

  • descriptionstringObligatorio

    Descripción pública del uso.

  • versionstringObligatorio

    Versión de contrato/capacidad o herramienta; la ejecución usa la versión del catálogo.

  • pricingobjectObligatorio

    Precio público; se aplican las cotizaciones y reglas de facturación vigentes.

    Campos secundarios de pricing (9)
    • schema_versionintegerOpcional

      Versión de reglas de precios de herramienta.

    • ruleunknownOpcional

      Valor JSON definido por esquema o protocolo de la herramienta; sin campos fijos supuestos.

    • quote_requiredbooleanObligatorio

      Si las nuevas ejecuciones deben confirmar cotización antes.

    • currencystringObligatorio

      Moneda de cotización/facturación.

    • unitstringObligatorio

      call: por llamada o precálculo según entradas; usage: según uso final. Consulta mode para la semántica exacta.

    • amountstringOpcional

      En mode=flat, importe constante completo en USD, incluido cero; input/usage no exponen importes constantes engañosos.

    • price_versionintegerObligatorio

      Revisión del precio de venta.

    • modestringObligatorio

      Semántica de venta: flat constante por llamada, input precalculado por entradas, usage por uso final; independiente del formato schema_version.

      Enumeración
      ["flat","input","usage"]
    • requires_usagebooleanObligatorio

      Si liquidar exige uso confirmado, incluidas restricciones de plataforma; no lo deduzcas solo del mode de venta.

    Rama allOf 1

    Tipo: object

    Obligatorio en esta rama: currency, unit, price_version, mode, quote_required, requires_usage

    • schema_versionintegerOpcional

      Versión de reglas de precios de herramienta.

    • ruleunknownOpcional

      Valor JSON definido por esquema o protocolo de la herramienta; sin campos fijos supuestos.

    • quote_requiredbooleanObligatorio

      Si las nuevas ejecuciones deben confirmar cotización antes.

    • currencystringObligatorio

      Moneda de cotización/facturación.

    • unitstringObligatorio

      call: por llamada o precálculo según entradas; usage: según uso final. Consulta mode para la semántica exacta.

    • amountstringOpcional

      En mode=flat, importe constante completo en USD, incluido cero; input/usage no exponen importes constantes engañosos.

    • price_versionintegerObligatorio

      Revisión del precio de venta.

    • modestringObligatorio

      Semántica de venta: flat constante por llamada, input precalculado por entradas, usage por uso final; independiente del formato schema_version.

      Enumeración
      ["flat","input","usage"]
    • requires_usagebooleanObligatorio

      Si liquidar exige uso confirmado, incluidas restricciones de plataforma; no lo deduzcas solo del mode de venta.

  • input_schemaunknownObligatorio

    Valor JSON definido por esquema o protocolo de la herramienta; sin campos fijos supuestos.

  • output_schemaunknownObligatorio

    Valor JSON definido por esquema o protocolo de la herramienta; sin campos fijos supuestos.

  • read_onlybooleanObligatorio

    Propiedad de solo lectura declarada en el contrato público; no garantiza gratuidad ni exención de autorización.

HTTP 400

Campos o parámetros de solicitud inválidos.

application/json

Tipo
object
Campos obligatorios
error

HTTP 401

La clave falta, no es válida, caducó o fue revocada.

application/json

Tipo
object
Campos obligatorios
error

HTTP 403

Permisos insuficientes de IP, cuenta, modelo o herramienta.

application/json

Tipo
object
Campos obligatorios
error

HTTP 404

Objeto/capacidad no disponible o función desactivada.

application/json

Tipo
object
Campos obligatorios
error

HTTP 409

Conflicto de idempotencia/cotización, objeto no preparado o aún referenciado.

application/json

Tipo
object
Campos obligatorios
error

HTTP 429

Límite de solicitudes/cola.

application/json

Tipo
object
Campos obligatorios
error

HTTP 500

Fallo interno de autenticación o almacenamiento de datos.

application/json

Tipo
object
Campos obligatorios
error

HTTP 503

Servicio, precios o almacenamiento no disponibles.

application/json

Tipo
object
Campos obligatorios
error