VIKTOR

https://docs.viktor.ai/
Admin
VIKTOR is a platform for developing and deploying data-driven web applications, enabling users to...
Tokens:648,301
Snippets:3,592
Trust Score:9.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Run Viktor CLI Quickstart

Source: https://docs.viktor.ai/docs/getting-started/starter-guide

This command initiates the setup process for a new Viktor AI application. It downloads a template, installs Python dependencies, and prepares the app for opening in a code editor.

```Bash
viktor-cli quickstart hello-viktor
```

--------------------------------

### Start VIKTOR App

Source: https://docs.viktor.ai/docs/faq

This command starts a VIKTOR application after it has been installed. Ensure all dependencies are correctly listed in `requirements.txt` and installed.

```bash
viktor-cli start
```

--------------------------------

### VIKTOR App: Initial Parametrization and TableView Setup

Source: https://docs.viktor.ai/docs/getting-started/starter-guide

Sets up the basic VIKTOR application structure with input fields for length, width, and height, and defines an initial TableView with placeholder data. This snippet is the starting point for creating interactive applications.

```Python
import viktor as vkt


class Parametrization(vkt.Parametrization):
    welcome = vkt.Text("# 👋 Welcome to your first VIKTOR app! 👋\n## Let's start with the basics")
    length = vkt.NumberField("Length", default=1)
    width = vkt.NumberField("Width", default=1)
    height = vkt.NumberField("Height", default=1)


class Controller(vkt.Controller):
    parametrization = Parametrization

@vkt.TableView("Results")
def results(self, params,**kwargs):
        data =[
[1,2],
[3,4],
]
        row_headers =["Row 1","Row 2"]
        column_headers =["Col 1","Col 2"]
return vkt.TableResult(data, row_headers=row_headers, column_headers=column_headers)
```

--------------------------------

### Install and Start Viktor AI Application

Source: https://docs.viktor.ai/docs/tutorials/app-type-editor

Commands to install and start a Viktor AI application from the terminal. Requires closing the current connection (Ctrl+C) before installation.

```bash
viktor-cli install  
viktor-cli start  
```

--------------------------------

### Install and Start VIKTOR CLI

Source: https://docs.viktor.ai/docs/tutorials/integrate-scia

This command installs and starts the VIKTOR CLI application. It is used to manage and run VIKTOR projects, including cleaning up previous states and starting the application.

```Shell
viktor-cli clean-start  

```

--------------------------------

### Install and Start VIKTOR App

Source: https://docs.viktor.ai/docs/tutorials/visual-builder

This command performs a clean installation of the app's dependencies and starts the VIKTOR application. It ensures all necessary packages are installed and the app is running, providing a URL to access it in the browser.

```Shell
viktor-cli clean-start
```

--------------------------------

### Viktor CLI Commands for Dependency Installation and App Start

Source: https://docs.viktor.ai/docs/tutorials/plots-and-data

These bash commands are used to install new dependencies listed in `requirements.txt` and to start the Viktor application. 'viktor-cli install' applies the changes, and 'viktor-cli start' reconnects the app.

```bash
viktor-cli install  

```

```bash
viktor-cli start  

```

--------------------------------

### VIKTOR CLI: Added quickstart command

Source: https://docs.viktor.ai/docs/whats-new/changelog-cli

Introduces the `quickstart` command, which allows users to begin developing from a sample app. This simplifies the initial setup for new projects.

```CLI
# v0.36.0 - 25/06/2024
### Added
  * Added `quickstart` command to start developing from a sample app
```

--------------------------------

### Start Viktor AI Application

Source: https://docs.viktor.ai/docs/tutorials/app-type-simple

Starts the Viktor AI application after installation. This command is run in the terminal to make the application accessible.

```Shell
viktor-cli start
```

--------------------------------

### Add quickstart command to Viktor CLI

Source: https://docs.viktor.ai/docs/create-apps/references/cli/changelog

Introduces the `quickstart` command to the Viktor CLI, enabling users to begin development with a sample application. This command simplifies the initial setup process for new projects.

```bash
viktor quickstart
```

--------------------------------

### Create Combined 'clean-start' Command

Source: https://docs.viktor.ai/docs/whats-new/changelog-cli

A new `clean-start` command has been introduced, which conveniently combines the functionality of `clear`, `install`, and `start` into a single command for streamlined application setup.

```Bash
clean-start
```

--------------------------------

### Navigate to Cloud Environment

Source: https://docs.viktor.ai/docs/getting-started/installation/restart-install-workflow

This snippet shows how to access the VIKTOR web environment, typically used for managing installations and developer accounts. It provides an example URL.

```text
cloud.viktor.ai
```

--------------------------------

### Combine clear, install, and start commands with clean-start

Source: https://docs.viktor.ai/docs/create-apps/references/cli/changelog

A new `clean-start` command has been introduced to the Viktor CLI, which combines the functionality of `clear`, `install`, and `start`. This provides a convenient way to reset and launch a project with a single command.

```bash
viktor clean-start
```

--------------------------------

### VIKTOR CLI: Added hello-viktor app to quickstart

Source: https://docs.viktor.ai/docs/whats-new/changelog-cli

