Have you already used the API? Share your experience!

[matthijs]

Hi everyone, we have launched some nice improvements on our API, making it a lot easier to use and enabling exciting usecases.

• publication of API docs
• personal access tokens
• improved SDK api module enabling external use

I am very eager to hear from you how you like it. Do you have a cool usecase you implemented? Do you have suggestions for improvement?

[matthijs]

There are already a few interesting questions being raised in the following topics:

Get url for image through API

Hi, when I call the API to start a job, and then get the result from an ImageView, the image is in the response as a base64 encoded string. Which is nice, but unfortuantely on the client-side I have no way of actually converting that to an image. Is it possible to get the url to a generated image, just like for the 3D model? Mark

Allowed options for method_type field in API

Thanks, that worked!

API Call Internal Viktor Application

Description of the limitation and why it is relevant to address We have a sub-module that is now part of different bigger applications. The only interface is an API-call (one-way) to get the params file as a dict (.json) through the API module. This API call is done based on an SiblingEntityOptionField, however I would like to make an API call to application x - EntityType y. Submitter proposed design (optional) The data stored in this sub-module is saved in one database and can only be chan…

[matthijs]

We have updated the docs to make it more clear how the API works and how you can interact with it (from external source, between workspace, inside workspace).

See it here: Introduction | VIKTOR Documentation