MOmorphik-org

Search Documents By Name

Changed on

Search documents by filename using full-text search.

request.filters accepts the same operator set as /retrieve/chunks: $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $exists, $type, $regex (with optional i flag), $contains, and the logical operators $and, $or, $nor, $not. Comparison clauses honor typed metadata (number, decimal, datetime, date).

post/search/documents

Request

  • Base URL
    https://api.morphik.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.morphik.ai/search/documents
  • Auth
    none declared

Headers

authorizationstring nullable

Request body

querystring required

Search query for document names/filenames

limitinteger

Number of documents to return

filtersobject nullable

Optional metadata filters for documents

folder_depthinteger nullable

Folder scope depth: 0/None exact, -1 all descendants, n>0 include descendants up to n levels.

end_user_idstring nullable

Optional end-user scope for the search

Response

Successful Response

external_idstring
content_typestring required
filenamestring nullable
metadataobject
metadata_typesobject
storage_infoobject
system_metadataobject
additional_metadataobject
chunk_idsstring[]
summary_storage_keystring nullable
summary_versioninteger nullable
summary_bucketstring nullable
summary_updated_atstring nullable
folder_namestring nullable
end_user_idstring nullable
app_idstring nullable
folder_pathstring nullable
folder_idstring nullable

Changes

  • 2d9291c3821dRevision changes
    • info

      header request parameter authorization list-of-types was widened by adding types null

    • info

      for the header request parameter authorization, the type was generalized from string to no type

  • 4b79c3821a17Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status