MOmorphik-org
Ingestion

Query Document

Changed on

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

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/ingest/document/query
  • Auth
    none declared

Headers

authorizationstring nullable

Request body multipart/form-data

filestring binary required
promptstring required
response_schemastring nullable
ingestion_optionsstring

Response

Successful Response

structured_outputunknown
extracted_metadataobject nullable

Structured output coerced to metadata when possible

text_outputstring nullable

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

ingestion_enqueuedboolean

True when the document was queued for ingestion after extraction

input_metadataobject

Original metadata supplied alongside the request

combined_metadataobject

Metadata that would be used if ingestion is performed

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

    • 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