The `quickstart` command now includes the `hello-viktor` app, providing a simple starting point for new users.

```CLI
# v0.39.0 - 05/09/2024
### Added
  * Added `hello-viktor` app to `quickstart` command
```

--------------------------------

### VIKTOR CLI: Get Started

Source: https://docs.viktor.ai/docs/create-apps/references/cli

Activates your account on a specified environment to begin VIKTOR development. This command helps in setting up the initial development environment.

```bash
viktor-cli get-started <ENVIRONMENT> [flags]
  
Flags:
  -h, --help   help for get-started


```

--------------------------------

### Start Viktor App

Source: https://docs.viktor.ai/docs/tutorials/process-staad-data

This command starts the VIKTOR application, connecting it to the VIKTOR platform after dependencies have been installed.

```bash
viktor-cli start  
```

--------------------------------

### VIKTOR CLI: Support blank apps in quickstart

Source: https://docs.viktor.ai/docs/whats-new/changelog-cli

The `quickstart` command now supports creating blank apps. This provides flexibility for users who want to start with a completely empty project structure.

```CLI
# v0.38.0 - 12/08/2024
  * Support blank apps in `quickstart` command
```

--------------------------------

### Viktor CLI Quickstart

Source: https://docs.viktor.ai/docs/create-apps/references/cli

Starts developing from a sample app or a converted Excel file. Requires specifying the source of the sample app or file and the desired name for the new application.

```bash
viktor-cli quickstart <SOURCE> <APP-NAME> [flags]

Flags:
  -h, --help   help for quickstart
```

--------------------------------

### Open CLI Help Menu

Source: https://docs.viktor.ai/docs/getting-started/installation/installation-using-docker

Executes the VIKTOR CLI with the '--help' flag, which should display the CLI's help menu if the setup and PATH configuration are correct.

```shell
viktor-cli --help
```

--------------------------------

### VIKTOR App: Complete Code Example

Source: https://docs.viktor.ai/docs/tutorials/process-etabs-data

Provides the complete code for a VIKTOR application, integrating all the functionalities discussed in the tutorial, including setup, data processing, user input, and visualization.

```Python
# Complete VIKTOR app code would go here, integrating all components.
```

--------------------------------

### Start Viktor App

Source: https://docs.viktor.ai/docs/tutorials/process-etabs-data

This command initiates the connection and starts the Viktor application in the terminal. It's used after installing new dependencies or making significant code changes.

```Shell
viktor-cli start
```

--------------------------------

### VIKTOR CLI: Quickstart command avoids registered-name prompt

Source: https://docs.viktor.ai/docs/whats-new/changelog-cli

The `quickstart` command no longer unnecessarily prompts for `registered-name`. This streamlines the process of starting new projects.

```CLI
# v0.41.5 - 11/11/2024
### Fixed
  * Fix quickstart command from unnecessarily prompting for `registered-name`
```

--------------------------------

### VIKTOR CLI: Support Excel converter in quickstart

Source: https://docs.viktor.ai/docs/whats-new/changelog-cli

The `quickstart` command now supports the Excel converter. This allows users to easily start projects that involve Excel data processing.

```CLI
# v0.37.0 - 29/07/2024
### Added
  * Support Excel converter in `quickstart` command
```

--------------------------------

### VIKTOR CLI Clean Start Command

Source: https://docs.viktor.ai/docs/create-apps/references/cli

Installs and launches an application within a fresh development workspace. It allows specifying the application directory path.

```bash
viktor-cli clean-start [flags]  
  
Flags:  
      --app-dir string   Path to the directory that contains the app code (default: current working directory). (default ".")  
  -h, --help             help for clean-start  

```

--------------------------------

### Viktor App: Terminal Output Example

Source: https://docs.viktor.ai/docs/tutorials/intermediate-3d-model

This is an example of the expected output in the terminal after successfully starting a Viktor application. It indicates a successful connection to the cloud, provides a link to view the app in a browser, and confirms that the app code is loaded and waiting for jobs.

```Bash
INFO    : Connecting to cloud.viktor.ai...  
INFO    : Connection is established (use Ctrl+C to close)  
INFO    :   
INFO    : Navigate to the link below to see your app in the browser  
INFO    :     https://cloud.viktor.ai/workspaces/XXX/app  
INFO    :   
INFO    : App code loaded, waiting for jobs...  


```

--------------------------------

### Start VIKTOR Application

Source: https://docs.viktor.ai/docs/tutorials/integrate-grasshopper

This shell command starts the VIKTOR application. It's used after installing dependencies and setting up the code, allowing you to access and interact with the app in the browser.

```Shell
viktor-cli start
```

--------------------------------

### Get Job by Id - Node.js Example

Source: https://docs.viktor.ai/docs/api/rest/jobs-read

Illustrates fetching job data with Node.js, likely using the 'axios' or built-in 'http' module. Covers request setup and response handling.

```javascript
// Example for Node.js would go here, assuming a similar structure to CURL
```

--------------------------------

### Run Viktor CLI Quickstart Command

Source: https://docs.viktor.ai/docs/tutorials/automatic-reporting

