API Reference
Feedback, roadmap, & changelog
Start typing to search…

Index a document from text content

post
https://api.ducky.ai/v1/documents/index-text

Index a document into the specified index by providing the content as a JSON object.

Body Params

The request payload containing the text content and metadata to be indexed.

string
required

The name of the index to add the document to

string

The ID of the document. If not provided, a unique document ID will be automatically generated by the server.

string
required
length ≥ 1

The text content of the document to be indexed

string

Title of the document to be indexed

string

URL associated with the document to be indexed

string

The ID of the file. If not provided, a unique file ID will be automatically generated by the server

metadata
object

Metadata associated with the document. Accepts key value pairs where the value can be a string, number, boolean, or list of strings.

Responses

Updated 7 months ago

Language
Credentials
Header
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago