Skip to main content
POST
/
3d
/
jobs
Create a job using 3D source data
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "space": "<string>",
      "externalId": "<string>",
      "name": "<string>",
      "type": "Optimizer",
      "source": {
        "type": "CogniteFile",
        "instanceId": {
          "space": "<string>",
          "externalId": "<string>"
        }
      },
      "configuration": {
        "pipelineConfiguration": {
          "version": "v1",
          "indexingOptions": {
            "generateTiles": false,
            "tileSize": 5,
            "rotationAngleInDegrees": 0,
            "useBlackFilter": false,
            "useDistanceFilter": false,
            "maxDistance": 30,
            "useIntensityFilter": false,
            "minIntensity": -1,
            "useDensityFilter": false,
            "filterVoxelSize": 0.01,
            "minNumberOfPointsInVoxel": 1,
            "densityFilterMethod": 2,
            "colorFilterMethod": 1,
            "outlierFilterType": 1,
            "separationDistance": 5,
            "minNumberOfPointsInOneCluster": 100
          },
          "processTilesOptions": {
            "minimumRadius": 0.02,
            "classificationMethod": "28class",
            "usePipeDetection": true,
            "useConfidence": true,
            "usePointSources": true,
            "saveAnnotations": true
          }
        }
      },
      "nonce": "<string>"
    }
  ]
}
'
import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/jobs"

payload = { "items": [
{
"space": "<string>",
"externalId": "<string>",
"name": "<string>",
"type": "Optimizer",
"source": {
"type": "CogniteFile",
"instanceId": {
"space": "<string>",
"externalId": "<string>"
}
},
"configuration": { "pipelineConfiguration": {
"version": "v1",
"indexingOptions": {
"generateTiles": False,
"tileSize": 5,
"rotationAngleInDegrees": 0,
"useBlackFilter": False,
"useDistanceFilter": False,
"maxDistance": 30,
"useIntensityFilter": False,
"minIntensity": -1,
"useDensityFilter": False,
"filterVoxelSize": 0.01,
"minNumberOfPointsInVoxel": 1,
"densityFilterMethod": 2,
"colorFilterMethod": 1,
"outlierFilterType": 1,
"separationDistance": 5,
"minNumberOfPointsInOneCluster": 100
},
"processTilesOptions": {
"minimumRadius": 0.02,
"classificationMethod": "28class",
"usePipeDetection": True,
"useConfidence": True,
"usePointSources": True,
"saveAnnotations": True
}
} },
"nonce": "<string>"
}
] }
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({
items: [
{
space: '<string>',
externalId: '<string>',
name: '<string>',
type: 'Optimizer',
source: {type: 'CogniteFile', instanceId: {space: '<string>', externalId: '<string>'}},
configuration: {
pipelineConfiguration: {
version: 'v1',
indexingOptions: {
generateTiles: false,
tileSize: 5,
rotationAngleInDegrees: 0,
useBlackFilter: false,
useDistanceFilter: false,
maxDistance: 30,
useIntensityFilter: false,
minIntensity: -1,
useDensityFilter: false,
filterVoxelSize: 0.01,
minNumberOfPointsInVoxel: 1,
densityFilterMethod: 2,
colorFilterMethod: 1,
outlierFilterType: 1,
separationDistance: 5,
minNumberOfPointsInOneCluster: 100
},
processTilesOptions: {
minimumRadius: 0.02,
classificationMethod: '28class',
usePipeDetection: true,
useConfidence: true,
usePointSources: true,
saveAnnotations: true
}
}
},
nonce: '<string>'
}
]
})
};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/jobs', 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://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/jobs",
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([
'items' => [
[
'space' => '<string>',
'externalId' => '<string>',
'name' => '<string>',
'type' => 'Optimizer',
'source' => [
'type' => 'CogniteFile',
'instanceId' => [
'space' => '<string>',
'externalId' => '<string>'
]
],
'configuration' => [
'pipelineConfiguration' => [
'version' => 'v1',
'indexingOptions' => [
'generateTiles' => false,
'tileSize' => 5,
'rotationAngleInDegrees' => 0,
'useBlackFilter' => false,
'useDistanceFilter' => false,
'maxDistance' => 30,
'useIntensityFilter' => false,
'minIntensity' => -1,
'useDensityFilter' => false,
'filterVoxelSize' => 0.01,
'minNumberOfPointsInVoxel' => 1,
'densityFilterMethod' => 2,
'colorFilterMethod' => 1,
'outlierFilterType' => 1,
'separationDistance' => 5,
'minNumberOfPointsInOneCluster' => 100
],
'processTilesOptions' => [
'minimumRadius' => 0.02,
'classificationMethod' => '28class',
'usePipeDetection' => true,
'useConfidence' => true,
'usePointSources' => true,
'saveAnnotations' => true
]
]
],
'nonce' => '<string>'
]
]
]),
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://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/jobs"

