REST APIs FAQ

Our REST APIs FAQ provides answers to common questions about implementing and using Glean's APIs. For detailed implementation guidance, see our developer documentation.

When using the /indexdocument and /bulkindexdocuments endpoints, documents are added to a processing queue and are not indexed immediately. To expedite document indexing:

1. Use the /processalldocuments endpoint to schedule immediate processing
2. Verify document status using the get document information endpoint
3. Check permissions with the check document access endpoint if the document is indexed but not appearing in results

You have several options for document deletion:

1. Use the /deletedocument endpoint for individual documents
2. Use /bulkindexdocuments to remove documents not present in the upload
3. To delete all documents, use /bulkindexdocuments with an empty documents array and set disableStaleDocumentDeletionCheck to true

We maintain a public GitHub repository with example implementations for our APIs. You can find these examples in our indexing-api-connectors repository.

The Results Display options are not shown until object definitions are created for the data source. This is because you can customize the results display based on the object type. For more information on setting up object definitions, please refer to our documentation on custom properties.

Additional Resources

Developer Documentation

Access our comprehensive developer documentation for detailed API references and implementation guides.

Troubleshooting Guide

Find solutions to common API issues and implementation challenges.