This command downloads the empty app template and sets up the project. It's a crucial step for initializing a new Viktor application. Ensure you are in your project directory before running.

```Shell
quickstart
```

--------------------------------

### Grasshopper - VIKTOR Integration Setup

Source: https://docs.viktor.ai/docs/tutorials/integrate-grasshopper

This section details the setup required for Grasshopper integration with VIKTOR. It includes installing the Hops plugin via the Package Manager in Rhino and configuring Rhino Compute preferences to ensure it launches at startup and the console window is visible for debugging.

```Grasshopper
1. Install Hops via the Package Manager in Rhino (type `PackageManager` on the Rhino command line and search for "Hops")
2. In Grasshopper, go to `File -> Preferences` and check the following settings:
   - Enable "Launch Rhino.Compute" at startup
   - Uncheck "Hide Rhino.Compute Console Window"
```

--------------------------------

### Get Workspace User Group by Id - Go Example

Source: https://docs.viktor.ai/docs/api/rest/workspaces-groups-read

Illustrates how to make a GET request in Go to retrieve a workspace group. This example includes setting up the request URL and headers for authentication.

```go
package main

import (
	"fmt"
	"net/http"
)

func main() {
	url := "https://<environment>.viktor.ai/api/workspaces/{workspace_id}/groups/{id}/"

	client := &http.Client{}

	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		fmt.Println("Error creating request:", err)
		return
	}

	req.Header.Add("Authorization", "Bearer <token>")

	res, err := client.Do(req)
	if err != nil {
		fmt.Println("Error sending request:", err)
		return
	}
	defer res.Body.Close()

	fmt.Println("Status Code:", res.StatusCode)
	// Process response body here
}
```

--------------------------------

### Get Workspace User Group by Id - Node.js Example

Source: https://docs.viktor.ai/docs/api/rest/workspaces-groups-read

Shows a Node.js example for fetching workspace group data. It utilizes the 'axios' library to make the GET request and includes authorization headers.

```javascript
const axios = require('axios');

const environment = '<environment>';
const workspaceId = '<workspace_id>';
const groupId = '<id>';
const token = '<token>';

const url = `https://${environment}.viktor.ai/api/workspaces/${workspaceId}/groups/${groupId}/`;