payload := strings.NewReader("{\n \"items\": [\n {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"Optimizer\",\n \"source\": {\n \"type\": \"CogniteFile\",\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"configuration\": {\n \"pipelineConfiguration\": {\n \"version\": \"v1\",\n \"indexingOptions\": {\n \"generateTiles\": false,\n \"tileSize\": 5,\n \"rotationAngleInDegrees\": 0,\n \"useBlackFilter\": false,\n \"useDistanceFilter\": false,\n \"maxDistance\": 30,\n \"useIntensityFilter\": false,\n \"minIntensity\": -1,\n \"useDensityFilter\": false,\n \"filterVoxelSize\": 0.01,\n \"minNumberOfPointsInVoxel\": 1,\n \"densityFilterMethod\": 2,\n \"colorFilterMethod\": 1,\n \"outlierFilterType\": 1,\n \"separationDistance\": 5,\n \"minNumberOfPointsInOneCluster\": 100\n },\n \"processTilesOptions\": {\n \"minimumRadius\": 0.02,\n \"classificationMethod\": \"28class\",\n \"usePipeDetection\": true,\n \"useConfidence\": true,\n \"usePointSources\": true,\n \"saveAnnotations\": true\n }\n }\n },\n \"nonce\": \"<string>\"\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://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"Optimizer\",\n \"source\": {\n \"type\": \"CogniteFile\",\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"configuration\": {\n \"pipelineConfiguration\": {\n \"version\": \"v1\",\n \"indexingOptions\": {\n \"generateTiles\": false,\n \"tileSize\": 5,\n \"rotationAngleInDegrees\": 0,\n \"useBlackFilter\": false,\n \"useDistanceFilter\": false,\n \"maxDistance\": 30,\n \"useIntensityFilter\": false,\n \"minIntensity\": -1,\n \"useDensityFilter\": false,\n \"filterVoxelSize\": 0.01,\n \"minNumberOfPointsInVoxel\": 1,\n \"densityFilterMethod\": 2,\n \"colorFilterMethod\": 1,\n \"outlierFilterType\": 1,\n \"separationDistance\": 5,\n \"minNumberOfPointsInOneCluster\": 100\n },\n \"processTilesOptions\": {\n \"minimumRadius\": 0.02,\n \"classificationMethod\": \"28class\",\n \"usePipeDetection\": true,\n \"useConfidence\": true,\n \"usePointSources\": true,\n \"saveAnnotations\": true\n }\n }\n },\n \"nonce\": \"<string>\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/jobs")

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 \"items\": [\n {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"Optimizer\",\n \"source\": {\n \"type\": \"CogniteFile\",\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"configuration\": {\n \"pipelineConfiguration\": {\n \"version\": \"v1\",\n \"indexingOptions\": {\n \"generateTiles\": false,\n \"tileSize\": 5,\n \"rotationAngleInDegrees\": 0,\n \"useBlackFilter\": false,\n \"useDistanceFilter\": false,\n \"maxDistance\": 30,\n \"useIntensityFilter\": false,\n \"minIntensity\": -1,\n \"useDensityFilter\": false,\n \"filterVoxelSize\": 0.01,\n \"minNumberOfPointsInVoxel\": 1,\n \"densityFilterMethod\": 2,\n \"colorFilterMethod\": 1,\n \"outlierFilterType\": 1,\n \"separationDistance\": 5,\n \"minNumberOfPointsInOneCluster\": 100\n },\n \"processTilesOptions\": {\n \"minimumRadius\": 0.02,\n \"classificationMethod\": \"28class\",\n \"usePipeDetection\": true,\n \"useConfidence\": true,\n \"usePointSources\": true,\n \"saveAnnotations\": true\n }\n }\n },\n \"nonce\": \"<string>\"\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "space": "<string>",
      "externalId": "<string>",
      "name": "<string>",
      "type": "ImageTextDetection",
      "source": {
        "type": "Cognite360ImageCollection",
        "instanceId": {
          "space": "<string>",
          "externalId": "<string>"
        }
      },
      "configuration": {},
      "createdAt": 123
    }
  ]
}
{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Body

application/json

The job with a given source. Currently supports only one job to be created at the time.

items
object[]
required
Required array length: 1 element

Response

A list of the created jobs

items
object[]
required
Last modified on July 10, 2026