doc2json

Return the workspace and token for the bearer credential, and the credits left this month.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Extract invoice fields from a PDF, PNG, JPEG, or text file sent as base64 in file_base64, or from plain text sent in text (10 MB and 10 pages on Free, 25 MB and 50 pages on paid). 1 credit per page; an image is 1 page; text is 1 credit per 3,000 characters. Nothing is stored. Send exactly one of file_base64 or text. The result has status and values. Set citations to true to also get, for each value, the page, the printed text, and a box where it was read.

{
  "type": "object",
  "properties": {
    "schema": {
      "description": "The name of a schema saved in this workspace, or a literal schema object. A schema is {\"type\":\"object\",\"properties\":{...}}. Each property is {\"type\":T} where T is one of any, null, boolean, string, number, date, array, object. An optional description, at most 400 characters, tells the model how to read that field. An optional required array lists the keys that must be present. A date is a string yyyy-mm-dd. An array adds \"items\" (one node). An object adds \"properties\" and may add \"required\". At most 4 levels below the root, 100 keys, and 16384 bytes.",
      "oneOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 80,
          "pattern": "^[a-z0-9_-]+$",
          "description": "Lowercase letters, digits, underscores, and hyphens. No spaces."
        },
        {
          "type": "object",
          "description": "A schema is {\"type\":\"object\",\"properties\":{...}}. Each property is {\"type\":T} where T is one of any, null, boolean, string, number, date, array, object. An optional description, at most 400 characters, tells the model how to read that field. An optional required array lists the keys that must be present. A date is a string yyyy-mm-dd. An array adds \"items\" (one node). An object adds \"properties\" and may add \"required\". At most 4 levels below the root, 100 keys, and 16384 bytes."
        }
      ]
    },
    "file_base64": {
      "type": "string",
      "description": "Base64-encoded PDF, PNG, JPEG, or UTF-8 text file (.txt, .md, .csv, .eml). At most 10 MB and 10 pages on Free, 25 MB and 50 pages on paid plans. Each page costs 1 credit; an image is 1 page; text is 1 credit per 3,000 characters. The bytes are not stored. Send this or text, not both."
    },
    "text": {
      "type": "string",
      "description": "The document as plain text, for example a pasted invoice or email. 1 credit per 3,000 characters (started), at least 1. At most 30,000 characters on Free and 150,000 on paid plans. The text is not stored. Send this or file_base64, not both."
    },
    "citations": {
      "type": "boolean",
      "description": "When true, the result also has citations: for each value's path, the page, the printed text it was read from, a box [x0, y0, x1, y1] on the page (0 to 1 from the top left), and a status saying whether the text was found in the document. Same credits. Default false."
    }
  },
  "additionalProperties": false
}

List the extraction schemas saved in this workspace.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Read one saved extraction schema by name.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "pattern": "^[a-z0-9_-]+$",
      "description": "Lowercase letters, digits, underscores, and hyphens. No spaces."
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Save a named extraction schema in this workspace. A schema is {"type":"object","properties":{...}}. Each property is {"type":T} where T is one of any, null, boolean, string, number, date, array, object. An optional description, at most 400 characters, tells the model how to read that field. An optional required array lists the keys that must be present. A date is a string yyyy-mm-dd. An array adds "items" (one node). An object adds "properties" and may add "required". At most 4 levels below the root, 100 keys, and 16384 bytes.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "pattern": "^[a-z0-9_-]+$",
      "description": "Lowercase letters, digits, underscores, and hyphens. No spaces."
    },
    "schema": {
      "type": "object",
      "description": "A schema is {\"type\":\"object\",\"properties\":{...}}. Each property is {\"type\":T} where T is one of any, null, boolean, string, number, date, array, object. An optional description, at most 400 characters, tells the model how to read that field. An optional required array lists the keys that must be present. A date is a string yyyy-mm-dd. An array adds \"items\" (one node). An object adds \"properties\" and may add \"required\". At most 4 levels below the root, 100 keys, and 16384 bytes."
    }
  },
  "required": [
    "name",
    "schema"
  ],
  "additionalProperties": false
}

Rename a saved schema, replace its definition, or both. A schema is {"type":"object","properties":{...}}. Each property is {"type":T} where T is one of any, null, boolean, string, number, date, array, object. An optional description, at most 400 characters, tells the model how to read that field. An optional required array lists the keys that must be present. A date is a string yyyy-mm-dd. An array adds "items" (one node). An object adds "properties" and may add "required". At most 4 levels below the root, 100 keys, and 16384 bytes.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "pattern": "^[a-z0-9_-]+$",
      "description": "The current name."
    },
    "newName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "pattern": "^[a-z0-9_-]+$",
      "description": "Lowercase letters, digits, underscores, and hyphens. No spaces."
    },
    "schema": {
      "type": "object",
      "description": "A schema is {\"type\":\"object\",\"properties\":{...}}. Each property is {\"type\":T} where T is one of any, null, boolean, string, number, date, array, object. An optional description, at most 400 characters, tells the model how to read that field. An optional required array lists the keys that must be present. A date is a string yyyy-mm-dd. An array adds \"items\" (one node). An object adds \"properties\" and may add \"required\". At most 4 levels below the root, 100 keys, and 16384 bytes."
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}