Seam Docs
Search…
Install Client Library
2 mins
We recommend that you use Seam's client libraries in the language of your choice.

Install Library

You can use your favorite package manager to install Seam's client libraries.
Javascript
Python
$ npm i seamapi
or
$ yarn add seamapi
$ pip install seamapi
or
$ poetry add seamapi
​

Test Auth

Export your API key as an env var. Seam client libs will automatically pick it up. For example:
$ export SEAM_API_KEY=seam_test2ZTo_0mEYQW2TvNDCxG5Atpj85Ffw
Next, run the code below to check you are correctly authenticated:
Javascript
Python
1
// Replace with
2
// const Seam = require("seamapi")
3
// if not using ES6 modules and/or TypeScript.
4
import Seam from "seamapi";
5
​
6
// Seam will automatically use the SEAM_API_KEY environment variable if you
7
// don't provide an apiKey to `new Seam()`
8
const seam = new Seam();
9
​
10
const checkAuth = async () => {
11
const { workspace } = await seam.workspaces.get();
12
console.log(workspace);
13
}
14
​
15
checkAuth();
16
​
17
/*
18
{
19
workspace_id: 'ab804f5a-7dd2-42c8-8d09-0beff4f795eb',
20
name: 'Sanbox',
21
connect_partner_name: 'Acme',
22
is_sandbox: true
23
}
24
*/
Copied!
​
1
from seamapi import Seam
2
​
3
# Seam will automatically use the SEAM_API_KEY environment variable if you
4
# don't provide an api_key to `Seam()`
5
seam = Seam()
6
​
7
workspace = seam.workspaces.get()
8
print(workspace)
9
# Workspace(workspace_id='ab804f5a-7dd2-42c8-8d09-0beff4f795eb',
10
# name='Sanbox', is_sandbox=True)
Copied!
​
Copy link