Choose your integration surface
The Retvest developer surfaces are the Python client, TypeScript client and Retvest terminal. They connect to your company’s Deploy environment; the website is not an inference API.
- Python:
retvest-client, imported asretvest_client, for Python applications and scripts. - TypeScript:
@retvest/client, for typed JavaScript and TypeScript integrations. - Terminal:
retvest, for employee terminal sessions and permitted administration.
Get the matching package
Use the versioned SDK package and connection details supplied for your Deploy pilot. Ask for developer access if you do not have them. Examples here describe the client interface; they are not connected to a live public demo.
Match the SDK version to the API contract and deployment version supplied for the pilot. This guide does not assume that a same-named package found on a public registry is an official Retvest distribution.
Prepare the integration handover
- Company API URL
- The HTTPS application address supplied by your administrator, separate from the model endpoint.
- Package and contract version
- The client artifact and matching schema for the deployed server.
- Credential and permissions
- The authentication family required by the operation and the account or key allowed to perform it.
- Approved example material
- A collection and sample question suitable for establishing the integration without exposing private material in logs.
Keep the two credentials distinct
The SDK’s Retvest API key authenticates to the company application. It is not a model-provider credential. Use the authentication family required by the operation: scoped API keys for supported automation, and a permitted session for session-owned workflows.
Handle failures deliberately
Preserve request IDs and error codes for support without logging secrets or document content. Retry only when the operation permits it. A write that times out may have reached the server; automatically repeating it can create an unintended second action.
Know which layer owns the decision
The SDK handles client transport and typed responses. Your application decides how to present a result, request review or explain an incomplete operation. The server remains responsible for authorisation and the work record. Hiding a button in a client is not a substitute for server permission checks.
Continue in your language
Python client → / TypeScript client → / Retvest CLI → / API concepts →