# Request a new job

`POST /api/v1/runners/jobs/request`

API used by PeerTube runners

Authentication: no security requirement declared for this operation.

Request body: application/json

Type: object

- `runnerToken` (required)
  Type: string

- `jobTypes` (optional)
  Type: Array<string>
  
  Filter jobs depending on their types
  
  Items:
    Type: string

Responses:

- 200: successful operation

Content type: application/json

Type: object

- `availableJobs` (optional)
  Type: Array<object>
  
  Items:
    Type: object
    
    - `uuid` (optional)
      Reference: [UUIDv4](https://sourcey-peertube.pages.dev/api-rest-reference/models/uuidv4.md); Type: UUIDv4, uuid
      
      minLength: 36
      
      maxLength: 36
      
      pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      
      Example:
      
      ```json
      "9c9de5e8-0a1e-484a-b099-e80766180a6d"
      ```
    
    - `type` (optional)
      Reference: [RunnerJobType](https://sourcey-peertube.pages.dev/api-rest-reference/models/runnerjobtype.md); Type: RunnerJobType
      
      enum: ["vod-web-video-transcoding","vod-hls-transcoding","vod-audio-merge-transcoding","live-rtmp-hls-transcoding"]
    
    - `payload` (optional)
      Reference: [RunnerJobPayload](https://sourcey-peertube.pages.dev/api-rest-reference/models/runnerjobpayload.md); Type: object

## Examples

### cURL

```bash
curl -X POST 'https://peertube2.cpy.re/api/v1/runners/jobs/request' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "runnerToken": "string",
  "jobTypes": [
    "string"
  ]
}'
```

### JavaScript

```javascript
const body = `{
  "runnerToken": "string",
  "jobTypes": [
    "string"
  ]
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/runners/jobs/request', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();
```

### Python

```python
import requests

body = '''{
  "runnerToken": "string",
  "jobTypes": [
    "string"
  ]
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/runners/jobs/request',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)
```