TrylleDocs
API ReferenceOpenAPI 3 reference

Repository Git data

listRepoBranches

GET
/v1/repositories/{owner}/{name}/branches

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Query Parameters

page?integer

One-indexed page. Handler clamps values below 1 to 1.

Formatint64
Range1 <= value
Default1
per_page?integer

Items per page. Handler defaults to 30 and clamps above 100.

Formatint64
Range1 <= value <= 100
Default30
cursor?string

Base64 cursor encoding page and per_page; overrides page/per_page when valid.

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/branches?page=2&per_page=2&cursor=abc123"
"abc123"

deleteRepoBranch

DELETE
/v1/repositories/{owner}/{name}/branches/{branch}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length
branch*string

Branch name.

Length1 <= length

Response Body

application/json

curl -X DELETE "https://example.com/v1/repositories/aa/aa/branches/aa"
"abc123"

getCommit

GET
/v1/repositories/{owner}/{name}/commits/{sha}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length
sha*string

Commit SHA or ref.

Length1 <= length

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/commits/aa"
"abc123"

compare

GET
/v1/repositories/{owner}/{name}/compare

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Query Parameters

base*string

Base ref.

Length1 <= length
head*string

Head ref.

Length1 <= length

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/compare?base=aa&head=aa"
"abc123"

listContents

GET
/v1/repositories/{owner}/{name}/contents

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Query Parameters

ref?string

Git ref.

path?string

Repository path.

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/contents?ref=abc123&path=abc123"
"abc123"

getFile

GET
/v1/repositories/{owner}/{name}/file

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Query Parameters

ref?string

Git ref.

path?string

Repository file path.

encoding?string

Requested encoding.

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/file?ref=abc123&path=abc123&encoding=abc123"
"abc123"

createFile

POST
/v1/repositories/{owner}/{name}/file

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/repositories/aa/aa/file" \  -H "Content-Type: application/json" \  -d '{    "branch": "abc123",    "content": "abc123",    "message": "abc123",    "path": "aa"  }'
"abc123"

listRefCommitAuthors

GET
/v1/repositories/{owner}/{name}/ref-authors

Distinct commit authors for a git ref. Powers commit-list author pickers without walking ref-commits pages. Response shape is { "authors": [{ "login": string, "name": string, "avatarUrl": string, "commitCount": number }], "totalCount": number }; login is empty for unmatched git authors, and commitCount is used to sort the picker.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Query Parameters

ref?string

Git ref (branch, tag, or SHA). Defaults to the repository default branch when omitted.

q?string

Optional substring filter on login or display name.

exclude_bots?boolean

When true, omit authors whose login ends with [bot]. Defaults to false.

limit?integer

Maximum authors to return. Handler defaults to 100 and clamps above 500.

Formatint64

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/ref-authors?ref=abc123&q=abc123&exclude_bots=false&limit=1"
"abc123"

listRefCommits

GET
/v1/repositories/{owner}/{name}/ref-commits

Paginated commits for a git ref. Optional author and q filters are applied before pagination so page counts stay correct.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Query Parameters

ref?string

Git ref.

author?string

Restrict to commits whose routable login or git display name matches exactly.

q?string

Substring filter on commit message, SHA, or author login/name.

page?integer

One-indexed page. Handler clamps values below 1 to 1.

Formatint64
Range1 <= value
Default1
per_page?integer

Items per page. Handler defaults to 30 and clamps above 100.

Formatint64
Range1 <= value <= 100
Default30
cursor?string

Base64 cursor encoding page and per_page; overrides page/per_page when valid.

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/ref-commits?ref=abc123&author=abc123&q=abc123&page=2&per_page=2&cursor=abc123"
"abc123"

getRefHeadCommit

GET
/v1/repositories/{owner}/{name}/ref-head-commit

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Query Parameters

ref?string

Git ref.

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/ref-head-commit?ref=abc123"
"abc123"

getRepoRefState

GET
/v1/repositories/{owner}/{name}/ref-state

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Query Parameters

branch?string

Branch name.

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/ref-state?branch=abc123"
"abc123"

listTreeCommits

GET
/v1/repositories/{owner}/{name}/tree-commits

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Query Parameters

ref?string

Git ref.

dir?string

Directory path.

entry?array<string>

Repeated entry query values.

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/tree-commits?ref=abc123&dir=abc123&entry=abc123"
"abc123"

Repositories

Previous Page

Repository access

Next Page