> For the complete documentation index, see [llms.txt](https://allqueue.gitbook.io/allq/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://allqueue.gitbook.io/allq/scenarios.md).

# Scenarios

These are the simplest of scenarios for AllQ

## Put something on the queue

You would POST your job data to the REST API via /job endpoint with JSON body

## Create Job

<mark style="color:green;">`POST`</mark> `http://localhost:8090/job`

Puts a job on the queue

{% tabs %}
{% tab title="200 " %}

```
{
  "job_id": "string"
}
```

{% endtab %}
{% endtabs %}

```
{
  "tube": "<TUBE NAME>", # REQUIRED
  "body": "<BODY_TEXT>", # REQUIRED
  "ttl": 1200,
  "delay": 0,
  "priority": 5,
  "parent_id": "string"
}
```

## Get job off the queue

<mark style="color:blue;">`GET`</mark> `http://localhost:8090/job`

#### Path Parameters

| Name | Type   | Description   |
| ---- | ------ | ------------- |
| tube | string | Name  of tube |

{% tabs %}
{% tab title="200 " %}

```
{
  "id": "string",
  "body": "string",
  "tube": "string",
  "expireds": 0,
  "releases": 0
}
```

{% endtab %}
{% endtabs %}

### Mark a job as done

<mark style="color:red;">`DELETE`</mark> `http://localhost:8090/job`

#### Path Parameters

| Name    | Type   | Description                |
| ------- | ------ | -------------------------- |
| job\_id | string | Id of job you are deleting |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}