Class LlamaParse

LlamaParse client for converting PDF documents to markdown

Example

const parser = new LlamaParse({ apiKey: 'your-api-key' });
const result = await parser.parseFile(file);
console.log(result.markdown);

Index

Constructors

Methods

checkStatus getMarkdownResult parseFile uploadFile

Constructors

constructor

new LlamaParse(config: LlamaParseConfig): LlamaParse
Create a new LlamaParse instance
Parameters
- config: LlamaParseConfig
  Configuration options for LlamaParse
Returns LlamaParse
Throws
If API key is not provided
- Defined in index.ts:50

Methods

checkStatus

checkStatus(jobId: string): Promise<JobStatus>
Check the status of a parsing job
Parameters
- jobId: string
  ID of the job to check
Returns Promise<JobStatus>
Promise containing the job status

Throws
If status check fails
- Defined in index.ts:112

getMarkdownResult

getMarkdownResult(jobId: string): Promise<MarkdownResult>
Get the markdown result for a completed job
Parameters
- jobId: string
  ID of the completed job
Returns Promise<MarkdownResult>
Promise containing the markdown result

Throws
If retrieval fails
- Defined in index.ts:130

parseFile

parseFile(file: File | Blob): Promise<MarkdownResult>
Parse a PDF file and convert it to markdown
Parameters
- file: File | Blob
  File or Blob to parse
Returns Promise<MarkdownResult>
Promise containing the markdown result and metadata
- Defined in index.ts:66

uploadFile

uploadFile(file: File | Blob): Promise<string>
Upload a PDF file to start the parsing process
Parameters
- file: File | Blob
  File or Blob to upload
Returns Promise<string>
Promise containing the job ID

Throws
If upload fails
- Defined in index.ts:88