Start learning process by web urls

It is important to point out that when learning via a website, you can specify the nesting level for searching links from 0 to 3 or set a general limit of pages for analysis.

Parameters


"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).

"limit" – sets the number of context chunks that are sent to the model for analysis and response formation. The default value is 4.

"offset" – used for pagination of the response on the backend. By default, it is not used.

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

Returns


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

/rest/v1/projects/{id}/training/website/
Example
{
  "omni_key": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoiNGFiNDUyYTMtNGMwYi00MTIyLWI3NDgtYzk4MWRiN2VlYWFlIiwiZGVmYXVsdFJvbGUiOiJ1c2VyIiwiYWxsb3dlZFJvbGVzIjpbInVzZXIiLCJtZSJdfSwiaWF0IjoxNzE0MzgxNzM4LCJleHAiOjE3NDU5MzkzMzgsInN1YiI6IjRhYjQ1MmEzLTRjMGItNDEyMi1iNzQ4LWM5ODFkYjdlZWFhZSJ9.EFa4TEFmXrSdUX7X6rrfbFSy2xP78YEhHSRWUid9hMo",
  "nowait": true,
  "urls": [
    "https://adjoe.ai/"
  ],
  "level": 0,
  "limit": 0,
  "metadata": {}
}
Schema
{
  omni_key:	string,
  nowait:	boolean,
  urls:	[
        minItems: 1 {
        }]
  level:	number,
  limit:	number
  metadata {  }
}

Responses

Successful operation

Example
[
    {
        "id": "23f37f8a-df8c-4c8c-9598-8a088c62c198"
    }
]
Schema
{
oneOf ->	[TrainingAsyncResponse{
                        id:	string($uuid)
          }]
              [TrainingSyncResponse{
                        results:	string($json)
              }]
}
Was this article helpful to you? Yes No

How can we help?