Syndai Docs

Start a task group

POST
/api/v1/external/coding/backlog/groups/{group_id}/start

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.

Authorization

CustomerApiKey
headerAuthorizationBearer <API Key>

Customer API key sent as a bearer token

Path Parameters

group_id*string
Formatuuid

Query Parameters

customer_id?|null

Request Body

application/json
  1. body
part?|null

Response Body

Request fulfilled, document follows

application/json
  1. response
blocked_reason?string|null
bucket*string
coding_repository_id*string
Formatuuid
created_at*string
Formatdate-time
id*string
Formatuuid
parts*array<>
started_at?|null
title*string
Example Request
curl -X POST 'https://api.syndai.ai/api/v1/external/coding/backlog/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/start' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "blocked_reason": "string",  "bucket": "string",  "coding_repository_id": "0d18edb4-5201-4374-8af8-14fdbf761813",  "created_at": "2019-08-24T14:15:22Z",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "parts": [    {      "after": [        0      ],      "brief": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "needs": "string",      "pr_url": "string",      "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",      "seq": 0,      "status": "string",      "title": "string"    }  ],  "started_at": "2019-08-24T14:15:22Z",  "title": "string"}