This is the official API wrapper for TypeflowAI. It is used to interact with the TypeflowAI API. To know more about TypeflowAI, visit TypeflowAI.com.
The direct API documentation can be found in our official docs here. To interact with the TypeflowAI API, you need to have an environment ID. You can get it from the TypeflowAI dashboard at app.typeflowaI.com.
npm install @typeflowai/api
import { TypeflowAIAPI } from "@typeflowai/api";
const api = new TypeflowAIAPI({
apiHost: `https://dashboard.typeflowai.com`, // If you have self-hosted TypeflowAI, change this to your self hosted instance's URL
environmentId: "<environment-id>", // Replace this with your TypeflowAI environment ID
});
The API client is now ready to be used across your project. It can be used to interact with the following models:
-
Create a Display
await api.client.display.create({ workflowId: "<your-workflow-id>", // required userId: "<your-user-id>", // optional responseId: "<your-response-id>", // optional });
-
Update a Display
await api.client.display.update( displayId: "<your-display-id>", { userId: "<your-user-id>", // optional responseId: "<your-response-id>", // optional }, );
-
Create a Response
await api.client.response.create({ workflowId: "<your-workflow-id>", // required finished: boolean, // required data: { questionId: "<answer-to-this-question-in-string>", anotherQuestionId: 123, // answer to this question in number yetAnotherQuestionId: ["option1", "option2"], // answer to this question in array, }, // required userId: "<your-user-id>", // optional singleUseId: "<your-single-use-id>", // optional ttc: { questionId: 123, // optional }, // optional meta: { source: "<your-source>", // optional url: "<your-url>", // optional userAgent: { browser: "<your-browser>", // optional device: "<your-device>", // optional os: "<your-os>", // optional }, country: "<your-country>", // optional }, // optional });
-
Update a Response
await api.client.response.update({ responseId: "<your-response-id>", // required finished: boolean, // required data: { questionId: "<answer-to-this-question-in-string>", anotherQuestionId: 123, // answer to this question in number yetAnotherQuestionId: ["option1", "option2"], // answer to this question in array, }, // required ttc: { questionId: 123, // optional }, // optional });
-
Create an Action
await api.client.action.create({ name: "<your-action-name>", // required properties: { key1: "value1", key2: "value2", key3AsNumber: 123, }, // required personId: "<your-person-id>", // optional sessionId: "<your-session-id>", // optional });
-
Create a Person
await api.client.people.create({ userId: "<your-user-id>", // required });
-
Update a Person
await api.client.people.update(personId: "<your-person-id>", // required { attributes: { key1: "value1", key2: "value2", key3AsNumber: 456, }, // required }
-
Upload a file
await api.client.storage.uploadFile( file: File, // required (of interface File of the browser's File API) { allowedFileTypes: ["file-type-allowed", "for-example", "image/jpeg"], // optional workflowId: "<your-workflow-id>", // optional } // optional );