​

Cluster API Keys

Cluster API keys are used to authenticate requests with the Inferable API. Each key is associated with one cluster, and can has permission to:

• Poll the Cluster for new function calls
• Trigger Runs,
• Manage Templates
• Submit Feedback

​

SDKs

The Inferable SDKs (except for @inferable/sdk-react require an API key, if none is provided explicitly it will attempt to use the environment variable INFERABLE_API_SECRET

• TypeScript
• Go
• .Net

const client = new Inferable({
  apiSecret: "YOUR_API_SECRET",
});

​

API Key Management

New secrets can be created (and revoked):

• Within the Playground or;
• Via the Inferable CLI with inf auth keys create <name> | revoke <id>

​

CLI Authentication

When using the Inferable CLI, no API keys are required. The CLI retrieves a short lived (1hr) token when the inf auth login command is run.

​

Custom Authentication

Inferable supports custom authentication mechanisms, such as bring your own JWT, user session tokens, etc. This is useful for integrating with existing services:

1. Having an existing user session, JWT, or API key
2. Containing a front-end application that creates runs on behalf of a user

See Custom Authentication for more details.