retvest
Retvest/Developers

Retvest / Developers

Build with Retvest

Connect your application or terminal to the company’s Deploy environment.

SDK overview Request developer access

Choose your interface

SDK overview

Choose a client and connect to your Deploy environment.

Python SDK

Client setup, queries and error handling in Python.

TypeScript SDK

Typed client setup for JavaScript and TypeScript.

Retvest CLI

Sign in and work through the company server from a terminal.

API concepts

Authentication, streaming and Work Run records.

Python / Retvest clientInterface example
import os
from retvest_client import RetvestClient

client = RetvestClient(
    os.environ["RETVEST_API_URL"],
    api_key=os.environ["RETVEST_API_KEY"],
)

answer = client.query(
    "Summarise the approved sample policy.",
    top_k=5,
)

Interface example. Use the versioned package and connection details supplied for your pilot.

What you can connect

Build around
the company workflow

The SDKs connect to your Deploy installation. Match the interfaces below to the package and server contract supplied for your pilot.

Document questions
Send a question and retrieval options to the company API. Keep approved material, collection access and the displayed answer in the same application workflow.
Streamed answers
Consume source information and answer fragments as events. Keep a response incomplete until the stream reports successful completion.
RIL work records
Connect authorised record, correction and review workflows to Retvest Intelligence Layer. Record access and administrative actions depend on the user’s authority.
Terminal sessions
Sign in to the company server, use an interactive session or submit an explicit prompt. Local tool actions require the applicable permissions.

Your integration path

Start with the connection
Keep the boundaries clear

Read the SDK overview
  1. 01

    Get your deployment details

    Request the versioned client, company HTTPS address and API contract. The public website is not an inference endpoint.

  2. 02

    Choose the right authentication

    Use a scoped Retvest API key where supported. Session-owned Work Run administration needs an authorised user session.

  3. 03

    Connect approved sample material

    Keep credentials in your application’s secret configuration. Confirm the intended document collection and access with your company administrator.

  4. 04

    Handle outcomes explicitly

    Retain request IDs and bounded error details. Distinguish successful completion, interruption and a write whose outcome is uncertain.

Authentication & errors

Know the API contract

Read the query and streaming paths, operation-specific authentication, review versions and idempotency boundaries.

API concepts

Retvest Intelligence Layer

Understand the work record

Learn how context, activity, correction history and evidence relate to a Work Run, with access and retention defined for your organisation.

RIL guide

Retvest Deploy / Walkthroughs & pilots

See how Deploy fits
your business

Bring one workflow. We’ll discuss the environment, model and work record it needs.

Request a walkthrough What to expect