Create

---

Create a new job

post

Create a new computing job on ByteNite.

Authorizations

Body

application/jsonapplication/x-protobuf

If job id already exists and the request hasn't started the job record is updated, if job id is null a new id is generated.

jobIdstringOptional

Unique identifier for the job, automatically generated if left blank.

namestringOptional

Mnemonic name for the job.

templateIdstringRequired

Identifier of the application template used for this job.

descriptionstringOptional

Textual description of the job.

Responses

200

A successful response.

application/jsonapplication/x-protobuf

400

Returned when the users sends a malformed request.

application/jsonapplication/x-protobuf

401

Returned when the user is not authenticated.

application/jsonapplication/x-protobuf

403

Returned when the user does not have permission to access the resource.

application/jsonapplication/x-protobuf

404

Returned when the resource does not exist.

application/jsonapplication/x-protobuf

500

Returned when an error on the server occurred.

application/jsonapplication/x-protobuf

503

Returned when the resource is temporarily unavailable.

application/jsonapplication/x-protobuf

default

An unexpected error response.

application/jsonapplication/x-protobuf

post

HTTPcURLJavaScriptPython

POST /v1/customer/jobs HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "name": "My job",
  "templateId": "[email protected]"
}

application/jsonapplication/x-protobuf

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-05-09T16:31:55.080Z",
    "submittedAt": "2025-05-09T16:31:55.080Z",
    "startedAt": "2025-05-09T16:31:55.080Z",
    "endedAt": "2025-05-09T16:31:55.080Z",
    "regions": {
      "blacklist": [
        "text"
      ],
      "whitelist": [
        "text"
      ]
    },
    "state": "JOB_STATE_NEW",
    "dataSource": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "params": {
      "preset": "text",
      "partitioner": {},
      "assembler": {},
      "app": {}
    },
    "dataDestination": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "duration": 1,
    "deletedAt": "2025-05-09T16:31:55.080Z",
    "createdAt": "2025-05-09T16:31:55.080Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-05-09T16:31:55.080Z"
    },
    "appId": "text"
  },
  "templateInfo": {
    "id": "text",
    "owner": "text",
    "description": "text",
    "app": "text",
    "partitioner": "text",
    "assembler": "text"
  }
}