Start project’s learning by file url

When training via a URL file, make sure that the file is publicly accessible on the Internet, otherwise you will receive an authorization error. Only direct links to a file are supported.


"omni_key" is the private key.
You can generate a personal key in your profile settings on the platform. Instructions on how to do this can be found here> API key

"nowait" parameter indicating whether the system should wait for a response before performing an action. Possible values: “true” (do not wait) or “false” (wait).

"title" optional. can be retrieved automatically from the file name or set directly in the request body

"url" Please specify the website from which you would like to obtain training materials.

"title" Please provide a title for the training.

"metadata" Refers to data that describes other data. Examples include information about the author, creation date, file size, and file format.


If the request is successful, you will receive an object with your project ID

  "omni_key": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoiNGFiNDUyYTMtNGMwYi00MTIyLWI3NDgtYzk4MWRiN2VlYWFlIiwiZGVmYXVsdFJvbGUiOiJ1c2VyIiwiYWxsb3dlZFJvbGVzIjpbInVzZXIiLCJtZSJdfSwiaWF0IjoxNzE0MzgxNzM4LCJleHAiOjE3NDU5MzkzMzgsInN1YiI6IjRhYjQ1MmEzLTRjMGItNDEyMi1iNzQ4LWM5ODFkYjdlZWFhZSJ9.EFa4TEFmXrSdUX7X6rrfbFSy2xP78YEhHSRWUid9hMo",
  "nowait": true,
  "url": "",
  "title": "description",
  "metadata": {
    "author": "ISTQB",
    "year": 2024,
    "category": "Certification"

omni_key:	"string",
nowait:	"boolean",
url: "string",
title:	"string",
metadata:	{ }



Successful operation

    "id": "39e024c6-3ba7-4c95-9c4d-58cca7c3b200"
oneOf ->	[TrainingAsyncResponse{
                        id:	string($uuid)
                        results:	string($json)
Was this article helpful to you? Yes No

How can we help?