Skip to main content
Users of our TypeScript client library can generate TypeScript interfaces to help with consuming the API response in a type-safe way. Use the affinda-generate-interfaces command to auto-generate TypeScript interfaces from your document type configuration. For example, this will generate TypeScript interfaces for your Recruitment workspace:
You will be prompted for your API key, unless you already have the AFFINDA_API_KEY environment variable set. The generated TypeScript interfaces will be in ./affinda-interfaces by default. For the list of options available, run: