0.15.0-rc.31 • Published 7 months ago

instill-sdk v0.15.0-rc.31

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
7 months ago

Overview

Typescript SDK for Instill AI products

!IMPORTANT
This SDK tool is under heavy development!!
Currently there has yet to be a stable version release, please feel free to open any issue regarding this SDK in our community repo

Requirements

  • Node 18+

Installation

npm i instill-sdk
yarn add instill-sdk
pnpm add instill-sdk

Usage

Import

import { InstillAPIClient } from "instill-sdk";

const client = new InstillAPIClient({
  // Note: Model related endpoint is still in v1alpha version
  baseURL: "https://api.instill.tech/v1beta",
  apiKey: "<YOUR_API_KEY>"
})

Useful helper for you to reuse the client instance

import { InstillAPIClient } from "instill-sdk";

let instillAPIClient: InstillAPIClient | null = null;

export function getInstillAPIClient() {
  if (!instillAPIClient) {
    const baseURL = `${
      process.env.NEXT_SERVER_API_GATEWAY_URL ??
      env("NEXT_PUBLIC_API_GATEWAY_URL")
    }/${env("NEXT_PUBLIC_GENERAL_API_VERSION")}`;

    instillAPIClient = new InstillAPIClient({
      // Note: Model related endpoint is still in v1alpha version
      baseURL: "https://api.instill.tech/v1beta", 
      apiToken: "<YOUR_API_KEY>"
    });
  }

  return instillAPIClient;
}

Example: Get all accessible pipelines

export async function getAccessiblePipelines(){
  try {
    const pipelines = await client.vdp.pipeline.listAccessiblePipelines({

      // This means you don't want to get the paginated response, instead,
      // you will get all the pipelines in one go
      enablePagination: false,

      // This means you want to have the full pipeline data object
      view: "VIEW_FULL",
    });

    return Promise.resolve(pipelines)
  } catch(error){
    return Promise.reject(error)
  }
}

Example: Get all models under your namespace

Let's say your namespace is users/instill-ai

export async function getNamespaceModels(){
  try {
    const models = await client.model.listNamespaceModels({
      namespaceName: "users/instill-ai",
      enablePagination: false,
      view: "VIEW_FULL"
    });

    return Promise.resolve(models)
  } catch(error){
    return Promise.reject(error)
  }
}
0.14.0-rc.2

10 months ago

0.14.0-rc.1

10 months ago

0.14.0-rc.0

10 months ago

0.14.0-rc.12

9 months ago

0.14.0-rc.13

9 months ago

0.14.0-rc.14

9 months ago

0.14.0-rc.15

9 months ago

0.14.0-rc.10

9 months ago

0.14.0-rc.11

9 months ago

0.14.0-rc.16

9 months ago

0.14.0-rc.17

9 months ago

0.14.0-rc.18

9 months ago

0.14.0-rc.19

8 months ago

0.14.0-rc.23

8 months ago

0.14.0-rc.24

8 months ago

0.14.0-rc.25

8 months ago

0.14.0-rc.26

8 months ago

0.14.0-rc.20

8 months ago

0.14.0-rc.21

8 months ago

0.14.0-rc.22

8 months ago

0.14.0-rc.9

9 months ago

0.14.0-rc.8

9 months ago

0.14.0-rc.7

10 months ago

0.14.0-rc.27

8 months ago

0.14.0-rc.6

10 months ago

0.14.0-rc.28

8 months ago

0.14.0-rc.5

10 months ago

0.14.0-rc.29

8 months ago

0.14.0-rc.4

10 months ago

0.14.0-rc.3

10 months ago

0.11.0-rc.12

11 months ago

0.11.0-rc.11

11 months ago

0.11.0-rc.3

11 months ago

0.11.0-rc.14

11 months ago

0.11.0-rc.13

11 months ago

0.11.0-rc.16

11 months ago

0.11.0-rc.6

11 months ago

0.11.0-rc.15

11 months ago

0.11.0-rc.7

11 months ago

0.11.0-rc.18

