coaxial-client v1.0.1

Coaxial-Client

This is the official typescript client library for Coaxial, an IAM solution for LLMs. We provide APIs that give developers full control over data integrations, LLM integrations, and more.

This library is a lightweight wrapper around our API — developers can onboard to Coaxial in under 5 minutes.

Quickstart

To use the Coaxial typescript client, you will first need to obtain an API key. Log into your organization dashboard and enter the API key tab to obtain one.

Use the following to initialize the client:

let client = new CoaxialClient('<YOUR_API_KEY>')

Handling Auth Integrations

Coaxial will auto import users from existing authentication service providers such as Okta.

// perform new auth integration
const okta_config = {
    "orgUrl": "<your_org_url>"
    "apiKey": "<your_okta_api_key>"
}
await client.auth.doIntegration(type="okta", config=okta_config)

// list your users
await client.auth.getUsers(auth_integration="okta")

Handling Data Integrations

Coaxial will auto import tables from existing data lake / db service providers such as Databricks and Snowflake under a Dataset model; this model object will be assigned a tag.

// perform new data integration
const pinecone_config = {
    "environment": "<your pinecone env>"
    "api_key": "<your pinecone apikey>"
}
await client.dataset.doIntegration(type="pinecone", config=pinecone_config)

// list your datasets
await client.dataset.list()

Registering data transformations

Coming soon...

Handling LLM Integrations

Coming soon...

Pass-through

Coming soon...