JavaScript
import Morphik from 'morphik';
const client = new Morphik({
apiKey: process.env['MORPHIK_API_KEY'], // This is the default and can be omitted
});
const response = await client.ingest.documentQuery({
file: fs.createReadStream('path/to/file'),
prompt: 'prompt',
});
console.log(response.combined_metadata);curl https://api.morphik.ai/ingest/document/query \
-H 'Content-Type: multipart/form-data' \
-H "Authorization: Bearer $MORPHIK_API_KEY" \
-F 'file=@/path/to/file' \
-F prompt=prompt{
"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": {},
"system_metadata": {},
"additional_metadata": {},
"chunk_ids": [
"<string>"
],
"summary_storage_key": "<string>",
"summary_version": 123,
"summary_bucket": "<string>",
"summary_updated_at": "<string>",
"folder_name": "<string>",
"end_user_id": "<string>",
"app_id": "<string>",
"folder_path": "<string>",
"folder_id": "<string>"
},
"input_metadata": {},
"combined_metadata": {},
"ingestion_options": {
"ingest": false,
"use_colpali": false,
"folder_name": "<string>",
"end_user_id": "<string>",
"metadata": {}
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Ingestion
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
JavaScript
import Morphik from 'morphik';
const client = new Morphik({
apiKey: process.env['MORPHIK_API_KEY'], // This is the default and can be omitted
});
const response = await client.ingest.documentQuery({
file: fs.createReadStream('path/to/file'),
prompt: 'prompt',
});
console.log(response.combined_metadata);curl https://api.morphik.ai/ingest/document/query \
-H 'Content-Type: multipart/form-data' \
-H "Authorization: Bearer $MORPHIK_API_KEY" \
-F 'file=@/path/to/file' \
-F prompt=prompt{
"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": {},
"system_metadata": {},
"additional_metadata": {},
"chunk_ids": [
"<string>"
],
"summary_storage_key": "<string>",
"summary_version": 123,
"summary_bucket": "<string>",
"summary_updated_at": "<string>",
"folder_name": "<string>",
"end_user_id": "<string>",
"app_id": "<string>",
"folder_path": "<string>",
"folder_id": "<string>"
},
"input_metadata": {},
"combined_metadata": {},
"ingestion_options": {
"ingest": false,
"use_colpali": false,
"folder_name": "<string>",
"end_user_id": "<string>",
"metadata": {}
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Body
multipart/form-data
Response
Successful Response
Response model for document query with optional ingestion follow-up.
Was this page helpful?

