Classify the project and return the scanner result.
Always runs the scanner so the response carries truthful
has_python_files / has_idun_config / detected values
even when an agent row already exists — useful for direct-curl
callers inspecting state. When the row exists, current_agent
is populated so the UI can short-circuit to chat without a
follow-up GET /agent call.
curl --request POST \
--url https://api.example.com/admin/api/v1/onboarding/scanimport requests
url = "https://api.example.com/admin/api/v1/onboarding/scan"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/admin/api/v1/onboarding/scan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/admin/api/v1/onboarding/scan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/admin/api/v1/onboarding/scan"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/admin/api/v1/onboarding/scan")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/admin/api/v1/onboarding/scan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"scanResult": {
"root": "<string>",
"detected": [
{
"filePath": "<string>",
"variableName": "<string>",
"inferredName": "<string>"
}
],
"hasPythonFiles": true,
"hasIdunConfig": true,
"scanDurationMs": 123
},
"currentAgent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"baseEngineConfig": {
"agent": {
"config": {
"name": "<string>",
"graph_definition": "<string>",
"observability": {
"provider": "<string>",
"enabled": false,
"options": {}
},
"checkpointer": {
"type": "<string>",
"db_url": "<string>"
},
"store": {}
}
},
"server": {
"api": {
"port": 8000
}
},
"mcpServers": [
{
"name": "<string>",
"transport": "streamable_http",
"url": "<string>",
"command": "<string>",
"args": [
"<string>"
],
"headers": {},
"env": {},
"cwd": "<string>",
"encoding": "<string>",
"timeoutSeconds": 123,
"sseReadTimeoutSeconds": 123,
"terminateOnClose": true,
"sessionKwargs": {}
}
],
"guardrails": {
"input": [
{
"banned_words": [
"<string>"
],
"config_id": "ban_list",
"api_key": "",
"reject_message": "ban!!",
"guard_url": "hub://guardrails/ban_list"
}
],
"output": [
{
"banned_words": [
"<string>"
],
"config_id": "ban_list",
"api_key": "",
"reject_message": "ban!!",
"guard_url": "hub://guardrails/ban_list"
}
]
},
"observability": [
{
"config": {
"provider": "LANGFUSE",
"host": "https://cloud.langfuse.com",
"publicKey": "",
"secretKey": "",
"runName": ""
},
"provider": "LANGFUSE",
"enabled": true
}
],
"sso": {
"issuer": "<string>",
"clientId": "<string>",
"enabled": true,
"audience": "<string>",
"allowedDomains": [
"<string>"
],
"allowedEmails": [
"<string>"
]
},
"integrations": [
{
"config": {
"accessToken": "<string>",
"phoneNumberId": "<string>",
"verifyToken": "<string>",
"apiVersion": "v21.0"
},
"enabled": true
}
],
"prompts": [
{
"promptId": "<string>",
"version": 123,
"content": "<string>",
"tags": [
"<string>"
]
}
]
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"slug": "<string>",
"description": "<string>",
"version": "<string>",
"baseUrl": "<string>"
}
}Response
Successful Response
Response for POST /admin/api/v1/onboarding/scan.
The five-state classification is computed server-side from the
scan result plus the agent row's existence. current_agent is
only populated when state == "ALREADY_CONFIGURED".
EMPTY, NO_SUPPORTED, ONE_DETECTED, MANY_DETECTED, ALREADY_CONFIGURED Aggregate result of a single scan_folder call.
Show child attributes
Show child attributes
GET response and the data payload of PATCH responses.
Show child attributes
Show child attributes
Was this page helpful?
curl --request POST \
--url https://api.example.com/admin/api/v1/onboarding/scanimport requests
url = "https://api.example.com/admin/api/v1/onboarding/scan"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/admin/api/v1/onboarding/scan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/admin/api/v1/onboarding/scan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/admin/api/v1/onboarding/scan"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/admin/api/v1/onboarding/scan")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/admin/api/v1/onboarding/scan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"scanResult": {
"root": "<string>",
"detected": [
{
"filePath": "<string>",
"variableName": "<string>",
"inferredName": "<string>"
}
],
"hasPythonFiles": true,
"hasIdunConfig": true,
"scanDurationMs": 123
},
"currentAgent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"baseEngineConfig": {
"agent": {
"config": {
"name": "<string>",
"graph_definition": "<string>",
"observability": {
"provider": "<string>",
"enabled": false,
"options": {}
},
"checkpointer": {
"type": "<string>",
"db_url": "<string>"
},
"store": {}
}
},
"server": {
"api": {
"port": 8000
}
},
"mcpServers": [
{
"name": "<string>",
"transport": "streamable_http",
"url": "<string>",
"command": "<string>",
"args": [
"<string>"
],
"headers": {},
"env": {},
"cwd": "<string>",
"encoding": "<string>",
"timeoutSeconds": 123,
"sseReadTimeoutSeconds": 123,
"terminateOnClose": true,
"sessionKwargs": {}
}
],
"guardrails": {
"input": [
{
"banned_words": [
"<string>"
],
"config_id": "ban_list",
"api_key": "",
"reject_message": "ban!!",
"guard_url": "hub://guardrails/ban_list"
}
],
"output": [
{
"banned_words": [
"<string>"
],
"config_id": "ban_list",
"api_key": "",
"reject_message": "ban!!",
"guard_url": "hub://guardrails/ban_list"
}
]
},
"observability": [
{
"config": {
"provider": "LANGFUSE",
"host": "https://cloud.langfuse.com",
"publicKey": "",
"secretKey": "",
"runName": ""
},
"provider": "LANGFUSE",
"enabled": true
}
],
"sso": {
"issuer": "<string>",
"clientId": "<string>",
"enabled": true,
"audience": "<string>",
"allowedDomains": [
"<string>"
],
"allowedEmails": [
"<string>"
]
},
"integrations": [
{
"config": {
"accessToken": "<string>",
"phoneNumberId": "<string>",
"verifyToken": "<string>",
"apiVersion": "v21.0"
},
"enabled": true
}
],
"prompts": [
{
"promptId": "<string>",
"version": 123,
"content": "<string>",
"tags": [
"<string>"
]
}
]
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"slug": "<string>",
"description": "<string>",
"version": "<string>",
"baseUrl": "<string>"
}
}