decthings

Debug / callInstantiateModel


Call the function "instantiateModel" in a debug session.

Request parameters

{
    /** The debug session's id. */
    debugSessionId: string,
    /** Data to use as model state. */
    stateData: {
        type: 'data',
        data: {
            key: string,
            data: Buffer
        }[]
    } | {
        type: 'dataId',
        dataId: string
    }
}

Response

{
    /** If successful. One of "result" and "error" will be present. */
    result?: {
        /** A unique identifier which you should use in subsequent API calls. */
        instantiatedModelId: string
    },

    /** If failed */
    error?: {
        code: 'debug_session_not_found' | 'debug_session_terminated' | 'state_data_not_found' | 'bad_credentials' | 'too_many_requests' | 'payment_required' | 'unknown'
    } | {
        code: 'exception',
        exceptionDetails?: string
    } | {
        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.debug.callInstantiateModel({
            debugSessionId: /* Add debugSessionId here */,
            stateData: /* Add stateData 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

  • Documentation
  • Pricing
  • API reference
  • Guides

Company

  • Support

Get going!

Sign up
  • Terms and conditions
  • Privacy policy
  • Cookie policy
  • GitHub
  • LinkedIn

This website uses cookies to enhance the experience.

Learn more