{
  "opencollection": "1.0.0",
  "info": {
    "name": "Client SDK subpackage_documents API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Upload",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://predict.vellum.ai/v1/upload-document",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "add_to_index_names",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "external_id",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "label",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "contents",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "url",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "keywords",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "metadata",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Upload a document to be indexed and used for search.\n\n**Note:** Uses a base url of `https://documents.vellum.ai`.\n"
        },
        {
          "info": {
            "name": "Retrieve",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://predict.vellum.ai/v1/documents/:id",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a Document, keying off of either its Vellum-generated ID or its external ID."
        },
        {
          "info": {
            "name": "Partial Update",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://predict.vellum.ai/v1/documents/:id",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "label",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "status",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "keywords",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "metadata",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Update a Document, keying off of either its Vellum-generated ID or its external ID. Particularly useful for updating its metadata."
        },
        {
          "info": {
            "name": "Destroy",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://predict.vellum.ai/v1/documents/:id",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a Document, keying off of either its Vellum-generated ID or its external ID."
        },
        {
          "info": {
            "name": "List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://predict.vellum.ai/v1/documents",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "document_index_id",
                "value": "",
                "type": "query",
                "description": "Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The initial index from which to return the results."
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "Which field to use when ordering the results."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search term."
              }
            ]
          },
          "docs": "Used to list documents. Optionally filter on supported fields."
        }
      ]
    }
  ],
  "bundled": true
}