Getting Started

Getting started with Fixpoint

Fixpoint has a REST API that you can use with any language, and a Python SDK. (We're working on adding language-specific SDKs.)

We're working towards supporting every programming language, but for now we only support Python. You can install Fixpoint with pip:

pip install fixpoint

Create an organization API key at https://auth.fixpoint.co/org/api_keys/ (opens in a new tab)

Then make make an extraction request:

from fixpoint.client import FixpointClient
from fixpoint.client.types import CreateRecordExtractionRequest, CrawlUrlSource
 
client = FixpointClient(api_key="...")
 
extraction = client.extractions.record.create(
    CreateRecordExtractionRequest(
        workflow_id="my-workflow-id",
        source=CrawlUrlSource(crawl_url="https://fixpoint.co", depth=2, page_limit=3),
        questions=[
            "What is the product summary?",
            "What are the industries the business serves?",
            "What are the use-cases of the product?",
            "According to the privacy policy, what data is collected from users?",
        ],
    )
)
 
print(extraction.model_dump_json(indent=2))

What's next

Read the API overview for more info on the Python SDK and the RESTful HTTP APIs. Then dig into:

  • the extraction docs to learn more about how to use Fixpoint's extraction API
  • the parsing docs to learn how to turn HTML into LLM-ready text
  • the datasets docs to learn how to use Fixpoint's company + people datasets

If you just want to see more example code:

OverviewAPI Overview