Trails

Create a new trail

post/api/v1/trails/{forge}/{owner}/{repo}

Path parameters

forgestring required

ownerstring required

repostring required

Request body

titlestring required

Trail title

bodystring

Trail description

branch_namestring

Git branch name to create or attach

branch_action'create' | 'link'

How to bind branch_name. 'create' (default) creates the branch at the base tip if it is missing on the remote. 'link' attaches the branch as delivered by the caller and never backfills it at base — use this when the client (e.g. the CLI) has already pushed the branch with its own credentials.

basestring

Base branch (defaults to repo default branch)

status'draft' | 'open' | 'merged' | 'closed'

Initial status (defaults to open)

ready_for_reviewboolean

Explicit review readiness (defaults to false). Only open Trails may set true.

assigneesstring[]

GitHub usernames to set as trail assignees

type'bug' | 'feature' | 'task'

Trail type (defaults to task)

priority'urgent' | 'high' | 'medium' | 'low' | 'none'

Priority level (defaults to none)

Response

Trail created

branch_createdboolean required

Changes

Changed in 6 of the 29 revisions of this API.5529

Sep 25, 202614c8416feab71116See the full diff
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
Sep 24, 2026ba1409f8f36b23See the full diff
- ●
  added the new base_checks enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new base_checks enum value to the ///// response property for the response status
  response-property-enum-value-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
Sep 24, 20260eb4157af08b313See the full diff
- ▲
  the /// response's property type changed from array to object for status
  response-property-type-changed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property /// to the response with the status
  response-required-property-added
Sep 21, 202603a8a4babd7d1See the full diff
- ○
  added the required property /// to the response with the status
  response-required-property-added
Sep 17, 2026e1f0e2f14d0a115See the full diff
- ▲
  the / response's property type changed from array to object for status
  response-property-type-changed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
Sep 16, 2026f15a377013f61See the full diff
- ○
  added the optional property /// to the response with the status
  response-optional-property-added

Full history