API Reference

Index Document

post
https://api.locusive.com/v1/documents

This endpoint accepts a document or document snippet and adds it to the index for use as a trusted source of information for queries or chats.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The name of the document or document snippet. While this is not required, it is strongly recommended to provide a name for each document or snippet.

string

A short summary or description of the content in the text field

url

The URI/URL to associate with a document or snippet. If this is provided but no text is provided, Locusive's system will download and parse the content at the provided URI/URL. Only public webpages and PDFs are supported (i.e. the system will throw an error if you give it a URL for a Google Doc, Google Sheet, etc).

string

The actual content of the document for indexing. Either this or the uri field must be provided.

Responses

400

Bad request

403

Permission denied

500

Internal error

Updated about 1 year ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 year ago