axios.get(url, {
  headers: {
    'Authorization': `Bearer ${token}`
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error fetching group:', error);
});
```

--------------------------------

### Viktor CLI: Quickstart Command

Source: https://docs.viktor.ai/docs/tutorials/intermediate-3d-model

This command is used to download the empty app template provided by the Viktor CLI. After running this command, the CLI will prompt the user to select a code editor, and the app will then open in the chosen editor.

```Bash
quickstart
```

--------------------------------

### Get Job by Id - CURL Example

Source: https://docs.viktor.ai/docs/api/rest/jobs-read

Example of how to retrieve a job by its ID using cURL. It demonstrates setting the correct headers for JSON acceptance and authorization.

```bash
curl -L 'https://<environment>.viktor.ai/api/jobs/:id/' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
```

--------------------------------

### Get Job by Id - PowerShell Example

Source: https://docs.viktor.ai/docs/api/rest/jobs-read

Provides a PowerShell example using Invoke-RestMethod to fetch job information. Demonstrates setting headers and handling the JSON output.

```powershell
# Example for PowerShell would go here, assuming a similar structure to CURL
```

--------------------------------

### Viktor CLI Connection Log

Source: https://docs.viktor.ai/docs/getting-started/starter-guide

This log shows the connection process to the Viktor AI platform via the CLI, including the URL to access the development workspace in a browser.

```Bash
INFO    : Connecting to cloud.viktor.ai...  
INFO    : Connection is established (use Ctrl+C to close)  
INFO    :   
INFO    : Navigate to the link below to see your app in the browser  
INFO    :     https://cloud.viktor.ai/workspaces/XXX/app  
INFO    :   
INFO    : App code loaded, waiting for jobs...  
```

--------------------------------

### Get Job by Id - C# Example

Source: https://docs.viktor.ai/docs/api/rest/jobs-read

Provides a C# example using HttpClient to fetch job information. Covers setting up the client, request, and deserializing the JSON response.

```csharp
// Example for C# would go here, assuming a similar structure to CURL
```

--------------------------------

### Get Job by Id - Go Example

Source: https://docs.viktor.ai/docs/api/rest/jobs-read

Provides an example of retrieving job information using Go's net/http package. Shows how to construct the request and parse the JSON response.

```go
// Example for Go would go here, assuming a similar structure to CURL
```

--------------------------------

### Install demo app in temporary directory

Source: https://docs.viktor.ai/docs/create-apps/references/cli/changelog

The `get-started` command now installs the demo app in a temporary directory. This change addresses potential permission errors that could occur when installing in certain user-writable locations.

```bash
viktor get-started
```

--------------------------------

### VIKTOR App: Basic Setup and Python Packages

Source: https://docs.viktor.ai/docs/tutorials/process-etabs-data

This snippet covers the initial setup for a VIKTOR application, including creating an empty app, adding essential Python packages, and defining input fields. It serves as the foundation for building interactive data processing tools.

```Python
import viktor

# Placeholder for app creation and package imports
# Example: from viktor.core import ViktorApp
# Example: pip install pandas plotly
```

--------------------------------

### VIKTOR CLI: Auto-update on start, quickstart, clean-start

Source: https://docs.viktor.ai/docs/whats-new/changelog-cli

When running the `start`, `quickstart`, or `clean-start` commands, the VIKTOR CLI automatically updates to the latest version if one is available. This ensures users are always on the most recent version.

```CLI
# v0.41.1 - 24/10/2024
### Changed
  * When running the `start`, `quickstart`, or `clean-start` commands the cli automatically updates to the latest version
```

--------------------------------

### Get Job by Id - Ruby Example

Source: https://docs.viktor.ai/docs/api/rest/jobs-read

Shows how to get job details using Ruby's Net::HTTP library. Demonstrates making the GET request and processing the response.

```ruby
# Example for Ruby would go here, assuming a similar structure to CURL
```

--------------------------------

### Get Workspace User Group by Id - Python Example

Source: https://docs.viktor.ai/docs/api/rest/workspaces-groups-read

Provides a Python example for fetching a workspace group using the VIKTOR API. It shows how to construct the request URL with necessary parameters and handle the response.

```python
import requests

url = "https://<environment>.viktor.ai/api/workspaces/{workspace_id}/groups/{id}/"
headers = {
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
```

--------------------------------

### Get All Workspace Groups API Response Example (JSON)

Source: https://docs.viktor.ai/docs/api/rest/workspaces-groups-list

Provides an example of a successful JSON response when retrieving workspace groups. It outlines the structure of the returned data, including fields like id, name, description, members, and group settings.

```json
{
"id":0,
"name":"string",
"description":"string",
"members":[
0
],
"members_only_in_this_group":0,
"is_default":true
}
```

--------------------------------

### Get Job by Id - Java Example

Source: https://docs.viktor.ai/docs/api/rest/jobs-read

Shows how to get job details using Java's HttpClient. Covers constructing the request, setting headers, and parsing the response.

```java
// Example for Java would go here, assuming a similar structure to CURL
```

--------------------------------

### VIKTOR App: Create and Install Empty App

Source: https://docs.viktor.ai/docs/tutorials/spreadsheet-calculator

This snippet covers the initial steps of creating and setting up a new, empty VIKTOR application. It's a foundational step for developing any VIKTOR app.

```Python
def create_empty_app():
    # Placeholder for app creation logic
    print("Creating an empty VIKTOR app...")
    pass
```

--------------------------------

### Get Current User in Workspace (PowerShell)

Source: https://docs.viktor.ai/docs/api/rest/workspaces-users-current

PowerShell example to retrieve current user information from the VIKTOR API. It shows how to use Invoke-RestMethod to make the GET request with appropriate headers.

```powershell
$url = "https://<environment>.viktor.ai/api/workspaces/:workspace_id/users/current/"
$apiKey = "<API_KEY_VALUE>"

$headers = @{
    "Accept" = "application/json"
    "Authorization" = $apiKey
}

try {
    $response = Invoke-RestMethod -Uri $url -Method Get -Headers $headers
    $response | ConvertTo-Json
} catch {
    Write-Error $_.Exception.Message
}
```

--------------------------------

### Install Demo App in Temporary Directory

Source: https://docs.viktor.ai/docs/whats-new/changelog-cli

The `get-started` command now installs the demo app into a temporary directory. This change addresses potential permission errors that could occur during installation.

```Bash
get-started
```

--------------------------------

### Autoselect Python installation in get-started

Source: https://docs.viktor.ai/docs/create-apps/references/cli/changelog

The `get-started` command now automatically selects a Python installation and prints the selected path. It also provides a hint on how to change the selected Python version if needed.

```bash
viktor get-started
```

--------------------------------

### Get Current User in Workspace (Ruby)

Source: https://docs.viktor.ai/docs/api/rest/workspaces-users-current

Ruby example for calling the VIKTOR API to get the current user's details. It shows how to construct the request with headers for authentication and accepting JSON.

```ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://<environment>.viktor.ai/api/workspaces/:workspace_id/users/current/")

request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"
request["Authorization"] = "<API_KEY_VALUE>"

response = Net::HTTP.start(uri.hostname, uri.port, :use_ssl => uri.scheme == 'https') do |http|
  http.request(request)
end

puts response.body
```

--------------------------------

### Download Viktor CLI

Source: https://docs.viktor.ai/docs/create-apps/development-tools-and-tips/ci

Downloads the Viktor CLI binary for Linux and makes it executable. This is the first step in setting up continuous integration.

```Bash
curl -Lo viktor-cli 'https://developers.viktor.ai/api/v1/get-cli/?platform=linux&format=binary' && chmod +x viktor-cli  
```

--------------------------------

### Install VIKTOR App

Source: https://docs.viktor.ai/docs/faq

This command installs a VIKTOR application from the current directory. It requires a `requirements.txt` file to be present in the directory, listing all necessary dependencies.

```bash
viktor-cli install
```

--------------------------------

### VIKTOR CLI quickstart command updates

Source: https://docs.viktor.ai/docs/create-apps/references/cli/changelog

The `quickstart` command now includes a `hello-viktor` app option. It also supports blank apps and Excel converter.

```bash
viktor-cli quickstart
```

--------------------------------

### Viktor CLI: Start App

Source: https://docs.viktor.ai/docs/tutorials/basic-3d-model

Command to start a Viktor application from the terminal. Ensure you are in the correct project directory. This command connects to the cloud environment and loads the app code, waiting for jobs.

```Bash
viktor-cli start
```

--------------------------------

### Get Workspace User Group by Id - PowerShell Example

Source: https://docs.viktor.ai/docs/api/rest/workspaces-groups-read

A PowerShell script to fetch workspace group data from the VIKTOR API. It uses Invoke-RestMethod to send a GET request with the necessary authorization header.

```powershell
$environment = '<environment>'
$workspaceId = '<workspace_id>'
$groupId = '<id>'
$token = '<token>'

$url = "https://$environment.viktor.ai/api/workspaces/$workspaceId/groups/$groupId/"

$headers = @{
    "Authorization" = "Bearer $token"
}

$response = Invoke-RestMethod -Uri $url -Method Get -Headers $headers

Write-Host $response
```

--------------------------------

### Starting the Viktor App CLI

Source: https://docs.viktor.ai/docs/tutorials/app-type-simple

This snippet shows the expected output from the Viktor CLI when an app is successfully started and connected. It provides a link to access the app in the browser and indicates that the app is ready for jobs. The connection is maintained until the process is terminated (e.g., with Ctrl+C).

```bash
INFO    : Connecting to cloud.viktor.ai...  
INFO    : Connection is established (use Ctrl+C to close)  
INFO    :   
INFO    : Navigate to the link below to see your app in the browser  
INFO    :     https://cloud.viktor.ai/workspaces/XXX/app  
INFO    :   
INFO    : App code loaded, waiting for jobs...  

```

--------------------------------

### Get Workspace User Group by Id - Java Example

Source: https://docs.viktor.ai/docs/api/rest/workspaces-groups-read

This Java code demonstrates how to make an HTTP GET request to the VIKTOR API to retrieve workspace group details. It uses the Apache HttpClient library.

```java
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class ApiClient {

    public static void getWorkspaceGroup(String environment, String workspaceId, String groupId, String token) {
        try (CloseableHttpClient client = HttpClients.createDefault()) {
            HttpGet request = new HttpGet("https://" + environment + ".viktor.ai/api/workspaces/" + workspaceId + "/groups/" + groupId + "/");
            request.addHeader("Authorization", "Bearer " + token);

            try (CloseableHttpResponse response = client.execute(request)) {
                System.out.println("Status Code: " + response.getStatusLine().getStatusCode());
                String responseBody = EntityUtils.toString(response.getEntity());
                System.out.println(responseBody);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Install VIKTOR Prerequisites

Source: https://docs.viktor.ai/docs/getting-started/installation/local-development-venv

Details the necessary software and versions required for VIKTOR installation. This includes specifying the required Python version and recommending code editors.

```English
Python 3.10 - 3.13 (64-bit)

Python can be downloaded from the official website:
Python can be installed using the local package manager.

Most popular editors recommended by VIKTOR are PyCharm and VS Code, but you are free to choose any editor!
```

--------------------------------

### Autoselect Python Installation in get-started

Source: https://docs.viktor.ai/docs/whats-new/changelog-cli

The `get-started` command now automatically selects a Python installation. It also prints the selected path and provides a hint on how to change it.

```Bash
get-started
```

--------------------------------

### Get Monthly Active Developers API Response Example (JSON)

Source: https://docs.viktor.ai/docs/api/rest/statistics-details-monthly-active-developers

This is an example of a successful JSON response from the Viktor AI API when retrieving monthly active developer data. It includes a count of all objects and an array of results, where each result contains a row_id, user details, and the date of activity.

```json
{
"count":0,
"results":[
{
"row_id":"string",
"user":{},
"date":"2024-06-11T11:45:44.589Z"
}
]
}
```

--------------------------------

### Get Current User in Workspace (Python)

Source: https://docs.viktor.ai/docs/api/rest/workspaces-users-current

Python example to fetch the current user's workspace details. This snippet shows how to make a GET request to the VIKTOR API, including necessary headers for authentication and content type.

```python
import requests

url = "https://<environment>.viktor.ai/api/workspaces/:workspace_id/users/current/"
headers = {
    "Accept": "application/json",
    "Authorization": "<API_KEY_VALUE>"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
```

--------------------------------

### Start VIKTOR App CLI

Source: https://docs.viktor.ai/docs/tutorials/process-etabs-data

This snippet shows the expected output from the VIKTOR CLI when starting an empty app. It indicates a successful connection to the cloud and provides a link to view the app in a browser. The app code is loaded and ready for further development.

```bash
INFO    : Connecting to cloud.viktor.ai...
INFO    : Connection is established (use Ctrl+C to close)
INFO    :   
INFO    : Navigate to the link below to see your app in the browser
INFO    :     https://cloud.viktor.ai/workspaces/XXX/app
INFO    :   
INFO    : App code loaded, waiting for jobs...

```

--------------------------------

### VIKTOR App Initialization (Shell)

Source: https://docs.viktor.ai/docs/tutorials/integrate-staadpro

Demonstrates the expected output from the VIKTOR CLI when starting a new, empty app. This output confirms the connection to the VIKTOR cloud environment and provides a link to access the running application in a web browser.

```Shell
INFO    : Connecting to cloud.viktor.ai...  
INFO    : Connection is established (use Ctrl+C to close)  
INFO    :   
INFO    : Navigate to the link below to see your app in the browser  
INFO    :     https://cloud.viktor.ai/workspaces/XXX/app  
INFO    :   
INFO    : App code loaded, waiting for jobs...  
```

--------------------------------

### Start Empty App with Viktor CLI

Source: https://docs.viktor.ai/docs/tutorials/app-type-editor

This snippet shows the expected output from the Viktor CLI when starting an empty app. It indicates a successful connection to the Viktor cloud and provides a link to access the app in the browser. It also confirms that the app code is loaded and ready for jobs.

```bash
INFO    : Connecting to cloud.viktor.ai...  
INFO    : Connection is established (use Ctrl+C to close)  
INFO    :   
INFO    : Navigate to the link below to see your app in the browser  
INFO    :     https://cloud.viktor.ai/workspaces/XXX/app  
INFO    :   
INFO    : App code loaded, waiting for jobs...  

```

--------------------------------

### VIKTOR API: Get Monthly Active Users Response Example (JSON)

Source: https://docs.viktor.ai/docs/api/rest/statistics-details-monthly-active-users

Provides an example of a successful JSON response when retrieving monthly active user data. The response includes the total count and an array of results, each containing a row ID, user details, and the date of activity.

```json
{
"count":0,
"results":[
{
"row_id":"string",
"user":{},
"date":"2024-06-11T11:45:44.590Z"
}
]
}
```

--------------------------------

### Get Workspace User Group by Id - Ruby Example

Source: https://docs.viktor.ai/docs/api/rest/workspaces-groups-read

A Ruby script demonstrating how to call the VIKTOR API to get a workspace group. It uses the 'httparty' gem for making HTTP requests and includes the necessary authentication token.

```ruby
require 'httparty'

url = "https://<environment>.viktor.ai/api/workspaces/:workspace_id/groups/:id/"
headers = {
  "Authorization" => "Bearer <token>"
}

response = HTTParty.get(url, headers: headers)

if response.code == 200
  puts response.parsed_response
else
  puts "Error: #{response.code}"
end
```

--------------------------------

### Get Job by Id - PHP Example

Source: https://docs.viktor.ai/docs/api/rest/jobs-read

Demonstrates how to retrieve job data using PHP, likely with cURL or file_get_contents. Includes setting headers and handling the response.

```php
// Example for PHP would go here, assuming a similar structure to CURL
```

--------------------------------

### Install Viktor AI Application

Source: https://docs.viktor.ai/docs/tutorials/app-type-simple

Installs the Viktor AI application in the terminal. This command is typically run after adding necessary requirements to the project.

```Shell
viktor-cli install
```

--------------------------------

### Viktor App: Terminal Output Example

Source: https://docs.viktor.ai/docs/tutorials/basic-3d-model

Example of the expected output in the terminal when a Viktor application is successfully connected and running. It shows connection status, the URL to view the app in a browser, and confirmation that the app code is loaded.

```Bash
INFO    : Connecting to cloud.viktor.ai...  
INFO    : Connection is established (use Ctrl+C to close)  
INFO    :   
INFO    : Navigate to the link below to see your app in the browser  
INFO    :     https://cloud.viktor.ai/workspaces/XXX/app  
INFO    :   
INFO    : App code loaded, waiting for jobs...  


```

--------------------------------

### Configure SCIA Engineer Worker Installation

Source: https://docs.viktor.ai/docs/manage-apps/software-integrations

Steps to install and configure the VIKTOR worker for SCIA Engineer, including creating a user account, enabling automatic logon, and starting the worker application.

```bash
1. Create a new user account with appropriate access rights.
2. Enable automatic logon for the account created in step 1.
3. Install the VIKTOR worker using the provided Windows Installer (.msi file).
4. Start the VIKTOR worker application from the Desktop or Start menu shortcut.
5. Optionally, create a scheduled task for the VIKTOR worker, ensuring it runs under the created user account and 'only when the user is logged on'.
```

--------------------------------

### Viktor AI API - Get Entities Request Example (cURL)

Source: https://docs.viktor.ai/docs/api/rest/workspaces-entity-types-entities-read

This cURL command demonstrates how to make a GET request to the Viktor AI API to retrieve entities. It includes the necessary headers for authentication and content acceptance, targeting a specific workspace and entity type.

```curl
curl -L 'https://<environment>.viktor.ai/api/workspaces/:workspace_id/entity_types/:id/entities/' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
```

--------------------------------

### Start Viktor App

Source: https://docs.viktor.ai/docs/tutorials/spreadsheet-calculator

This snippet shows the expected output from the Viktor CLI when an app is successfully started and connected to the cloud. It provides the URL to access the app in a browser and indicates that the app is waiting for jobs. It also mentions how to close the connection using Ctrl+C.

```Bash
INFO    : Connecting to cloud.viktor.ai...  
INFO    : Connection is established (use Ctrl+C to close)  
INFO    :   
INFO    : Navigate to the link below to see your app in the browser  
INFO    :     https://cloud.viktor.ai/workspaces/XXX/app  
INFO    :   
INFO    : App code loaded, waiting for jobs...  

```

--------------------------------

### VIKTOR API: Get File by Id (cURL)

Source: https://docs.viktor.ai/docs/api/rest/workspaces-files-read

Example of how to fetch a file by its ID using cURL. It includes the necessary headers for authentication and content acceptance, along with the endpoint URL.

```shell
curl -L 'https://<environment>.viktor.ai/api/workspaces/:workspace_id/files/:id/' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
```

--------------------------------

### Start Viktor Application

Source: https://docs.viktor.ai/docs/create-apps/references/cli

Starts the Viktor application, connects it to the platform, and makes it available for local development in the browser. The process can be terminated by pressing CTRL+C. It supports various flags for configuration, including app directory, autoreload settings, custom DNS, environment variables, memory limits, region specification, and volume mounting.

```bash
viktor-cli start [flags]
  
  Flags:
      --app-dir string                          Path to the directory that contains the app code (default: current working directory). (default ".")  
      --autoreload                              Deprecated: autoreload is enabled by default and can be disabled with the '--no-autoreload' flag  
      --dns 1.1.1.1                             (Docker only) Custom DNS servers (e.g. 1.1.1.1) (default [])  
      --echo-command                            Only echo command, no execution  
  -e, --env FOO=foo                             Additional environment variables (e.g. FOO=foo) (default [])  
  -h, --help                                    help for start  
      --max-memory 500                          (Docker only) Memory limit of the container in megabytes (e.g. 500) (default 500)  
      --no-autoreload                           Do not automatically reload code upon file changes  
      --region us1                              Specify the region in case of a multi-region organization if different than the default defined in the configuration file (e.g. us1)  
      --registered-name string                  Registered name of the app (see 'viktor-cli apps') to connect to. When not defined, the 'registered_name' in the viktor.config.toml file be used.  
      --silence-warnings                        Silence all (deprecation) warnings on the command-line  
  -v, --volume {HOSTVOLUME}:{CONTAINERVOLUME}   (Docker only) Additional volumes in container. Formatted as {HOSTVOLUME}:{CONTAINERVOLUME} (e.g. `/host/volume/path:/usr/src/docs`)  


```

--------------------------------

### GitPod Configuration for VIKTOR CLI

Source: https://docs.viktor.ai/docs/getting-started/installation/cloud-based-development

This snippet configures a GitPod workspace to download and set up the VIKTOR CLI. It uses a `.gitpod.yml` file to define tasks that fetch the CLI binary, make it executable, move it to the workspace, and add it to the system's PATH.

```yaml
tasks:
-name: VIKTOR
init:|
      curl -Lo viktor-cli 'https://sys.viktor.ai/api/v1/get-cli/?platform=linux&format=binary'
      chmod +x viktor-cli
      mv viktor-cli /workspace/viktor-cli
command:|
      echo "export PATH=$PATH:/workspace" >> ~/.bashrc
      source ~/.bashrc

```

--------------------------------

### Jinja2 Template Rendering Example

Source: https://docs.viktor.ai/docs/create-apps/documents-and-spreadsheets/text-file-templater

Demonstrates a basic example of how to use Jinja2 to create and render a simple template with a given context. This illustrates the core concept of templating.

```Python
from jinja2 import Template

template = Template('Hello {{ name }}!')
result = template.render({'name':'John Doe'})
print(result)
```

--------------------------------

### Get Current User in Workspace (Go)

Source: https://docs.viktor.ai/docs/api/rest/workspaces-users-current

Go language example for retrieving current user information from the VIKTOR API. It illustrates setting up the request with headers and handling the JSON response.

```go
package main

import (
	"fmt"
	"io/ioutil"
	"net/http"
	"strings"
)

func main() {
	url := "https://<environment>.viktor.ai/api/workspaces/:workspace_id/users/current/"
	client := &http.Client{}

	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		fmt.Println("Error creating request:", err)
		return
	}

	req.Header.Add("Accept", "application/json")
	req.Header.Add("Authorization", "<API_KEY_VALUE>")

	res, err := client.Do(req)
	if err != nil {
		fmt.Println("Error sending request:", err)
		return
	}
	defer res.Body.Close()

	body, err := ioutil.ReadAll(res.Body)
	if err != nil {
		fmt.Println("Error reading response body:", err)
		return
	}

	fmt.Println(string(body))
}
```

--------------------------------

### Get Job by Id - Python Example

Source: https://docs.viktor.ai/docs/api/rest/jobs-read

Demonstrates how to fetch job details using Python's requests library. Includes setting the API endpoint, headers, and handling the JSON response.

```python
# Example for Python would go here, assuming a similar structure to CURL
```

--------------------------------

### Install Viktor App and Dependencies

Source: https://docs.viktor.ai/docs/create-apps/references/cli

Installs the VIKTOR platform and application dependencies. It's recommended to reinstall when `requirements.txt` changes. Supports custom connector versions, DNS servers, environment variables, memory limits, and package manager choices (pip/uv).

```bash
viktor-cli install [flags]

Flags:
      --app-dir string    Path to the directory that contains the app code (default: current working directory). (default ".")
      --connector 5.2.0   (NOT recommended) Custom connector version (e.g. 5.2.0) (default "latest")
      --dns 1.1.1.1       Custom DNS servers (e.g. 1.1.1.1) (default [])
  -e, --env FOO=foo       Additional environment variables (e.g. FOO=foo) (default [])
  -h, --help              help for install
      --max-memory 500    (Docker only) Memory limit of the container in megabytes (e.g. 500) (default 500)
      --use-pip           Use this flag to enable installation using 'pip' instead of the default 'uv' as package manager
      --use-truststore    Use this flag to enable/disable installation of the app using the system truststore for HTTPS certificate
                          verification instead of the bundled certifi certificates of pip (e.g. --use-truststore=false) (default true)
```

--------------------------------

### Get Current User in Workspace (C#)

Source: https://docs.viktor.ai/docs/api/rest/workspaces-users-current

C# example using HttpClient to retrieve current user information from the VIKTOR API. Demonstrates setting request headers for authentication and content type.

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;

public class ApiClient
{
    public static async Task GetCurrentUserAsync(string environment, string apiKey)
    {
        using (var client = new HttpClient())
        {
            var url = $"https://{environment}.viktor.ai/api/workspaces/:workspace_id/users/current/";
            client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
            client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", apiKey);

            try
            {
                HttpResponseMessage response = await client.GetAsync(url);
                response.EnsureSuccessStatusCode(); // Throw if HTTP status code is not 2xx
                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            }
            catch (HttpRequestException e)
            {
                Console.WriteLine($"Request error: {e.Message}");
            }
        }
    }
}
```

--------------------------------

### Initialize Viktor App with Text Field

Source: https://docs.viktor.ai/docs/getting-started/starter-guide

Initializes a basic Viktor AI application with a welcome text message using the vkt.Text component within the Parametrization class.

```Python
import viktor as vkt  


class Parametrization(vkt.Parametrization):
    welcome = vkt.Text("# 👋 Welcome to your first VIKTOR app! 👋\n## Let's start with the basics")  


class Controller(vkt.Controller):
    parametrization = Parametrization  
```

--------------------------------

### VIKTOR CLI Apps Command

Source: https://docs.viktor.ai/docs/create-apps/references/cli

Lists applications connected to your VIKTOR development account. This command accepts flags, including a help flag.

```bash
viktor-cli apps [flags]  
  
Flags:  
  -h, --help   help for apps  

```

--------------------------------

### API Validation Error Response Example (JSON)

Source: https://docs.viktor.ai/docs/api/rest/workspaces-groups-list

Illustrates a typical JSON response when a validation error occurs during the 'Get All Workspace Groups' API request. It shows how field-specific and non-field errors are reported.

```json
{
    "field1": ["Validation error"],
    "non_field_errors": ["Sample non field validation error"]
}
```

--------------------------------

### API Statistics Request (PowerShell)

Source: https://docs.viktor.ai/docs/api/rest/statistics-list

Example of how to make a request to the Viktor AI statistics API using PowerShell. It utilizes Invoke-RestMethod to send the GET request with appropriate headers and parameters.

```powershell
$environment = "<environment>"
$apiKey = "<API_KEY_VALUE>"
$statsType = "users" # or "developers", "workspaces"
$startDate = "YYYY-MM-DD"
$endDate = "YYYY-MM-DD"

$uri = "https://$environment.viktor.ai/api/statistics?stats_type=$statsType&start=$startDate&end=$endDate"

$headers = @{
    "Accept" = "application/json"
    "Authorization" = "Bearer $apiKey"
}

try {
    $response = Invoke-RestMethod -Uri $uri -Method Get -Headers $headers
    Write-Host "Response:" -ForegroundColor Green
    $response | ConvertTo-Json -Depth 10
} catch {
    Write-Host "Error: $($_.Exception.Message)" -ForegroundColor Red
    if ($_.Exception.Response) {
        $errorResponse = $_.Exception.Response.GetResponseStream()
        $reader = New-Object System.IO.StreamReader($errorResponse)
        $reader.BaseStream.Position = 0
        $reader. វា = $false
        $errorMessage = $reader.ReadToEnd()
        Write-Host "Error Details: $errorMessage" -ForegroundColor Red
    }
}
```

--------------------------------

### Add Introductory Text to Parametrization

Source: https://docs.viktor.ai/docs/tutorials/basic-3d-model

This code adds an introductory text field to the VIKTOR application's parametrization. This text can include markdown for formatting and provide instructions or information to the user.

```Python
import viktor as vkt

classParametrization(vkt.Parametrization):
    intro_text = vkt.Text(
        "# 3D Parametric Building App 🏢\n\n" 
        "In this app, the user can change the dimensions of the building, choose the amount of floors and a color for the facade. The app will generate a 3D building for the user as output."
    )

```
Tokens:
Raw