TypeScript SDK for the Unstructured API

SDK Installation

NPM

npm install unstructured-client --include=dev

Yarn

yarn add unstructured-client --dev

Model Context Protocol (MCP) Server

npx -y --package unstructured-client -- mcp start --help

SDK Example Usage

Example

import{UnstructuredClient}from"unstructured-client";import{PartitionResponse}from"unstructured-client/sdk/models/operations";import{Strategy}from"unstructured-client/sdk/models/shared";import*asfsfrom"fs";constunstructuredClient=newUnstructuredClient({security:{apiKeyAuth:"YOUR_API_KEY",},});constfilename="./sample-file";constdata=fs.readFileSync(filename);unstructuredClient.general.partition({partitionParameters:{files:{content:data,fileName:filename,},strategy:Strategy.Auto,}}).then((res:PartitionResponse)=>{if(res.statusCode==200){console.log(res.elements);}}).catch((e)=>{console.log(e.statusCode);console.log(e.body);});

Change the base URL

constclient=newUnstructuredClient({serverURL:"http://localhost:8000",security:{apiKeyAuth:key,},});// ORconstclient=newUnstructuredClient({serverURL:"https://my-server-url",security:{apiKeyAuth:key,},});

Custom HTTP Client

import{UnstructuredClient}from"unstructured-client";import{HTTPClient}from"unstructured-client/lib/http";consthttpClient=newHTTPClient({// fetcher takes a function that has the same signature as native `fetch`.fetcher:(request)=>{returnfetch(request);}});httpClient.addHook("beforeRequest",(request)=>{constnextRequest=newRequest(request,{signal:request.signal||AbortSignal.timeout(5000)});nextRequest.headers.set("x-custom-header","custom value");returnnextRequest;});httpClient.addHook("requestError",(error,request)=>{console.group("Request Error");console.log("Reason:",`${error}`);console.log("Endpoint:",`${request.method}${request.url}`);console.groupEnd();});constsdk=newUnstructuredClient({httpClient:httpClient});

Retries

import{openAsBlob}from"node:fs";import{UnstructuredClient}from"unstructured-client";import{Strategy,VLMModelProvider,}from"unstructured-client/sdk/models/shared";constunstructuredClient=newUnstructuredClient();asyncfunctionrun(){constresult=awaitunstructuredClient.general.partition({partitionParameters:{chunkingStrategy:"by_title",files:awaitopenAsBlob("example.file"),splitPdfPageRange:[1,10,],strategy:Strategy.Auto,vlmModel:"gpt-4o",vlmModelProvider:VLMModelProvider.Openai,},},{retries:{strategy:"backoff",backoff:{initialInterval:1,maxInterval:50,exponent:1.1,maxElapsedTime:100,},retryConnectionErrors:false,},});console.log(result);}run();

import{openAsBlob}from"node:fs";import{UnstructuredClient}from"unstructured-client";import{Strategy,VLMModelProvider,}from"unstructured-client/sdk/models/shared";constunstructuredClient=newUnstructuredClient({retryConfig:{strategy:"backoff",backoff:{initialInterval:1,maxInterval:50,exponent:1.1,maxElapsedTime:100,},retryConnectionErrors:false,},});asyncfunctionrun(){constresult=awaitunstructuredClient.general.partition({partitionParameters:{chunkingStrategy:"by_title",files:awaitopenAsBlob("example.file"),splitPdfPageRange:[1,10,],strategy:Strategy.Auto,vlmModel:"gpt-4o",vlmModelProvider:VLMModelProvider.Openai,},});console.log(result);}run();

Splitting PDF by pages

client.general.partition({partitionParameters:{files:{content:data,fileName:filename,},// Set splitPdfPage parameter to false in order to disable splitting PDFsplitPdfPage:true,// Modify splitPdfConcurrencyLevel to change the limit of parallel requestssplitPdfConcurrencyLevel:10,},}};

Summary

Table of Contents

Requirements

Standalone functions

File uploads

Tip

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

• Node.js v20+: Since v20, Node.js comes with a nativeopenAsBlob function innode:fs.
• Bun: The nativeBun.file function produces a file handle that can be used for streaming file uploads.
• Browsers: All supported browsers return an instance to aFile when reading the value from an<input type="file"> element.
• Node.js v18: A file stream can be created using thefileFrom helper fromfetch-blob/from.js.

import{openAsBlob}from"node:fs";import{UnstructuredClient}from"unstructured-client";import{Strategy,VLMModelProvider,}from"unstructured-client/sdk/models/shared";constunstructuredClient=newUnstructuredClient();asyncfunctionrun(){constresult=awaitunstructuredClient.general.partition({partitionParameters:{chunkingStrategy:"by_title",files:awaitopenAsBlob("example.file"),splitPdfPageRange:[1,10,],strategy:Strategy.Auto,vlmModel:"gpt-4o",vlmModelProvider:VLMModelProvider.Openai,},});console.log(result);}run();

Debugging

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import{UnstructuredClient}from"unstructured-client";constsdk=newUnstructuredClient({debugLogger:console});

Maturity

Contributions

SDK Created bySpeakeasy