Clment.Sdk 0.1.0

Clment .NET SDK

Official client for the Clment contract-intelligence API. Generated from the published OpenAPI document, so it cannot drift from the API it calls.

dotnet add package Clment.Sdk

Get the region right

Your contracts and your API keys live in exactly one region, and a valid key sent to the wrong region fails exactly like an invalid one — a 401 that sends people hunting for a new key when the host was the problem. Set the base URL for your own region:

Your region is shown in Settings → API & Integrations.

First call

using Clment.Sdk.Api;
using Clment.Sdk.Client;

var config = new Configuration
{
    // Your organisation's region: us | eu | uk | au | nz | ca
    BasePath = "https://api-nz.clment.com/v1",
};
// AccessToken, not AddApiKey: the client adds the "Bearer " prefix itself.
config.AccessToken = Environment.GetEnvironmentVariable("CLMENT_API_KEY");

var contracts = new ContractsApi(config);
var page = await contracts.ListContractsAsync(status: "active", take: 20);
Console.WriteLine($"{page.Data.Contracts.Count} of {page.Data.Total} active contracts");

Things worth knowing

• Long-running work returns a job id. Uploads, reviews and redlines run in the background: call the start operation, then poll the matching job operation until it reports complete. A review runs for minutes; the start response carries an advisory estimateSeconds.

• Uploads are not idempotent. The same file twice creates two contracts. Keep a record of what you have sent.

• AI operations consume credits; reads are free. Check GetUsage / get_usage before a batch rather than discovering exhaustion as a 402 halfway through one.

• Rate limits arrive as 429 with Retry-After. Retry 429, 5xx and connection failures; a 401, 403 or 404 will not fix itself.

• Comparing two versions is a review with scope: two_version, not a separate endpoint.

• A few field names are escaped by the generator. Where a name would collide with something in the target language it is renamed rather than dropped — the taxonomy's version arrives as VarVersion. If a property you expect is missing, look for a Var prefix.

Documentation

• Developer hub
• API reference
• Authentication
• Workflow examples

Building in TypeScript or JavaScript? Use @clment/sdk instead — it is hand-written over generated types and has a friendlier surface.

Licence

MIT © Contract Eagle Limited, trading as Clment.