decthings

Model / setImage


Change the Docker image used when executing the model.

Request parameters

{
    /** The model's id. */
    modelId: string,
    /** The domain name to load from, i.e "docker.io" or "registry.decthings.com" */
    domain: string,
    /** The repository to use, i.e "library/ubuntu" */
    repository: string,
    /** The tag to use, to, i.e "latest" */
    reference: string
}

Response

{
    /** If successful. One of "result" and "error" will be present. */
    result?: {},

    /** If failed */
    error?: {
        code: 'model_not_found' | 'access_denied' | 'image_not_found' | '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.setImage({
            modelId: /* Add modelId here */,
            domain: /* Add domain here */,
            repository: /* Add repository here */,
            reference: /* Add reference 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