> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blockgence.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pedir una revisión (con el motor apagado queda «en cola» y lo declara)

> Pide una revisión de smart contracts para tu organización.

Valida que `repo` sea un repo público de GitHub y `commit` un hash completo, igual que la cola del motor. Responde
`201` con `{demo, note, audit_id, audit, queue}`: `audit` tiene la forma de una fila de `GET /v1/audit`, con
`run.state = "queued"` y `requested: true`.

**Mientras el motor de auditoría no está encendido en el servidor**, la revisión queda registrada «en cola» pero no
corre: `queue.state = "not_enqueued"`, `demo: true` y `note` lo dice. Sus secciones están vacías (no se llenan con
datos de ejemplo: serían hallazgos inventados sobre tu código). Con el motor encendido, se encola de verdad
(`queue.state = "enqueued"`).

Errores, con cuerpo `{"error":..., "detail":...}`: `400` `bad_repo`, `bad_commit`, `bad_level`, `bad_files`,
`spec_required` (el nivel `audit` parte de la especificación) o `spec_too_long`; `403 org_required` (una key sin
organización no pide revisiones); `409 too_many_queued` (50 revisiones en cola sin correr); `503 queue_unavailable`.
No cobra créditos.

**Costo:** 0 créditos.



## OpenAPI

````yaml /openapi.json post /v1/audit
openapi: 3.1.0
info:
  title: blockgence API
  description: >

    **blockgence** expone como API todo el motor de *blockchain intelligence*:

    rastreo de fondos (tracing), atribución de entidades y screening de riesgo

    explicable (glass-box), sobre múltiples chains EVM.


    ### Autenticación

    Todas las rutas `/v1/*` requieren una **API key**. Mandala en el header

    `X-API-Key: <key>` (o `Authorization: Bearer <key>`). La key te la entrega
    tu

    organización o el administrador. En esta página: **Authorize** → pegá la
    key, y cada

    «Try it out» → «Execute» es una request real, que se cobra igual que desde
    tu código.

    Las rutas de verificación de evidencia (`/v1/evidence/*`) son abiertas.


    ### Límites

    Cada tier tiene un **rate-limit por minuto** y una **cuota mensual de
    créditos**.

    Cada endpoint consume créditos según su costo (`/trace` es el más caro); el
    costo puede

    variar por método y sub-ruta. **Solo se cobran las respuestas exitosas
    (status < 400)**:

    una request que termina en error queda registrada con 0 créditos. Consultá
    tu consumo en

    tiempo real con `GET /v1/account`.


    ### Fallas de la fuente de datos

    Si la fuente de datos falla al leer lo que pediste, la respuesta es `503
    source_unavailable`

    (sin cobro), con la fuente, la chain, la consulta, el motivo y si conviene
    reintentar. Si

    falla un salto intermedio, la respuesta es 200 y lo declara en
    `degraded_sources` (y en el

    `coverage_gaps` del nodo o la arista): ahí, la ausencia de datos no es
    ausencia de movimientos.


    ### Chains soportadas

    `ethereum`, `bsc`, `polygon`, `arbitrum`, `base`, `optimism`; además `tron`
    (rastreo, ficha, fondeo, probe y tx: ver «Tron» en `docs/API.md`). Qué
    fuente sirve cada consulta y con qué límite está en `GET /v1/chains` (0
    créditos). Conocidas y no consultadas (valen en `/screening` y `/address`,
    donde la chain la define el formato de la address): `monero`, `bitcoin`,
    `litecoin`, `solana`.

    Cualquier otra chain es `400`: nunca se sustituye por Ethereum.
  contact:
    name: blockgence
    url: https://www.blockgence.com/
  version: 1.0.0
servers:
  - url: https://app.blockgence.com
    description: Producción
security: []
tags:
  - name: Platform
    description: >-
      Qué chains hay y qué puede servir cada una (registro y matriz de
      capacidades), con qué fuentes y con qué metodología. Costo: 0 créditos.
  - name: Tracking
    description: >-
      Rastreo del flujo de fondos y lecturas de una address o una tx: grafo
      bidireccional con consistencia temporal, fondeo, contrapartes, bridges,
      swaps, mixers, labels y datos on-chain.
  - name: Screening
    description: >-
      Screening de riesgo: ¿esta address es riesgosa? Recomendación
      allow/review/block, con las razones y su fuente.
  - name: Contracts
    description: Inspector de contratos y simulación de transacciones antes de firmar.
  - name: Tokens
    description: 'Ficha de un token: emisor, supply, holders y señales de riesgo.'
  - name: Compromise
    description: 'Vector de compromiso de una wallet robada: cómo se perdió el control.'
  - name: Incident
    description: >-
      Respuesta a incidentes: víctima, hack y estafa. Playbook, freeze de fondos
      en emisores, post-mortem y entregables.
  - name: Copilot
    description: >-
      Copiloto forense con IA: investigá en lenguaje natural, con narrativa
      citada (streaming SSE).
  - name: Cases
    description: >-
      Casos: guardar, compartir y exportar investigaciones, con su evidencia,
      actividad y anotaciones.
  - name: Permissions
    description: >-
      Approvals, delegaciones y firmas que dan acceso a los fondos de una
      address (ERC-20, Permit2, EIP-7702).
  - name: Guard
    description: >-
      Blockgence Guard: vigilancia activa de wallets y protocolos, con alertas
      por webhook y correo.
  - name: Travel Rule
    description: >-
      Travel Rule sin red: desafío de titularidad, contraparte, conciliación y
      validación de mensajes IVMS101.
  - name: Auditoría
    description: >-
      Auditoría de smart contracts: pedir una revisión, su estado y hallazgos,
      las addresses desplegadas y las notas del equipo.
  - name: Evidencia
    description: >-
      Verificación de la evidencia sellada: clave pública de firma y sellos de
      tiempo. Abiertas: no piden API key ni cobran.
  - name: Monero
    description: >-
      Ficha pública de una tx de Monero y prueba de pago XMR (tx key u
      OutProof/InProof), verificada localmente y sellada. Monero no publica
      remitentes ni montos: no se rastrea.
  - name: Account
    description: Tu consumo y límites (self-service).
  - name: Icons
    description: >-
      Logos de entidades para renderizar grafos en tu UI. Cache-first
      (TrustWallet, 1inch, favicons oficiales). Costo: 0 créditos.
  - name: Meta
    description: Health y estado operacional (sin auth).
paths:
  /v1/audit:
    post:
      tags:
        - Auditoría
      summary: Pedir una revisión (con el motor apagado queda «en cola» y lo declara)
      description: >-
        Pide una revisión de smart contracts para tu organización.


        Valida que `repo` sea un repo público de GitHub y `commit` un hash
        completo, igual que la cola del motor. Responde

        `201` con `{demo, note, audit_id, audit, queue}`: `audit` tiene la forma
        de una fila de `GET /v1/audit`, con

        `run.state = "queued"` y `requested: true`.


        **Mientras el motor de auditoría no está encendido en el servidor**, la
        revisión queda registrada «en cola» pero no

        corre: `queue.state = "not_enqueued"`, `demo: true` y `note` lo dice.
        Sus secciones están vacías (no se llenan con

        datos de ejemplo: serían hallazgos inventados sobre tu código). Con el
        motor encendido, se encola de verdad

        (`queue.state = "enqueued"`).


        Errores, con cuerpo `{"error":..., "detail":...}`: `400` `bad_repo`,
        `bad_commit`, `bad_level`, `bad_files`,

        `spec_required` (el nivel `audit` parte de la especificación) o
        `spec_too_long`; `403 org_required` (una key sin

        organización no pide revisiones); `409 too_many_queued` (50 revisiones
        en cola sin correr); `503 queue_unavailable`.

        No cobra créditos.


        **Costo:** 0 créditos.
      operationId: create_audit_v1_audit_post
      parameters:
        - name: X-Case-Id
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Case-Id
          description: >-
            Caso activo (opcional): el token de un caso que podés ver. La
            consulta queda en el registro de actividad de ese caso y resuelve
            también sus labels propias. Un caso que no existe, se borró o ya no
            está compartido con vos da `400 case_unavailable` y la consulta no
            se hace (sin cobro).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuditCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '401':
          description: Falta la API key o es inválida o revocada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Cuota mensual de créditos agotada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: >-
            Rate limit por minuto superado. Reintentá después de `Retry-After`
            segundos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - APIKeyHeader: []
        - BearerAuth: []
components:
  schemas:
    AuditCreate:
      properties:
        repo:
          type: string
          title: Repo
          description: >-
            Repo público de GitHub: `https://github.com/<dueño>/<repo>`. Subir
            un zip todavía no se acepta.
        commit:
          type: string
          title: Commit
          description: >-
            Hash completo del commit (40 hex). Todo el informe refiere a ese
            hash.
        level:
          anyOf:
            - type: string
            - type: 'null'
          title: Level
          description: >-
            Nivel (D03): `automated` (Revisión automática), `assisted` (Revisión
            asistida) o `audit` (Auditoría, con un humano; pide `spec`).
          default: automated
        files:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Files
          description: >-
            Archivos en alcance: caminos o patrones relativos al repo; con `!`
            adelante excluye. Default: `src/**/*.sol` sin tests, scripts ni
            `lib/`.
        spec:
          anyOf:
            - type: string
            - type: 'null'
          title: Spec
          description: >-
            Especificación o README de diseño (opcional; obligatoria en
            `audit`), hasta 50,000 caracteres.
        project:
          anyOf:
            - type: string
            - type: 'null'
          title: Project
          description: 'Nombre del proyecto para el dashboard. Default: el nombre del repo.'
      type: object
      required:
        - repo
        - commit
      title: AuditCreate
    Error:
      type: object
      title: Error
      description: >-
        Forma de todos los errores: un `detail` legible. Algunos agregan
        `error`, un código estable para reconocerlo sin leer el texto
        (`case_unavailable`, `case_read_only`, …).
      properties:
        detail:
          type: string
          description: Qué pasó, en una frase.
        error:
          type: string
          description: Código estable del error, cuando lo tiene.
      required:
        - detail
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: Tu API key en el header `X-API-Key`.
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        La misma API key en `Authorization: Bearer <key>` (alternativa a
        `X-API-Key`).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.