Create background job

POST

/api/v1/projects/{project_id}/jobs

Queues a new background job (generation or sync) for a project. Validates XCT balance for generation jobs and store connection for sync jobs, and rejects the request if a conflicting job is already active.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"job_type": "string",

  

"payload": {

  

  

"additionalProperties": "string"

  

}

}

Responses

Successful Response

Content-Type

application/json

{

  

"job_id": "string",

  

"status": "string"

}

POST

/api/v1/projects/{project_id}/jobs

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Body

Samples

Powered by VitePress OpenAPI