Skip to main content
Pulse publishes SDKs generated from the OpenAPI specification in the Fern configuration. Use the SDKs when you want typed request objects, consistent authentication, multipart upload handling, and generated helpers for long-running endpoints.

​
Install

pip install pulse-python-sdk

​
Initialize A Client

import os
from pulse import Pulse

client = Pulse(api_key=os.environ["PULSE_API_KEY"])

​
First Request

from pulse import Pulse

client = Pulse(api_key="YOUR_API_KEY")

result = client.extract(
    file=open("document.pdf", "rb"),
)

print(result.extraction_id)
print(result.markdown)

​
Environment

By default, SDK requests go to: 
https://api.runpulse.com
For local testing or dedicated environments, pass the SDK environment/base URL option supported by your generated SDK version.

​
Working With Async Jobs

Many Pulse endpoints accept async: true. In Python, use async_ because async is a reserved keyword. 
job = client.extract(
    file=open("large-document.pdf", "rb"),
    async_=True,
)

status = client.jobs.get_job(job_id=job.job_id)

​
SDK And API Reference

The API reference is generated from the same public contract used for SDK generation. If a parameter appears in the endpoint reference, prefer the matching SDK field rather than constructing raw HTTP requests by hand.

API Quickstart

Parse your first document with code.

Endpoint Reference

Browse every public endpoint.

Chaining Steps

Connect Extract, Schema, Split, Tables, and Jobs.

Error Handling

Build resilient SDK integrations.