Create job

Create a generation job

POST /api/v1/configurator/jobs

cURL

cURL

curl --request POST \
  --url https://api.staging.qyl.dev/api/v1/configurator/jobs \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "<string>",
  "profile_id": "<string>"
}
'

import requests

url = "https://api.staging.qyl.dev/api/v1/configurator/jobs"

payload = {
    "workspace_id": "<string>",
    "profile_id": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({workspace_id: '<string>', profile_id: '<string>'})
};

fetch('https://api.staging.qyl.dev/api/v1/configurator/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://api.staging.qyl.dev/api/v1/configurator/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([
    'workspace_id' => '<string>',
    'profile_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.staging.qyl.dev/api/v1/configurator/jobs"

	payload := strings.NewReader("{\n  \"workspace_id\": \"<string>\",\n  \"profile_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.staging.qyl.dev/api/v1/configurator/jobs")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspace_id\": \"<string>\",\n  \"profile_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.staging.qyl.dev/api/v1/configurator/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspace_id\": \"<string>\",\n  \"profile_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "workspace_id": "<string>",
  "profile_id": "<string>",
  "priority": 123,
  "queued_at": "2023-11-07T05:31:56Z",
  "input_hash": "<string>",
  "output_path": "<string>",
  "output_hash": "<string>",
  "error_message": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "duration_ms": 123
}

{
  "type": "about:blank",
  "title": "Validation Failed",
  "status": 123,
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>",
      "rejected_value": "<string>"
    }
  ],
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "error_code": "<string>"
}

Body

application/json

Generation job creation request

workspace_id · string · required

Workspace ID

profile_id · string · required

Profile ID

job_type · enum<string> · required

Job type

Available options: full, incremental, preview

Response

200

application/json

The request has succeeded.

Code generation job entry

id · string · required

Job ID

workspace_id · string · required

Workspace

profile_id · string · required

Profile

job_type · enum<string> · required

Job type

Available options: full, incremental, preview

status · enum<string> · required

Job status

Available options: queued, running, completed, failed, cancelled

priority · integer<int32> · required

Priority (higher = more urgent)

queued_at · string<date-time> · required

Queue timestamp

input_hash · string

Hash of inputs for dedup

output_path · string

Local path where output was written

output_hash · string

Hash of generated output

error_message · string

Error message if failed

started_at · string<date-time>

Start timestamp

completed_at · string<date-time>

Completion timestamp

duration_ms · integer<int32>

Duration in milliseconds