11 months ago

0.11.0-rc.4

11 months ago

0.11.0-rc.17

11 months ago

0.11.0-rc.5

11 months ago

0.11.0-rc.19

11 months ago

0.11.0-rc.8

11 months ago

0.11.0-rc.9

11 months ago

0.11.0-rc.10

11 months ago

0.11.0-rc.23

11 months ago

0.11.0-rc.22

11 months ago

0.11.0-rc.25

11 months ago

0.11.0-rc.24

11 months ago

0.11.0-rc.27

11 months ago

0.11.0-rc.26

11 months ago

0.11.0-rc.29

11 months ago

0.11.0-rc.28

11 months ago

0.15.0-rc.31

7 months ago

0.15.0-rc.30

7 months ago

0.11.0-rc.21

11 months ago

0.11.0-rc.20

11 months ago

0.15.0-rc.1

10 months ago

0.15.0-rc.0

10 months ago

0.15.0-rc.3

7 months ago

0.15.0-rc.2

7 months ago

0.13.0

10 months ago

0.13.1

10 months ago

0.13.2

8 months ago

0.15.0-rc.9

7 months ago

0.15.0-rc.8

7 months ago

0.15.0-rc.5

7 months ago

0.15.0-rc.4

7 months ago

0.15.0-rc.7

7 months ago

0.13.0-rc.0

10 months ago

0.15.0-rc.6

7 months ago

0.13.0-rc.1

10 months ago

0.13.0-rc.2

10 months ago

0.13.0-rc.3

10 months ago

0.14.0

7 months ago

0.14.1

7 months ago

0.14.2

7 months ago

0.12.0-rc.2

11 months ago

0.11.0-rc.34

11 months ago

0.12.0-rc.1

11 months ago

0.11.0-rc.33

11 months ago

0.11.0-rc.36

11 months ago

0.12.0-rc.3

11 months ago

0.11.0-rc.35

11 months ago

0.15.0-rc.29

7 months ago

0.15.0-rc.28

7 months ago

0.11.0-rc.37

11 months ago

0.15.0-rc.27

7 months ago

0.15.0-rc.26

7 months ago

0.15.0-rc.25

7 months ago

0.15.0-rc.24

7 months ago

0.15.0-rc.23

7 months ago

0.15.0-rc.21

7 months ago

0.15.0-rc.20

7 months ago

0.13.1-rc.0

10 months ago

0.11.0

11 months ago

0.11.0-rc.30

11 months ago

0.11.0-rc.32

11 months ago

0.11.0-rc.31

11 months ago

0.15.0-rc.19

7 months ago

0.15.0-rc.18

7 months ago

0.15.0-rc.17

7 months ago

0.15.0-rc.16

7 months ago

0.15.0-rc.15

7 months ago

0.15.0-rc.14

7 months ago

0.15.0-rc.13

7 months ago

0.15.0-rc.12

7 months ago

0.15.0-rc.11

7 months ago

0.15.0-rc.10

7 months ago

0.12.0-rc.0

11 months ago

0.14.0-rc.34

8 months ago

0.14.0-rc.35

8 months ago

0.14.0-rc.36

8 months ago

0.14.0-rc.37

8 months ago

0.14.0-rc.30

8 months ago

0.14.0-rc.31

8 months ago

0.14.0-rc.32

8 months ago

0.14.0-rc.33

8 months ago

0.12.0

10 months ago

0.14.0-rc.38

8 months ago

0.14.0-rc.39

8 months ago

0.14.0-rc.40

8 months ago

0.14.0-rc.45

7 months ago

0.14.0-rc.46

7 months ago

0.14.0-rc.47

7 months ago

0.14.0-rc.41

8 months ago

0.14.0-rc.42

7 months ago

0.14.0-rc.43

7 months ago

0.14.0-rc.44

7 months ago

0.11.0-rc.2

11 months ago

0.10.0-rc.2

11 months ago

0.10.0-rc.1

11 months ago

0.10.0-rc.6

11 months ago

0.10.0-rc.5

