Model / waitForModelToBeCreated

Language

Wait for the model create to finish.

Request parameters

{
    /** The model's id. */
    modelId: string
}

Response

{
    /** If successful. One of "result" and "error" will be present. */
    result?: {
        /** One of "createModelFailed" or "createModelSuccess" will be present. */
        createModelFailed?: {
            error: {
                code: 'cancelled' | 'server_overloaded' | 'unknown'
            } | {
                code: 'create_state_error',
                details: {
                    code: 'invalid_executable_file' | 'read_executable_file_failed' | 'launcher_terminated'
                } | {
                    code: 'max_duration_exceeded',
                    at: 'codeStartup' | 'createState'
                } | {
                    code: 'code_terminated',
                    exitCode?: number,
                    signal?: string,
                    oom: boolean
                } | {
                    code: 'exception',
                    at: 'codeStartup' | 'createState',
                    exceptionDetails?: string
                },
                createInitialStateDurations: {
                    createLauncher: number,
                    codeStartup?: number,
                    createState?: number
                }
            }
        },
        createModelSuccess?: {
            createInitialStateDurations: {
                createLauncher: number,
                codeStartup: number,
                createState: number
            }
        }
    },

    /** If failed */
    error?: {
        code: 'model_not_found' | 'model_already_created' | 'bad_credentials' | 'too_many_requests' | 'payment_required' | 'unknown'
    } | {
        code: 'invalid_parameter',
        parameterName: string,
        reason: string
    }
}

Example

Following the installation guide to setup the Decthings API for TypeScript. Add your parameters to the following code and run it in Node.js, or in a browser by using a bundler.

The code reads your API key from file. Create an API key and save it to the file "auth.txt". Keep your key safe!

import * as fs from 'fs'
import { DecthingsClient } from '@decthings/api-client'

let apiKey = fs.readFileSync('./auth.txt').toString().trim()
let client = new DecthingsClient({ apiKey })

async function main() {
    try {
        let response = await client.model.waitForModelToBeCreated({
            modelId: /* Add modelId here */
        })
        if (result.error) {
            // Decthings sent us an error
            console.log(response.error)
        } else {
            // Success!
            console.log(response.result)
        }
    }
    catch (e) {
        // Client throws an error on connection issues. The function may or may not have succeded
        console.log(e)
    }
}
main()

Product

Company

Get going!