ExtractionRequestResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/pepbank-io/json-schema/pepbank-io-extraction-request-result-schema.json",
  "title": "ExtractionRequestResult",
  "description": "Result of a request to extract and check findings from one paper.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pepbank-io-contribute-api-openapi.yml#/components/schemas/ExtractionRequestResult",
  "type": "object",
  "properties": {
    "credit": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string",
          "enum": [
            "Data from PepBank"
          ]
        },
        "line": {
          "type": "string",
          "description": "Credit sentence. Copy it as written."
        },
        "url": {
          "type": "string",
          "format": "uri",
          "description": "PepBank page for this result. The home page applies when no single page fits."
        },
        "license_url": {
          "type": "string",
          "enum": [
            "https://creativecommons.org/licenses/by/4.0/"
          ]
        }
      },
      "required": [
        "text",
        "url",
        "license_url"
      ]
    },
    "record_type": {
      "type": "string",
      "enum": [
        "extraction_request"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "queued",
        "already_queued",
        "already_extracted"
      ]
    },
    "queue_item_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "publication_ref": {
      "type": "object",
      "properties": {
        "publication_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "pmid": {
          "type": [
            "string",
            "null"
          ]
        },
        "pmcid": {
          "type": [
            "string",
            "null"
          ]
        },
        "doi": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "publication_id",
        "pmid",
        "pmcid",
        "doi"
      ]
    },
    "peptide_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "reason": {
      "type": "string",
      "enum": [
        "user_request"
      ]
    },
    "requested_at": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "usage": {
      "type": "object",
      "properties": {
        "units_charged": {
          "type": "number",
          "minimum": 0,
          "description": "Units that this request used."
        },
        "meter": {
          "type": "string",
          "enum": [
            "query",
            "live_lookups",
            "chat_messages",
            "exports"
          ],
          "description": "Meter that counted this request."
        },
        "remaining": {
          "type": [
            "number",
            "null"
          ],
          "description": "Units left in the current window. Null means no limit."
        },
        "window_resets_at": {
          "type": [
            "string",
            "null"
          ],
          "description": "When the current window ends (ISO 8601)."
        }
      },
      "required": [
        "units_charged",
        "meter",
        "remaining",
        "window_resets_at"
      ],
      "description": "Usage of this request. REST also sends these values in RateLimit headers."
    }
  },
  "required": [
    "credit",
    "record_type",
    "status",
    "queue_item_id",
    "publication_ref",
    "peptide_ids",
    "reason",
    "requested_at",
    "message",
    "usage"
  ]
}