Trylle Documentation

listBots

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

account?string

Filter to bots installed on this account login.

Response Body

`application/json`

curl -X GET "https://example.com/v1/bots?account=abc123"

"abc123"

createBot

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?string

Bot description.

id?string

Optional client-generated optimistic bot id.

installations?array<>

Accounts to install this bot on at creation time. Can be empty; installations are managed separately via /v1/bots/{botId}/installations.

name*string

Bot display name.

Length1 <= length

scopes?array<string>

Granted permission scopes (e.g. issues:read).

slug*string

Bot slug.

Match^[a-z0-9](?:[a-z0-9-]{0,37}[a-z0-9])?$

Length1 <= length <= 39

Response Body

`application/json`

curl -X POST "https://example.com/v1/bots" \  -H "Content-Type: application/json" \  -d '{    "description": "abc123",    "id": "abc123",    "installations": [      {        "accountKind": "org",        "accountLogin": "abc123"      }    ],    "name": "aa",    "scopes": [      "abc123"    ],    "slug": "aa"  }'

"abc123"

listBotInstallations

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

botId*string

Bot id.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/v1/bots/aa/installations"

"abc123"

installBotOnAccount

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

botId*string

Bot id.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

accountKind*string

Whether the account is a user or an org.

Value in

"user"
"org"

accountLogin*string

Forgejo owner login (user or org) to install the bot on.

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/v1/bots/aa/installations" \  -H "Content-Type: application/json" \  -d '{    "accountKind": "org",    "accountLogin": "aa"  }'

"abc123"

uninstallBotFromAccount

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

botId*string

Bot id.

Length1 <= length

accountLogin*string

Forgejo owner login the bot is installed on.

Length1 <= length

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/bots/aa/installations/aa"

"abc123"

issueBotToken

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

botId*string

Bot id.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

expiresIn?string

Optional Go time.ParseDuration value.

name?string

Token name.

Response Body

`application/json`

curl -X POST "https://example.com/v1/bots/aa/tokens" \  -H "Content-Type: application/json" \  -d '{    "expiresIn": "abc123",    "name": "abc123"  }'

"abc123"

revokeBotToken

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

botId*string

Bot id.

Length1 <= length

tokenId*string

Token id.

Length1 <= length

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/bots/aa/tokens/aa"

"abc123"

Bots

200application/json

201application/json

200application/json

201application/json

200application/json

201application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`