# Start a task group

- **OpenAPI Version:** `3.2.0`
- **API Version:** `3.1.0`
- **Contact:** Syndai <https://syndai.ai>

## Contents

**Operations**

- [POST /api/v1/external/coding/backlog/groups/{group\_id}/start](#scalar-operation-post-apiv1externalcodingbackloggroupsgroup-idstart)

**Schemas**

- [GroupPartRequest](#scalar-schema-grouppartrequest)
- [GroupRead](#scalar-schema-groupread)
- [GroupPartRead](#scalar-schema-grouppartread)
- [ProblemDetail](#scalar-schema-problemdetail)
- [ExternalErrorCode](#scalar-schema-externalerrorcode)

<a id="scalar-context-global-servers"></a>

## Servers

- **URL:** `https://api.syndai.ai`

<a id="scalar-context-global-authentication"></a>

## Authentication

- **CustomerApiKey**: HTTP bearer (`API Key`)

  Customer API key sent as a bearer token

## Tags

### Backlog

Work Syndai proposes for a repository: next-task offers and task groups you can add to the roadmap, edit, move to the top, start or dismiss. Viewing and dismissing is free; starting a task or group creates runs, which is billable work.

## Operations

<a id="scalar-operation-post-apiv1externalcodingbackloggroupsgroup-idstart"></a>

### Start a task group

- **Method:** `POST`
- **Path:** `/api/v1/external/coding/backlog/groups/{group_id}/start`
- **Operation ID:** `startBacklogGroup`
- **Tags:** Backlog

Start a group: one tap for every part. Each part whose earlier parts are in the default branch starts now as its own run; the server starts each later part once the parts it builds on land. Calling it again is safe (one run per part) and, by a person, makes them the group's starter (resume a group whose starter left, or try again after a spending block). Send `part` to Retry one part that failed, stopped or did not go live (409 otherwise): its new run continues the failed one. A person's tap only: the project agent gets 403 HUMAN\_APPROVAL\_REQUIRED. Each part runs as paid work. 404 for a group you cannot see; 409 when every part was dismissed.

**Servers:** [Inherited servers](#scalar-context-global-servers)

**Authentication:** [Global authentication](#scalar-context-global-authentication)

#### Path parameters

- **`group_id` (required)**: `string`, format: `uuid`

#### Query parameters

- **`customer_id`**: `string | null`, format: `uuid`

#### Request body

**Required:** `false`

**Content type:** `application/json`

[GroupPartRequest](#scalar-schema-grouppartrequest) | `null`

<a id="scalar-example-1"></a>

**Generated example:**

```json
{
  "part": ""
}
```

#### Responses

##### 200 Request fulfilled, document follows

**Content type:** `application/json`

[GroupRead](#scalar-schema-groupread)

<a id="scalar-example-2"></a>

**Generated example:**

```json
{
  "blocked_reason": "",
  "bucket": "",
  "coding_repository_id": "",
  "created_at": "",
  "id": "",
  "parts": [
    {
      "after": [
        1
      ],
      "brief": "",
      "id": "",
      "needs": "",
      "pr_url": "",
      "run_id": "",
      "seq": 1,
      "status": "",
      "title": ""
    }
  ],
  "started_at": "",
  "title": ""
}
```

##### 400, 401, 403, 404, 409

- `400` Bad request syntax or unsupported method
- `401` Invalid or missing customer API key
- `403` Insufficient scope or forbidden customer access; or HUMAN\_APPROVAL\_REQUIRED: the agent never starts work
- `404` Resource not found
- `409` The group was dismissed, or the part has nothing to retry

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

RFC 7807 problem detail returned for public CaaS errors.

<a id="scalar-example-3"></a>

**Generated example:**

```json
{
  "code": "BUDGET_EXHAUSTED",
  "detail": null,
  "existing_run_id": null,
  "instance": null,
  "status": 1,
  "title": "",
  "type": "about:blank",
  "additionalProperty": "anything"
}
```

##### 429 Rate limit exceeded

**Headers:**

- **`Retry-After`**

  Seconds to wait before retrying the request

  `integer`

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

RFC 7807 problem detail returned for public CaaS errors.

[Generated example](#scalar-example-3)

##### default Unexpected error

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

<a id="scalar-example-4"></a>

**Generated example:**

```json
null
```

## Schemas

<a id="scalar-schema-grouppartrequest"></a>

### GroupPartRequest

**Type:** `object`

- **`part`**: `string | null`, format: `uuid`

<a id="scalar-example-5"></a>

**Generated example:**

```json
{
  "part": ""
}
```

<a id="scalar-schema-groupread"></a>

### GroupRead

**Type:** `object`

- **`bucket` (required)**: `string`
- **`coding_repository_id` (required)**: `string`, format: `uuid`
- **`created_at` (required)**: `string`, format: `date-time`
- **`id` (required)**: `string`, format: `uuid`
- **`parts` (required)**: array of [GroupPartRead](#scalar-schema-grouppartread)
- **`title` (required)**: `string`
- **`blocked_reason`**: `string | null`
- **`started_at`**: `string | null`, format: `date-time`

<a id="scalar-example-6"></a>

**Generated example:**

```json
{
  "blocked_reason": "",
  "bucket": "",
  "coding_repository_id": "",
  "created_at": "",
  "id": "",
  "parts": [
    {
      "after": [
        1
      ],
      "brief": "",
      "id": "",
      "needs": "",
      "pr_url": "",
      "run_id": "",
      "seq": 1,
      "status": "",
      "title": ""
    }
  ],
  "started_at": "",
  "title": ""
}
```

<a id="scalar-schema-grouppartread"></a>

### GroupPartRead

**Type:** `object`

- **`after` (required)**: `array of integer`
- **`brief` (required)**: `string`
- **`id` (required)**: `string`, format: `uuid`
- **`seq` (required)**: `integer`
- **`status` (required)**: `string`
- **`title` (required)**: `string`
- **`needs`**: `string | null`
- **`pr_url`**: `string | null`
- **`run_id`**: `string | null`, format: `uuid`

<a id="scalar-example-7"></a>

**Generated example:**

```json
{
  "after": [
    1
  ],
  "brief": "",
  "id": "",
  "needs": "",
  "pr_url": "",
  "run_id": "",
  "seq": 1,
  "status": "",
  "title": ""
}
```

<a id="scalar-schema-problemdetail"></a>

### ProblemDetail

**Type:** `object`

RFC 7807 problem detail returned for public CaaS errors.

- **`code` (required)**: `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "VERSION_NOT_DEPLOYED", "INTERNAL_ERROR"`

  Stable error codes surfaced to public CaaS clients.
- **`status` (required)**: `integer`
- **`title` (required)**: `string`
- **`detail`**: `string | null`, default: `null`
- **`existing_run_id`**: `string | null`, default: `null`
- **`instance`**: `string | null`, default: `null`
- **`type`**: `string`, default: `"about:blank"`

<a id="scalar-example-8"></a>

**Generated example:**

```json
{
  "code": "BUDGET_EXHAUSTED",
  "detail": null,
  "existing_run_id": null,
  "instance": null,
  "status": 1,
  "title": "",
  "type": "about:blank",
  "additionalProperty": "anything"
}
```

<a id="scalar-schema-externalerrorcode"></a>

### ExternalErrorCode

**Type:** `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "VERSION_NOT_DEPLOYED", "INTERNAL_ERROR"`

Stable error codes surfaced to public CaaS clients.