11 months ago

0.10.0-rc.4

11 months ago

0.10.0-rc.3

11 months ago

0.10.0-rc.7

11 months ago

0.11.0-rc.0

11 months ago

0.11.0-rc.1

11 months ago

0.10.0

11 months ago

0.9.0

11 months ago

0.9.0-rc.1

11 months ago

0.9.0-rc.0

11 months ago

0.4.0-rc.8

1 year ago

0.8.0-rc.2

12 months ago

0.4.0-rc.3

1 year ago

0.8.0-rc.3

12 months ago

0.7.0-rc.20

12 months ago

0.4.0-rc.2

1 year ago

0.8.0-rc.0

12 months ago

0.7.0-rc.21

12 months ago

0.4.0-rc.1

1 year ago

0.8.0-rc.1

12 months ago

0.7.0-rc.22

12 months ago

0.7.0-rc.23

12 months ago

0.4.0-rc.7

1 year ago

0.7.0-rc.24

12 months ago

0.4.0-rc.6

1 year ago

0.7.0-rc.25

12 months ago

0.4.0-rc.5

1 year ago

0.7.0-rc.26

12 months ago

0.4.0-rc.4

1 year ago

0.8.0-rc.8

12 months ago

0.8.0-rc.9

12 months ago

0.8.0-rc.6

12 months ago

0.8.0-rc.7

12 months ago

0.8.0-rc.4

12 months ago

0.6.0-rc.0

1 year ago

0.8.0-rc.5

12 months ago

0.8.0-rc.11

12 months ago

0.8.0-rc.12

12 months ago

0.5.0

1 year ago

0.7.0

12 months ago

0.5.2

1 year ago

0.8.0-rc.10

12 months ago

0.5.1

1 year ago

0.4.1-rc.0

1 year ago

0.7.0-rc.2

12 months ago

0.5.0-rc.2

1 year ago

0.7.0-rc.1

12 months ago

0.5.0-rc.1

1 year ago

0.7.0-rc.0

12 months ago

0.5.0-rc.3

1 year ago

0.7.0-rc.9

12 months ago

0.7.0-rc.8

12 months ago

0.7.0-rc.7

12 months ago

0.7.0-rc.6

12 months ago

0.7.0-rc.5

12 months ago

0.7.0-rc.4

12 months ago

0.5.0-rc.0

1 year ago

0.7.0-rc.3

12 months ago

0.7.0-rc.16

12 months ago

0.7.0-rc.17

12 months ago

0.7.0-rc.18

12 months ago

0.7.0-rc.19

12 months ago

0.7.0-rc.10

12 months ago

0.7.0-rc.11

12 months ago

0.7.0-rc.12

12 months ago

0.7.0-rc.13

12 months ago

0.7.0-rc.14

12 months ago

0.7.0-rc.15

12 months ago

0.8.0

12 months ago

0.4.1

1 year ago

0.4.0

1 year ago

0.6.0

1 year ago

0.1.0-rc.9

1 year ago

0.1.0-rc.7

1 year ago

0.1.0-rc.8

1 year ago

0.1.0-rc.5

1 year ago

0.3.1-rc.0

1 year ago

0.1.0-rc.6

1 year ago

0.3.0-rc.3

1 year ago

0.1.0-rc.3

1 year ago

0.3.0-rc.4

1 year ago

0.1.0-rc.4

1 year ago

0.1.0-rc.1

1 year ago

0.4.0-rc.0

1 year ago

0.1.0-rc.2

1 year ago

0.3.0-rc.0

1 year ago

0.1.0-rc.0

1 year ago

0.3.0-rc.1

1 year ago

0.1.0-rc.11

1 year ago

0.1.0-rc.10

1 year ago

0.3.0

1 year ago

0.2.0

1 year ago

0.3.2-rc.0

1 year ago

0.3.1

1 year ago

0.0.7

1 year ago

0.0.6

1 year ago

0.0.5

1 year ago

0.0.4

1 year ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.13

2 years ago

0.0.1

2 years ago