Glean documents API

The documents API from Glean — 3 operation(s) for documents.

OpenAPI Specification

glean-documents-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Glean Client REST activity documents API
  version: 0.9.0
  description: 'Subset of Glean''s Client REST API. Glean exposes search, chat, agents,

    answers, announcements, collections, documents, people, summarize,

    insights, recommendations, tools, governance, and verification endpoints

    against the customer''s Glean instance.


    Derived from the public OpenAPI definition published at

    https://gleanwork.github.io/open-api/specs/final/client_rest.yaml

    '
  contact:
    name: Glean Developers
    url: https://developers.glean.com/
servers:
- url: https://{instance}-be.glean.com/rest/api/v1
  description: Glean customer instance
  variables:
    instance:
      default: customer
      description: Glean instance subdomain
security:
- bearerAuth: []
tags:
- name: documents
paths:
  /getdocuments:
    post:
      tags:
      - documents
      summary: Retrieve document metadata by id or URL
      operationId: getDocuments
      responses:
        '200':
          description: OK
  /getdocumentsbyfacets:
    post:
      tags:
      - documents
      summary: Retrieve documents matching facets
      operationId: getDocumentsByFacets
      responses:
        '200':
          description: OK
  /getdocpermissions:
    post:
      tags:
      - documents
      summary: Get effective permissions for a document
      operationId: getDocPermissions
      responses:
        '200':
          description: OK
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Glean API token, passed as `Authorization: Bearer <token>`'