Twin Creation Jobs

Base URL: https://app.neuroflash.com/api/digital-twin-service

Create Twin Creation Job

POST/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs

Path Parameters

Parameter	Type	Required	Description
`workspace_id`	string	Yes
`target_audience_id`	string	Yes

Request Body

numberOfTwinsToCreateintegerYesNumber of twins to create

Response

idstringUnique identifier

createdAtstringTimestamp when the record was created

updatedAtstringTimestamp when the record was last updated

createdByUserIdobjectID of the user who created this record

targetAudienceIdstringTarget audience ID this job creates twins for

createdTwinIdsarray<string>IDs of twins created by this job

finishedAtobjectWhen the job successfully finished processing

retriesintegerNumber of processing attempts. The job is retried up to 10 times

numberOfTwinsToCreateintegerHow many twins this job should create

successfulbooleanTrue if the job completed without errors

Example

cURL
Python
Node.js
Go

curl -X POST "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "numberOfTwinsToCreate": 0
  }'

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "numberOfTwinsToCreate": 0
    },
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/${workspaceId}/target-audiences/${targetAudienceId}/twin-creation-jobs`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "numberOfTwinsToCreate": 0
    }),
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{
		"numberOfTwinsToCreate": 0,
	})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/"+workspaceID+"/target-audiences/"+targetAudienceID+"/twin-creation-jobs", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Response:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "createdByUserId": "12345",
  "targetAudienceId": "string",
  "createdTwinIds": [
    "string"
  ],
  "finishedAt": {},
  "retries": 0,
  "numberOfTwinsToCreate": 0,
  "successful": false
}

List Twin Creation Jobs

GET/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs

Path Parameters

Parameter	Type	Required	Description
`workspace_id`	string	Yes
`target_audience_id`	string	Yes

Query Parameters

Parameter	Type	Default	Description
`page`	integer	`1`	Page number (1-based)
`size`	integer	`20`	Number of elements per page
`order`	string	—	Sort order

Response

dataarray<object>

idstringUnique identifier

createdAtstringTimestamp when the record was created

updatedAtstringTimestamp when the record was last updated

createdByUserIdobjectID of the user who created this record

targetAudienceIdstringTarget audience ID this job creates twins for

createdTwinIdsarray<string>IDs of twins created by this job

finishedAtobjectWhen the job successfully finished processing

retriesintegerNumber of processing attempts. The job is retried up to 10 times

numberOfTwinsToCreateintegerHow many twins this job should create

successfulbooleanTrue if the job completed without errors

pageobjectPagination metadata.

sizeintegerNumber of elements per page

totalElementsintegerTotal number of matching elements

totalPagesintegerTotal number of pages

currentPageintegerCurrent page number (1-based)

Example

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/${workspaceId}/target-audiences/${targetAudienceId}/twin-creation-jobs`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/"+workspaceID+"/target-audiences/"+targetAudienceID+"/twin-creation-jobs", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Response:

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "createdByUserId": "12345",
      "targetAudienceId": "string",
      "createdTwinIds": [
        "string"
      ],
      "finishedAt": {},
      "retries": 0,
      "numberOfTwinsToCreate": 0,
      "successful": false
    }
  ],
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "currentPage": 0
  }
}

Get Twin Creation Job

GET/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs/{job_id}

Path Parameters

Parameter	Type	Required
`workspace_id`	string	Yes
`target_audience_id`	string	Yes
`job_id`	string	Yes

Response

idstringUnique identifier

createdAtstringTimestamp when the record was created

updatedAtstringTimestamp when the record was last updated

createdByUserIdobjectID of the user who created this record

targetAudienceIdstringTarget audience ID this job creates twins for

createdTwinIdsarray<string>IDs of twins created by this job

finishedAtobjectWhen the job successfully finished processing

retriesintegerNumber of processing attempts. The job is retried up to 10 times

numberOfTwinsToCreateintegerHow many twins this job should create

successfulbooleanTrue if the job completed without errors

Example

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs/{job_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs/{job_id}",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/${workspaceId}/target-audiences/${targetAudienceId}/twin-creation-jobs/${jobId}`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/"+workspaceID+"/target-audiences/"+targetAudienceID+"/twin-creation-jobs/"+jobID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Response:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "createdByUserId": "12345",
  "targetAudienceId": "string",
  "createdTwinIds": [
    "string"
  ],
  "finishedAt": {},
  "retries": 0,
  "numberOfTwinsToCreate": 0,
  "successful": false
}

Create Twin Creation Job​

Path Parameters​

Request Body​

Response​

Example​

List Twin Creation Jobs​

Path Parameters​

Query Parameters​

Response​

Example​

Get Twin Creation Job​

Path Parameters​

Response​

Example​

Create Twin Creation Job

Path Parameters

Request Body

Response

Example

List Twin Creation Jobs

Path Parameters

Query Parameters

Response

Example

Get Twin Creation Job

Path Parameters

Response

Example