AI edit a mapping
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/ai/edit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"instruction": "<string>",
"mapping_config": [
{}
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/ai/edit"
payload = {
"instruction": "<string>",
"mapping_config": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({instruction: '<string>', mapping_config: [{}]})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/ai/edit', 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://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/ai/edit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'instruction' => '<string>',
'mapping_config' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/ai/edit"
payload := strings.NewReader("{\n \"instruction\": \"<string>\",\n \"mapping_config\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/ai/edit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"instruction\": \"<string>\",\n \"mapping_config\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/ai/edit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"instruction\": \"<string>\",\n \"mapping_config\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"rows": [
{
"lumField": "<string>",
"pushField": "<string>",
"transformation": "<string>",
"transformationConfig": {}
}
],
"notes": "<string>",
"rejected": [
{
"index": 123,
"row": {},
"reason": "<string>"
}
]
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Integration Mappings
AI edit a mapping
Apply a natural-language change to the rows the editor currently has (saved or not) and return the complete updated row list; the editor diffs it against what is on screen.
Returns a proposal only — nothing is saved. Every proposed row is validated against
the transformation catalogue and the two schemas before being returned. Rows that fail
validation are dropped and listed in rejected.
Requires AI to be configured on the environment.
POST
/
integration-mappings
/
{id}
/
ai
/
edit
AI edit a mapping
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/ai/edit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"instruction": "<string>",
"mapping_config": [
{}
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/ai/edit"
payload = {
"instruction": "<string>",
"mapping_config": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({instruction: '<string>', mapping_config: [{}]})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/ai/edit', 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://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/ai/edit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'instruction' => '<string>',
'mapping_config' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/ai/edit"
payload := strings.NewReader("{\n \"instruction\": \"<string>\",\n \"mapping_config\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/ai/edit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"instruction\": \"<string>\",\n \"mapping_config\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/integration-mappings/{id}/ai/edit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"instruction\": \"<string>\",\n \"mapping_config\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"rows": [
{
"lumField": "<string>",
"pushField": "<string>",
"transformation": "<string>",
"transformationConfig": {}
}
],
"notes": "<string>",
"rejected": [
{
"index": 123,
"row": {},
"reason": "<string>"
}
]
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
Integration mapping ID
Body
application/json
Response
Successful response
Show child attributes
Show child attributes