Query Document

Execute a one-off analysis for a document using Morphik On-the-Fly, optionally enforcing structured output and scheduling a follow-up ingestion.

ingestion_options is a JSON string controlling post-analysis ingestion behaviour via keys such as ingest, metadata, use_colpali, folder_name, and end_user_id. Additional keys are ignored. A :class:DocumentQueryResponse describing the inline analysis and any queued ingestion is returned.

POST /ingest/document/query

Try it

JavaScript

JavaScript

import Morphik from 'morphik';

const client = new Morphik({
  apiKey: 'My API Key',
});

const response = await client.ingest.documentQuery({
  file: fs.createReadStream('path/to/file'),
  prompt: 'prompt',
});

console.log(response.combined_metadata);

200

{
  "structured_output": "<unknown>",
  "extracted_metadata": {},
  "text_output": "<string>",
  "ingestion_enqueued": false,
  "ingestion_document": {
    "content_type": "<string>",
    "external_id": "<string>",
    "filename": "<string>",
    "metadata": {},
    "metadata_types": {},
    "storage_info": {},
    "storage_files": [
      {
        "bucket": "<string>",
        "key": "<string>",
        "version": 1,
        "filename": "<string>",
        "content_type": "<string>",
        "timestamp": "2023-11-07T05:31:56Z"
      }
    ],
    "system_metadata": {},
    "additional_metadata": {},
    "chunk_ids": [
      "<string>"
    ],
    "folder_name": "<string>",
    "end_user_id": "<string>",
    "app_id": "<string>"
  },
  "input_metadata": {},
  "combined_metadata": {},
  "ingestion_options": {}
}

Headers

authorization · string

Body

multipart/form-data

file · file · required

prompt · string · required

schema · string | null

ingestion_options · string · default: {}

Response

200

application/json

Successful Response

Response model for document query with optional ingestion follow-up.

structured_output · any | null

Raw structured output returned from Morphik On-the-Fly (may be list/dict)

extracted_metadata · Extracted Metadata · object

Structured output coerced to metadata when possible

text_output · string | null

Raw text returned from Morphik On-the-Fly when no schema is provided

ingestion_enqueued · boolean · default: false

True when the document was queued for ingestion after extraction

ingestion_document · Document · object

Queued document stub when ingestion_enqueued is true

Show child attributes

ingestion_document. content_type · string · required

ingestion_document. external_id · string

ingestion_document. filename · string | null

ingestion_document. metadata · Metadata · object

ingestion_document. metadata_types · Metadata Types · object

Show child attributes

ingestion_document.metadata_types. {key} · string

ingestion_document. storage_info · Storage Info · object

ingestion_document. storage_files · StorageFileInfo · object[]

Show child attributes

ingestion_document.storage_files. bucket · string · required

ingestion_document.storage_files. key · string · required

ingestion_document.storage_files. version · integer · default: 1

ingestion_document.storage_files. filename · string | null

ingestion_document.storage_files. content_type · string | null

ingestion_document.storage_files. timestamp · string<date-time>

ingestion_document. system_metadata · System Metadata · object

ingestion_document. additional_metadata · Additional Metadata · object

ingestion_document. chunk_ids · string[]

ingestion_document. folder_name · string | null

ingestion_document. end_user_id · string | null

ingestion_document. app_id · string | null

input_metadata · Input Metadata · object

Original metadata supplied alongside the request

combined_metadata · Combined Metadata · object

Metadata that would be used if ingestion is performed

ingestion_options · Ingestion Options · object

Normalized ingestion options applied to this request