opus-03-initiate-job.md•1.19 kB
# Initiate Job
**POST** /job/initiate _(Given workflow initiates a job)_
This step creates a job instance in the system and returns the unique ID `jobExecutionId` required for execution and monitoring.
---
## Parameters
**workflowId** *required* `string`
- ID of the workflow to be used for your job
**title** *required* `string`
- your chosen job title
**description** *required* `string`
- your chosen job description
**Headers**
- x-service-key: `<your_service_key>`
---
## Request Body
**Media Type:** `application/json`
### Example Value
```json
{
"workflowId": "your_workflow_id_here",
"title": "your_chosen_job_title_here",
"description": "your_chosen_job_description_here"
}
```
### Schema:
```json
{
"workflowId": "string", // The ID of the workflow to execute
"title": "string", // Job title
"description": "string" // Job description
}
```
---
## Responses
**Code:** `201`
**Media Type:** `application/json` *Controls Accept header
### Example Value
```json
{
"jobExecutionId": "string"
}
```
### Schema:
```json
{
"jobExecutionId": "string" // Job execution ID
}
```
**You must save this `jobExecutionId` for all subsequent steps.**