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

Index a document from an image and text content

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

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

Body Params

The request payload containing the image and text content 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.

image
object

Image data that can be provided as either a URL or base64 encoded data, but not both

string

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

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