{
  "opencollection": "1.0.0",
  "info": {
    "name": "ZeroEntropy Admin Documents API",
    "version": "0.1.0"
  },
  "items": [
    {
      "info": {
        "name": "Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add Document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.zeroentropy.dev/v1/documents/add-document",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Adds a document to a given collection.\n\nA status code of `201 Created` will be returned if a document was successfully added. A status code of `409 Conflict` will be returned if the given collection already has a document with the same path.\n\nIf `overwrite` is given a value of `true`, then a status code of `200 OK` will be returned if a document was overwritten (Rather than a status code of `409 Conflict`).\n\nWhen a document is inserted, it can take time to appear in the index. Check the `/status"
        },
        {
          "info": {
            "name": "Update Document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.zeroentropy.dev/v1/documents/update-document",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Updates a document. This endpoint is atomic.\n\nCurrently both `metadata` and `index_status` are supported.\n\n- When updating with a non-null `metadata`, the document must have `index_status` of `indexed`. After this call, the document will have an `index_status` of `not_indexed`, since the document will need to reindex with the new metadata.\n- When updating with a non-null `index_status`, setting it to `not_parsed` or `not_indexed` requires that the document must have `index_status` of `parsing_fa"
        },
        {
          "info": {
            "name": "Get Document Info",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.zeroentropy.dev/v1/documents/get-document-info",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieves information about a specific document. The request parameters define what information you would like to receive.\n\nA `404 Not Found` will be returned if either the collection name does not exist, or the document path does not exist within the provided collection."
        },
        {
          "info": {
            "name": "Get Document Info List",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.zeroentropy.dev/v1/documents/get-document-info-list",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrives a list of document metadata information that matches the provided filters.\n\nThe documents returned will be sorted by path in lexicographically ascending order. `path_gt` can be used for pagination, and should be set to the path of the last document returned in the previous call.\n\nA `404 Not Found` will be returned if either the collection name does not exist, or the document path does not exist within the provided collection."
        },
        {
          "info": {
            "name": "Delete Document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.zeroentropy.dev/v1/documents/delete-document",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Deletes a document\n\nA `404 Not Found` status code will be returned, if the provided collection name or document path does not exist."
        },
        {
          "info": {
            "name": "Get Page Info",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.zeroentropy.dev/v1/documents/get-page-info",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieves information about a specific page. The request parameters define what information you would like to receive.\n\nA `404 Not Found` will be returned if either the collection name does not exist, or the document path does not exist within the provided collection."
        },
        {
          "info": {
            "name": "Get Document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zeroentropy.dev/v1/documents/get-document",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "query",
                "description": "The document token"
              }
            ]
          },
          "docs": "Get the document. The content will be the binary PDF/DOCX content, or be UTF-8-encoded content if it is text.\n\nA `404 Not Found` status code will be returned, if the provided request parameters do not exist.\n\nNote that if `/documents/update-document` returns a new document id, then all urls will be invalidated and must be retrieved again.\n\nThe HTTP cache policy on this endpoint is set to never expire, unlike other endpoints whose HTTP headers assert no-cache."
        },
        {
          "info": {
            "name": "Get Page Image",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zeroentropy.dev/v1/documents/get-page-image",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "query",
                "description": "The image token"
              }
            ]
          },
          "docs": "Get the image for a specific page. The image will be returned as a JPEG.\n\nThis endpoint is meant to be used with `<img>` tags in the frontend. A `404 Not Found` status code will be returned, if the provided request parameters do not exist or if the page exists but does not have an associated image.\n\nNote that if `/documents/update-document` returns a new document id, then all urls will be invalidated and must be retrieved again.\n\nThe HTTP cache policy on this endpoint is set to never expire, unl"
        }
      ]
    }
  ],
  "bundled": true
}