Interface: paths

Defined in: packages/api-client/src/generated/api.ts:6

This file was auto-generated by openapi-typescript. Do not make direct changes to the file.

Properties

/api/admin/admin_grants

/api/admin/admin_grants: object

Defined in: packages/api-client/src/generated/api.ts:691

delete?

optional delete?: undefined

get

get: object

Admin List Admin Grants

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.filter?

optional filter?: string | null

get.parameters.query.limit?

optional limit?: number

get.parameters.query.offset?

optional offset?: number

get.parameters.query.order?

optional order?: "asc" | "desc"

get.parameters.query.q?

optional q?: string | null

get.parameters.query.sort?

optional sort?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/admin_grants/{item_id}

/api/admin/admin_grants/{item_id}: object

Defined in: packages/api-client/src/generated/api.ts:708

delete?

optional delete?: undefined

get

get: object

Admin Get Admin Grants

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.item_id

item_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/audit_log

/api/admin/audit_log: object

Defined in: packages/api-client/src/generated/api.ts:963

delete?

optional delete?: undefined

get

get: object

Admin List Audit Log

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.filter?

optional filter?: string | null

get.parameters.query.limit?

optional limit?: number

get.parameters.query.offset?

optional offset?: number

get.parameters.query.order?

optional order?: "asc" | "desc"

get.parameters.query.q?

optional q?: string | null

get.parameters.query.sort?

optional sort?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/audit_log/{item_id}

/api/admin/audit_log/{item_id}: object

Defined in: packages/api-client/src/generated/api.ts:980

delete?

optional delete?: undefined

get

get: object

Admin Get Audit Log

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.item_id

item_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/audit-log

/api/admin/audit-log: object

Defined in: packages/api-client/src/generated/api.ts:654

delete?

optional delete?: undefined

get

get: object

List Audit Log

Description

The filtered audit trail, newest first (M27-3): read-only, for every admin role.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.action?

optional action?: string | null

get.parameters.query.actor_id?

optional actor_id?: string | null

get.parameters.query.limit?

optional limit?: number

get.parameters.query.offset?

optional offset?: number

get.parameters.query.outcome?

optional outcome?: "error" | "ok" | "denied" | null

get.parameters.query.resource?

optional resource?: string | null

get.parameters.query.since?

optional since?: string | null

get.parameters.query.until?

optional until?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/audit-log/{entry_id}

/api/admin/audit-log/{entry_id}: object

Defined in: packages/api-client/src/generated/api.ts:674

delete?

optional delete?: undefined

get

get: object

Get Audit Entry

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.entry_id

entry_id: number

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/auth/google/callback

/api/admin/auth/google/callback: object

Defined in: packages/api-client/src/generated/api.ts:576

delete?

optional delete?: undefined

get

get: object

Admin Google Callback

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.code?

optional code?: string | null

get.parameters.query.error?

optional error?: string | null

get.parameters.query.state?

optional state?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/auth/google/login

/api/admin/auth/google/login: object

Defined in: packages/api-client/src/generated/api.ts:559

delete?

optional delete?: undefined

get

get: object

Admin Google Login

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/auth/logout

/api/admin/auth/logout: object

Defined in: packages/api-client/src/generated/api.ts:593

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Logout

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: undefined

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/global_credentials

/api/admin/global_credentials: object

Defined in: packages/api-client/src/generated/api.ts:725

delete?

optional delete?: undefined

get

get: object

Admin List Global Credentials

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.filter?

optional filter?: string | null

get.parameters.query.limit?

optional limit?: number

get.parameters.query.offset?

optional offset?: number

get.parameters.query.order?

optional order?: "asc" | "desc"

get.parameters.query.q?

optional q?: string | null

get.parameters.query.sort?

optional sort?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/global_credentials/{item_id}

/api/admin/global_credentials/{item_id}: object

Defined in: packages/api-client/src/generated/api.ts:742

delete?

optional delete?: undefined

get

get: object

Admin Get Global Credentials

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.item_id

item_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/global_credentials/{item_id}/actions/delete

/api/admin/global_credentials/{item_id}/actions/delete: object

Defined in: packages/api-client/src/generated/api.ts:1099

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Global Credentials.Delete

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/jobs

/api/admin/jobs: object

Defined in: packages/api-client/src/generated/api.ts:997

delete?

optional delete?: undefined

get

get: object

Admin List Jobs

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.filter?

optional filter?: string | null

get.parameters.query.limit?

optional limit?: number

get.parameters.query.offset?

optional offset?: number

get.parameters.query.order?

optional order?: "asc" | "desc"

get.parameters.query.q?

optional q?: string | null

get.parameters.query.sort?

optional sort?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/jobs/{item_id}

/api/admin/jobs/{item_id}: object

Defined in: packages/api-client/src/generated/api.ts:1014

delete?

optional delete?: undefined

get

get: object

Admin Get Jobs

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.item_id

item_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/jobs/{item_id}/actions/cancel

/api/admin/jobs/{item_id}/actions/cancel: object

Defined in: packages/api-client/src/generated/api.ts:1133

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Jobs.Cancel

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/jobs/{item_id}/actions/retry

/api/admin/jobs/{item_id}/actions/retry: object

Defined in: packages/api-client/src/generated/api.ts:1150

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Jobs.Retry

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/jobs/actions/cancel

/api/admin/jobs/actions/cancel: object

Defined in: packages/api-client/src/generated/api.ts:1116

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Collection Jobs.Cancel

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/me

/api/admin/me: object

Defined in: packages/api-client/src/generated/api.ts:610

delete?

optional delete?: undefined

get

get: object

Admin Me

Description

The requesting admin's identity, role, and effective permission set (for UI canAccess).

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/oauth_identities

/api/admin/oauth_identities: object

Defined in: packages/api-client/src/generated/api.ts:759

delete?

optional delete?: undefined

get

get: object

Admin List Oauth Identities

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.filter?

optional filter?: string | null

get.parameters.query.limit?

optional limit?: number

get.parameters.query.offset?

optional offset?: number

get.parameters.query.order?

optional order?: "asc" | "desc"

get.parameters.query.q?

optional q?: string | null

get.parameters.query.sort?

optional sort?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/oauth_identities/{item_id}

/api/admin/oauth_identities/{item_id}: object

Defined in: packages/api-client/src/generated/api.ts:776

delete?

optional delete?: undefined

get

get: object

Admin Get Oauth Identities

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.item_id

item_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/oauth_identities/{item_id}/actions/delete

/api/admin/oauth_identities/{item_id}/actions/delete: object

Defined in: packages/api-client/src/generated/api.ts:1167

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Oauth Identities.Delete

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/outbound_messages

/api/admin/outbound_messages: object

Defined in: packages/api-client/src/generated/api.ts:1031

delete?

optional delete?: undefined

get

get: object

Admin List Outbound Messages

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.filter?

optional filter?: string | null

get.parameters.query.limit?

optional limit?: number

get.parameters.query.offset?

optional offset?: number

get.parameters.query.order?

optional order?: "asc" | "desc"

get.parameters.query.q?

optional q?: string | null

get.parameters.query.sort?

optional sort?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/outbound_messages/{item_id}

/api/admin/outbound_messages/{item_id}: object

Defined in: packages/api-client/src/generated/api.ts:1048

delete?

optional delete?: undefined

get

get: object

Admin Get Outbound Messages

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.item_id

item_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/overview

/api/admin/overview: object

Defined in: packages/api-client/src/generated/api.ts:630

delete?

optional delete?: undefined

get

get: object

Admin Overview

Description

Counter tiles + recent audit entries + recent outbound failures, in one response.

Read-only by construction: every number is a store count/total and every list row is an
already-redacted read model (audit snapshots redact at append time; the outbound ledger
stores previews and hashes, never message bodies).

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/projects

/api/admin/projects: object

Defined in: packages/api-client/src/generated/api.ts:929

delete?

optional delete?: undefined

get

get: object

Admin List Projects

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.filter?

optional filter?: string | null

get.parameters.query.limit?

optional limit?: number

get.parameters.query.offset?

optional offset?: number

get.parameters.query.order?

optional order?: "asc" | "desc"

get.parameters.query.q?

optional q?: string | null

get.parameters.query.sort?

optional sort?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/projects/{item_id}

/api/admin/projects/{item_id}: object

Defined in: packages/api-client/src/generated/api.ts:946

delete?

optional delete?: undefined

get

get: object

Admin Get Projects

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.item_id

item_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/projects/{item_id}/actions/archive

/api/admin/projects/{item_id}/actions/archive: object

Defined in: packages/api-client/src/generated/api.ts:1184

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Projects.Archive

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/projects/{item_id}/actions/delete

/api/admin/projects/{item_id}/actions/delete: object

Defined in: packages/api-client/src/generated/api.ts:1201

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Projects.Delete

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/projects/{item_id}/actions/edit_state

/api/admin/projects/{item_id}/actions/edit_state: object

Defined in: packages/api-client/src/generated/api.ts:1218

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Projects.Edit State

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/projects/{item_id}/actions/trigger_tick

/api/admin/projects/{item_id}/actions/trigger_tick: object

Defined in: packages/api-client/src/generated/api.ts:1235

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Projects.Trigger Tick

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/projects/{item_id}/actions/unarchive

/api/admin/projects/{item_id}/actions/unarchive: object

Defined in: packages/api-client/src/generated/api.ts:1252

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Projects.Unarchive

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/runtime_correlations

/api/admin/runtime_correlations: object

Defined in: packages/api-client/src/generated/api.ts:1065

delete?

optional delete?: undefined

get

get: object

Admin List Runtime Correlations

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.filter?

optional filter?: string | null

get.parameters.query.limit?

optional limit?: number

get.parameters.query.offset?

optional offset?: number

get.parameters.query.order?

optional order?: "asc" | "desc"

get.parameters.query.q?

optional q?: string | null

get.parameters.query.sort?

optional sort?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/runtime_correlations/{item_id}

/api/admin/runtime_correlations/{item_id}: object

Defined in: packages/api-client/src/generated/api.ts:1082

delete?

optional delete?: undefined

get

get: object

Admin Get Runtime Correlations

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.item_id

item_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/sessions

/api/admin/sessions: object

Defined in: packages/api-client/src/generated/api.ts:793

delete?

optional delete?: undefined

get

get: object

Admin List Sessions

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.filter?

optional filter?: string | null

get.parameters.query.limit?

optional limit?: number

get.parameters.query.offset?

optional offset?: number

get.parameters.query.order?

optional order?: "asc" | "desc"

get.parameters.query.q?

optional q?: string | null

get.parameters.query.sort?

optional sort?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/sessions/{item_id}

/api/admin/sessions/{item_id}: object

Defined in: packages/api-client/src/generated/api.ts:810

delete?

optional delete?: undefined

get

get: object

Admin Get Sessions

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.item_id

item_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/sessions/{item_id}/actions/revoke

/api/admin/sessions/{item_id}/actions/revoke: object

Defined in: packages/api-client/src/generated/api.ts:1286

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Sessions.Revoke

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/sessions/actions/revoke

/api/admin/sessions/actions/revoke: object

Defined in: packages/api-client/src/generated/api.ts:1269

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Collection Sessions.Revoke

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/telegram_links

/api/admin/telegram_links: object

Defined in: packages/api-client/src/generated/api.ts:827

delete?

optional delete?: undefined

get

get: object

Admin List Telegram Links

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.filter?

optional filter?: string | null

get.parameters.query.limit?

optional limit?: number

get.parameters.query.offset?

optional offset?: number

get.parameters.query.order?

optional order?: "asc" | "desc"

get.parameters.query.q?

optional q?: string | null

get.parameters.query.sort?

optional sort?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/telegram_links/{item_id}

/api/admin/telegram_links/{item_id}: object

Defined in: packages/api-client/src/generated/api.ts:844

delete?

optional delete?: undefined

get

get: object

Admin Get Telegram Links

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.item_id

item_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/telegram_links/{item_id}/actions/unlink

/api/admin/telegram_links/{item_id}/actions/unlink: object

Defined in: packages/api-client/src/generated/api.ts:1303

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Telegram Links.Unlink

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/users

/api/admin/users: object

Defined in: packages/api-client/src/generated/api.ts:861

delete?

optional delete?: undefined

get

get: object

Admin List Users

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.filter?

optional filter?: string | null

get.parameters.query.limit?

optional limit?: number

get.parameters.query.offset?

optional offset?: number

get.parameters.query.order?

optional order?: "asc" | "desc"

get.parameters.query.q?

optional q?: string | null

get.parameters.query.sort?

optional sort?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/users/{item_id}

/api/admin/users/{item_id}: object

Defined in: packages/api-client/src/generated/api.ts:878

delete?

optional delete?: undefined

get

get: object

Admin Get Users

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.item_id

item_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/users/{item_id}/actions/change_role

/api/admin/users/{item_id}/actions/change_role: object

Defined in: packages/api-client/src/generated/api.ts:1320

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Users.Change Role

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/users/{item_id}/actions/delete

/api/admin/users/{item_id}/actions/delete: object

Defined in: packages/api-client/src/generated/api.ts:1337

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Users.Delete

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/users/{item_id}/actions/delete_preview

/api/admin/users/{item_id}/actions/delete_preview: object

Defined in: packages/api-client/src/generated/api.ts:1354

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Users.Delete Preview

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/users/{item_id}/actions/grant_admin

/api/admin/users/{item_id}/actions/grant_admin: object

Defined in: packages/api-client/src/generated/api.ts:1371

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Users.Grant Admin

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/users/{item_id}/actions/revoke_admin

/api/admin/users/{item_id}/actions/revoke_admin: object

Defined in: packages/api-client/src/generated/api.ts:1388

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Users.Revoke Admin

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/users/{item_id}/actions/revoke_sessions

/api/admin/users/{item_id}/actions/revoke_sessions: object

Defined in: packages/api-client/src/generated/api.ts:1405

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Users.Revoke Sessions

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/users/{item_id}/actions/update_name

/api/admin/users/{item_id}/actions/update_name: object

Defined in: packages/api-client/src/generated/api.ts:1422

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Action Item Users.Update Name

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: {[key: string]: unknown; } | null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/workspaces

/api/admin/workspaces: object

Defined in: packages/api-client/src/generated/api.ts:895

delete?

optional delete?: undefined

get

get: object

Admin List Workspaces

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.filter?

optional filter?: string | null

get.parameters.query.limit?

optional limit?: number

get.parameters.query.offset?

optional offset?: number

get.parameters.query.order?

optional order?: "asc" | "desc"

get.parameters.query.q?

optional q?: string | null

get.parameters.query.sort?

optional sort?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/admin/workspaces/{item_id}

/api/admin/workspaces/{item_id}: object

Defined in: packages/api-client/src/generated/api.ts:912

delete?

optional delete?: undefined

get

get: object

Admin Get Workspaces

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.item_id

item_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/auth/config

/api/auth/config: object

Defined in: packages/api-client/src/generated/api.ts:120

delete?

optional delete?: undefined

get

get: object

Auth Config

Description

Which sign-in methods this deployment offers, so the login UI only renders live options.

Previews run without Google OAuth creds but with test-login enabled (#346); exposing these
capability flags (booleans only - never the underlying secrets) lets the SPA pick the right
button instead of showing a dead one. ``adminUrl`` (M27-6) is a public origin, not a secret:
the admin surface re-authenticates and requires a grant, so knowing the URL grants nothing.

``google`` reflects the provider that is actually wired, not just the credential settings,
so the non-production loopback provider (M27-14) renders the real sign-in button too.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.adminUrl

adminUrl: string | null

Adminurl

Description

The admin dashboard origin, when this deployment has one (BLOOM_ADMIN_DASHBOARD_URL).

get.responses.200.content.application/json.google

google: boolean

Google

get.responses.200.content.application/json.testLogin

testLogin: boolean

Testlogin

get.responses.200.content.application/json.testLoginRequiresPassword

testLoginRequiresPassword: boolean

Testloginrequirespassword

Description

Test-login demands the per-PR shared password (hardened previews, #346 follow-up).

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/auth/google/callback

/api/auth/google/callback: object

Defined in: packages/api-client/src/generated/api.ts:165

delete?

optional delete?: undefined

get

get: object

Google Callback

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.code?

optional code?: string | null

get.parameters.query.error?

optional error?: string | null

get.parameters.query.state?

optional state?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/auth/google/login

/api/auth/google/login: object

Defined in: packages/api-client/src/generated/api.ts:148

delete?

optional delete?: undefined

get

get: object

Google Login

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/auth/logout

/api/auth/logout: object

Defined in: packages/api-client/src/generated/api.ts:234

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Logout

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: undefined

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/auth/me

/api/auth/me: object

Defined in: packages/api-client/src/generated/api.ts:182

delete?

optional delete?: undefined

get

get: object

Me

Description

The signed-in user, plus the isAdmin capability boolean (M27-6, design 3.4).

``isAdmin`` is derived server-side from a live grant lookup - never from client state - and
only feeds the dashboard's admin nav link; the admin surface enforces its own auth on entry.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.email

email: string

Email

get.responses.200.content.application/json.id

id: string

Id

get.responses.200.content.application/json.isAdmin

isAdmin: boolean

Isadmin

Description

Server-derived capability boolean (an admin grant exists); it grants nothing itself.

get.responses.200.content.application/json.name

name: string | null

Name

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/auth/test-login

/api/auth/test-login: object

Defined in: packages/api-client/src/generated/api.ts:205

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Test Login

Description

Mint a session for a seeded test user, bypassing Google OIDC (M12/E2E-1).

Non-production only and OFF by default (``BLOOM_ENABLE_TEST_LOGIN``); when disabled the route
returns 404 - indistinguishable from not existing - so it leaks nothing in production, where
the ``Settings`` guard makes it impossible to enable at all. It lets the Playwright suite reach
authenticated pages without driving Google (bot detection, no controllable test accounts). An
optional ``{email, name}`` seeds an isolated user per run so journeys do not share state.

The enable/password gate lives in ``require_test_surface`` (see ``bloom.api.test_gate``),
shared with the ``/api/testing/*`` router (#349).

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: object

post.parameters.header.X-Bloom-Test-Login-Password?

optional X-Bloom-Test-Login-Password?: string | null

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: { email?: string | null; name?: string | null; } | null

Union Members

Type Literal

{ email?: string | null; name?: string | null; }

email?

optional email?: string | null

Email

name?

optional name?: string | null

Name

---

null

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

post.responses.200.content.application/json.email

email: string

Email

post.responses.200.content.application/json.id

id: string

Id

post.responses.200.content.application/json.isAdmin

isAdmin: boolean

Isadmin

Description

Server-derived capability boolean (an admin grant exists); it grants nothing itself.

post.responses.200.content.application/json.name

name: string | null

Name

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/credentials

/api/credentials: object

Defined in: packages/api-client/src/generated/api.ts:432

delete?

optional delete?: undefined

get

get: object

List Global Credentials

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.configured

configured: boolean

Configured

get.responses.200.content.application/json.credentials

credentials: object[]

Credentials

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/credentials/{name}

/api/credentials/{name}: object

Defined in: packages/api-client/src/generated/api.ts:449

delete

delete: object

Delete Global Credential

delete.parameters

parameters: object

delete.parameters.cookie?

optional cookie?: undefined

delete.parameters.header?

optional header?: undefined

delete.parameters.path

path: object

delete.parameters.path.name

name: string

delete.parameters.query?

optional query?: undefined

delete.requestBody?

optional requestBody?: undefined

delete.responses

responses: object

delete.responses.204

204: object

Description

Successful Response

delete.responses.204.content?

optional content?: undefined

delete.responses.204.headers

headers: object

Index Signature

[name: string]: unknown

delete.responses.422

422: object

Description

Validation Error

delete.responses.422.content

content: object

delete.responses.422.content.application/json

application/json: object

delete.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

delete.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put

put: object

Put Global Credential

put.parameters

parameters: object

put.parameters.cookie?

optional cookie?: undefined

put.parameters.header?

optional header?: undefined

put.parameters.path

path: object

put.parameters.path.name

name: string

put.parameters.query?

optional query?: undefined

put.requestBody

requestBody: object

put.requestBody.content

content: object

put.requestBody.content.application/json

application/json: object

put.requestBody.content.application/json.value

value: string

Value

put.responses

responses: object

put.responses.204

204: object

Description

Successful Response

put.responses.204.content?

optional content?: undefined

put.responses.204.headers

headers: object

Index Signature

[name: string]: unknown

put.responses.422

422: object

Description

Validation Error

put.responses.422.content

content: object

put.responses.422.content.application/json

application/json: object

put.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

put.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

trace?

optional trace?: undefined

---

/api/projects

/api/projects: object

Defined in: packages/api-client/src/generated/api.ts:270

delete?

optional delete?: undefined

get

get: object

List Projects

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object[]

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Create Project

Description

Create a new project from the web: with no (or a blank) message the thread is minted empty - no discovery turn runs - so the user's first chat message starts discovery (M26-2). With a message, the first turn is routed into discovery immediately, exactly as on Telegram (M20-3).

Any registered user can create a project (M26-4): the first creation allocates their
workspace, so no Telegram link is required.

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: { message?: string | null; repo?: string | null; } | null

Union Members

Type Literal

{ message?: string | null; repo?: string | null; }

message?

optional message?: string | null

Message

repo?

optional repo?: string | null

Repo

Description

An optional owner/name slug naming the EXISTING repository to adopt as the project target (M44 #867, TS-forward). Absent, null, or blank means the greenfield default; a value that is not an owner/name pair, or that resolves to a repo Bloom cannot access, is a 422.

---

null

post.responses

responses: object

post.responses.201

201: object

Description

Successful Response

post.responses.201.content

content: object

post.responses.201.content.application/json

application/json: object

post.responses.201.content.application/json.blocked?

optional blocked?: string[]

Blocked

post.responses.201.content.application/json.issues_closed

issues_closed: number

Issues Closed

Default

0

post.responses.201.content.application/json.issues_open

issues_open: number

Issues Open

Default

0

post.responses.201.content.application/json.last_checked_at?

optional last_checked_at?: string | null

Last Checked At

post.responses.201.content.application/json.live_status_available

live_status_available: boolean

Live Status Available

Default

true

post.responses.201.content.application/json.live_url?

optional live_url?: string | null

Live Url

post.responses.201.content.application/json.milestones_closed

milestones_closed: number

Milestones Closed

Default

0

post.responses.201.content.application/json.milestones_open

milestones_open: number

Milestones Open

Default

0

post.responses.201.content.application/json.needs_attention?

optional needs_attention?: string[]

Needs Attention

post.responses.201.content.application/json.next_check_at?

optional next_check_at?: string | null

Next Check At

post.responses.201.content.application/json.phase

phase: string

Phase

post.responses.201.content.application/json.prd_revision

prd_revision: number

Prd Revision

Default

0

post.responses.201.content.application/json.prd_status

prd_status: string

Prd Status

Default

draft

post.responses.201.content.application/json.pull_requests_open

pull_requests_open: number

Pull Requests Open

Default

0

post.responses.201.content.application/json.repo_url?

optional repo_url?: string | null

Repo Url

post.responses.201.content.application/json.thread_id

thread_id: string

Thread Id

post.responses.201.content.application/json.title

title: string

Title

post.responses.201.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/projects/{thread_id}

/api/projects/{thread_id}: object

Defined in: packages/api-client/src/generated/api.ts:296

delete?

optional delete?: undefined

get

get: object

Get Project

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.thread_id

thread_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.children?

optional children?: object[]

Children

get.responses.200.content.application/json.graph

graph: object

get.responses.200.content.application/json.graph.edges?

optional edges?: object[]

Edges

get.responses.200.content.application/json.graph.nodes?

optional nodes?: object[]

Nodes

get.responses.200.content.application/json.milestones?

optional milestones?: object[]

Milestones

get.responses.200.content.application/json.overview

overview: object

get.responses.200.content.application/json.overview.blocked?

optional blocked?: string[]

Blocked

get.responses.200.content.application/json.overview.issues_closed

issues_closed: number

Issues Closed

Default

0

get.responses.200.content.application/json.overview.issues_open

issues_open: number

Issues Open

Default

0

get.responses.200.content.application/json.overview.last_checked_at?

optional last_checked_at?: string | null

Last Checked At

get.responses.200.content.application/json.overview.live_status_available

live_status_available: boolean

Live Status Available

Default

true

get.responses.200.content.application/json.overview.live_url?

optional live_url?: string | null

Live Url

get.responses.200.content.application/json.overview.milestones_closed

milestones_closed: number

Milestones Closed

Default

0

get.responses.200.content.application/json.overview.milestones_open

milestones_open: number

Milestones Open

Default

0

get.responses.200.content.application/json.overview.needs_attention?

optional needs_attention?: string[]

Needs Attention

get.responses.200.content.application/json.overview.next_check_at?

optional next_check_at?: string | null

Next Check At

get.responses.200.content.application/json.overview.phase

phase: string

Phase

get.responses.200.content.application/json.overview.prd_revision

prd_revision: number

Prd Revision

Default

0

get.responses.200.content.application/json.overview.prd_status

prd_status: string

Prd Status

Default

draft

get.responses.200.content.application/json.overview.pull_requests_open

pull_requests_open: number

Pull Requests Open

Default

0

get.responses.200.content.application/json.overview.repo_url?

optional repo_url?: string | null

Repo Url

get.responses.200.content.application/json.overview.thread_id

thread_id: string

Thread Id

get.responses.200.content.application/json.overview.title

title: string

Title

get.responses.200.content.application/json.specialist_reviews?

optional specialist_reviews?: object[]

Specialist Reviews

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch

patch: object

Rename Project

Description

Rename the project (M56-1 #961, TS-forward - no Python twin): store the owner-chosen display name in run state, which every title derivation (dashboard overview, admin list, Telegram label) now reads first. Ownership-gated with the detail read's exact 404 bytes - a thread the caller does not own is indistinguishable from one that does not exist, and the body rules are only revealed to an owner. Active projects only: an archived or deleted project answers 409 with a machine-readable detail token. The name rule and the write are the shared rename service (also behind the /rename chat command, #963), wrapped in the store's compare-and-swap so a racing orchestrator turn is never clobbered. Echoes the same detail aggregate the GET serves, with the title reflecting the new name.

patch.parameters

parameters: object

patch.parameters.cookie?

optional cookie?: undefined

patch.parameters.header?

optional header?: undefined

patch.parameters.path

path: object

patch.parameters.path.thread_id

thread_id: string

patch.parameters.query?

optional query?: undefined

patch.requestBody

requestBody: object

patch.requestBody.content

content: object

patch.requestBody.content.application/json

application/json: object

patch.requestBody.content.application/json.name

name: string

Name

patch.responses

responses: object

patch.responses.200

200: object

Description

Successful Response

patch.responses.200.content

content: object

patch.responses.200.content.application/json

application/json: object

patch.responses.200.content.application/json.children?

optional children?: object[]

Children

patch.responses.200.content.application/json.graph

graph: object

patch.responses.200.content.application/json.graph.edges?

optional edges?: object[]

Edges

patch.responses.200.content.application/json.graph.nodes?

optional nodes?: object[]

Nodes

patch.responses.200.content.application/json.milestones?

optional milestones?: object[]

Milestones

patch.responses.200.content.application/json.overview

overview: object

patch.responses.200.content.application/json.overview.blocked?

optional blocked?: string[]

Blocked

patch.responses.200.content.application/json.overview.issues_closed

issues_closed: number

Issues Closed

Default

0

patch.responses.200.content.application/json.overview.issues_open

issues_open: number

Issues Open

Default

0

patch.responses.200.content.application/json.overview.last_checked_at?

optional last_checked_at?: string | null

Last Checked At

patch.responses.200.content.application/json.overview.live_status_available

live_status_available: boolean

Live Status Available

Default

true

patch.responses.200.content.application/json.overview.live_url?

optional live_url?: string | null

Live Url

patch.responses.200.content.application/json.overview.milestones_closed

milestones_closed: number

Milestones Closed

Default

0

patch.responses.200.content.application/json.overview.milestones_open

milestones_open: number

Milestones Open

Default

0

patch.responses.200.content.application/json.overview.needs_attention?

optional needs_attention?: string[]

Needs Attention

patch.responses.200.content.application/json.overview.next_check_at?

optional next_check_at?: string | null

Next Check At

patch.responses.200.content.application/json.overview.phase

phase: string

Phase

patch.responses.200.content.application/json.overview.prd_revision

prd_revision: number

Prd Revision

Default

0

patch.responses.200.content.application/json.overview.prd_status

prd_status: string

Prd Status

Default

draft

patch.responses.200.content.application/json.overview.pull_requests_open

pull_requests_open: number

Pull Requests Open

Default

0

patch.responses.200.content.application/json.overview.repo_url?

optional repo_url?: string | null

Repo Url

patch.responses.200.content.application/json.overview.thread_id

thread_id: string

Thread Id

patch.responses.200.content.application/json.overview.title

title: string

Title

patch.responses.200.content.application/json.specialist_reviews?

optional specialist_reviews?: object[]

Specialist Reviews

patch.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

patch.responses.409

409: object

Description

The project cannot be renamed: it is archived or deleted (a machine-readable detail token, project_archived or project_deleted), or a concurrent orchestrator turn won the compare-and-swap (the reload-and-retry sentence).

patch.responses.409.content

content: object

patch.responses.409.content.application/json

application/json: object

patch.responses.409.content.application/json.detail

detail: string

Detail

Description

A machine-readable conflict token: project_archived or project_deleted when the project is retired (the web maps each to a sentence), or the compare-and-swap message "the project changed since it was read; reload and retry" when a concurrent orchestrator turn won the race.

patch.responses.409.headers

headers: object

Index Signature

[name: string]: unknown

patch.responses.422

422: object

Description

Validation Error

patch.responses.422.content

content: object

patch.responses.422.content.application/json

application/json: object

patch.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

patch.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/projects/{thread_id}/credentials

/api/projects/{thread_id}/credentials: object

Defined in: packages/api-client/src/generated/api.ts:397

delete?

optional delete?: undefined

get

get: object

List Credentials

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.thread_id

thread_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.configured

configured: boolean

Configured

get.responses.200.content.application/json.credentials

credentials: object[]

Credentials

get.responses.200.content.application/json.required

required: string[]

Required

get.responses.200.content.application/json.suggested_names

suggested_names: string[]

Suggested Names

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/projects/{thread_id}/credentials/{name}

/api/projects/{thread_id}/credentials/{name}: object

Defined in: packages/api-client/src/generated/api.ts:414

delete

delete: object

Delete Credential

delete.parameters

parameters: object

delete.parameters.cookie?

optional cookie?: undefined

delete.parameters.header?

optional header?: undefined

delete.parameters.path

path: object

delete.parameters.path.name

name: string

delete.parameters.path.thread_id

thread_id: string

delete.parameters.query?

optional query?: undefined

delete.requestBody?

optional requestBody?: undefined

delete.responses

responses: object

delete.responses.204

204: object

Description

Successful Response

delete.responses.204.content?

optional content?: undefined

delete.responses.204.headers

headers: object

Index Signature

[name: string]: unknown

delete.responses.422

422: object

Description

Validation Error

delete.responses.422.content

content: object

delete.responses.422.content.application/json

application/json: object

delete.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

delete.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put

put: object

Put Credential

put.parameters

parameters: object

put.parameters.cookie?

optional cookie?: undefined

put.parameters.header?

optional header?: undefined

put.parameters.path

path: object

put.parameters.path.name

name: string

put.parameters.path.thread_id

thread_id: string

put.parameters.query?

optional query?: undefined

put.requestBody

requestBody: object

put.requestBody.content

content: object

put.requestBody.content.application/json

application/json: object

put.requestBody.content.application/json.value

value: string

Value

put.responses

responses: object

put.responses.204

204: object

Description

Successful Response

put.responses.204.content?

optional content?: undefined

put.responses.204.headers

headers: object

Index Signature

[name: string]: unknown

put.responses.422

422: object

Description

Validation Error

put.responses.422.content

content: object

put.responses.422.content.application/json

application/json: object

put.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

put.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

trace?

optional trace?: undefined

---

/api/projects/{thread_id}/events

/api/projects/{thread_id}/events: object

Defined in: packages/api-client/src/generated/api.ts:380

delete?

optional delete?: undefined

get

get: object

Project Events

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.thread_id

thread_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/projects/{thread_id}/messages

/api/projects/{thread_id}/messages: object

Defined in: packages/api-client/src/generated/api.ts:325

delete?

optional delete?: undefined

get

get: object

Get Messages

Description

The project's shared conversation for the Chat tab (M20-3), ownership-gated.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.thread_id

thread_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object[]

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Post Message

Description

Accept a message into a project's conversation as the signed-in owner (M20-3, #447).

The message is enqueued as a durable job and the thread-scoped handler runs in the job
runner - exactly like the Telegram webhook - so this returns within seconds instead of
blocking on the whole workflow turn (which can outlast the ~100s proxy timeout in front of
the dashboard). Returns the conversation with the just-accepted user turn appended; the
assistant's reply streams over the project's SSE event bus.

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path

path: object

post.parameters.path.thread_id

thread_id: string

post.parameters.query?

optional query?: undefined

post.requestBody

requestBody: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: object

post.requestBody.content.application/json.message

message: string

Message

post.responses

responses: object

post.responses.201

201: object

Description

Successful Response

post.responses.201.content

content: object

post.responses.201.content.application/json

application/json: object[]

post.responses.201.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/projects/{thread_id}/timeline

/api/projects/{thread_id}/timeline: object

Defined in: packages/api-client/src/generated/api.ts:355

delete?

optional delete?: undefined

get

get: object

Project Timeline

Description

The project's recorded event history for the Timeline tab (#265), oldest first.

Chat frames (``chat_*``) are excluded - the Chat tab already renders the conversation; the
timeline is the home for the technical events (reviews, delegation, engine runs, ...). The
bus reads from the durable event store when one is configured (#450), so this survives
API restarts.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.thread_id

thread_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object[]

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/telegram/link

/api/telegram/link: object

Defined in: packages/api-client/src/generated/api.ts:251

delete

delete: object

Delete Link

delete.parameters

parameters: object

delete.parameters.cookie?

optional cookie?: undefined

delete.parameters.header?

optional header?: undefined

delete.parameters.path?

optional path?: undefined

delete.parameters.query?

optional query?: undefined

delete.requestBody?

optional requestBody?: undefined

delete.responses

responses: object

delete.responses.204

204: object

Description

Successful Response

delete.responses.204.content?

optional content?: undefined

delete.responses.204.headers

headers: object

Index Signature

[name: string]: unknown

get

get: object

Get Link

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.linked

linked: boolean

Linked

get.responses.200.content.application/json.telegram_user_id?

optional telegram_user_id?: number | null

Telegram User Id

get.responses.200.content.application/json.verified

verified: boolean

Verified

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Create Link

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: undefined

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

post.responses.200.content.application/json.code

code: string

Code

post.responses.200.content.application/json.deep_link?

optional deep_link?: string | null

Deep Link

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/testing/admin-grant

/api/testing/admin-grant: object

Defined in: packages/api-client/src/generated/api.ts:509

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Admin Grant

Description

Upsert a bloom_admin_grants row for an existing (test) user by email.

Double-gated: the shared test surface (above) AND ``BLOOM_ADMIN_TEST_GRANT`` - which its own
validator makes impossible to enable in production - must both be on; otherwise 404,
indistinguishable from the route not existing. This grants only; it can never mint a
session, admin or otherwise - the admin E2E suite still signs in through the real
``/api/admin/auth`` flow.

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: object

post.parameters.header.X-Bloom-Test-Login-Password?

optional X-Bloom-Test-Login-Password?: string | null

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody

requestBody: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: object

post.requestBody.content.application/json.email

email: string

Email

post.requestBody.content.application/json.role

role: "viewer" | "operator" | "superadmin"

Default

viewer

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: string

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/testing/data

/api/testing/data: object

Defined in: packages/api-client/src/generated/api.ts:535

delete

delete: object

Reset Data

Description

Purge the current test user's footprint so a run against a durable DB leaves nothing behind.

Deletes the seeded project runs (the caller's linked chat plus any explicitly passed chat ids)
and then the user itself, which cascades their sessions, OAuth identity, and Telegram link. The
E2E suite calls this in per-test teardown (see apps/web/e2e/fixtures.ts).

delete.parameters

parameters: object

delete.parameters.cookie?

optional cookie?: undefined

delete.parameters.header?

optional header?: object

delete.parameters.header.X-Bloom-Test-Login-Password?

optional X-Bloom-Test-Login-Password?: string | null

delete.parameters.path?

optional path?: undefined

delete.parameters.query?

optional query?: undefined

delete.requestBody?

optional requestBody?: object

delete.requestBody.content

content: object

delete.requestBody.content.application/json

application/json: { chat_ids?: number[]; } | null

Union Members

Type Literal

{ chat_ids?: number[]; }

chat_ids?

optional chat_ids?: number[]

Chat Ids

---

null

delete.responses

responses: object

delete.responses.200

200: object

Description

Successful Response

delete.responses.200.content

content: object

delete.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: number

delete.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

delete.responses.422

422: object

Description

Validation Error

delete.responses.422.content

content: object

delete.responses.422.content.application/json

application/json: object

delete.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

delete.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/testing/project

/api/testing/project: object

Defined in: packages/api-client/src/generated/api.ts:467

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Seed Project

Description

Verify a Telegram link for the current user to chat_id and persist a project run in that thread, so the dashboard shows it. Optionally publish an SSE event afterwards.

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: object

post.parameters.header.X-Bloom-Test-Login-Password?

optional X-Bloom-Test-Login-Password?: string | null

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody

requestBody: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: object

post.requestBody.content.application/json.chat_id

chat_id: number

Chat Id

post.requestBody.content.application/json.emit?

optional emit?: { data?: {[key: string]: unknown; }; type: string; } | null

Union Members

Type Literal

{ data?: {[key: string]: unknown; }; type: string; }

data?

optional data?: object

Data

Index Signature

[key: string]: unknown

type

type: string

Type

---

null

post.requestBody.content.application/json.state?

optional state?: {[key: string]: unknown; } | null

State

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: string

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/api/testing/project/{thread_id}/subscribers

/api/testing/project/{thread_id}/subscribers: object

Defined in: packages/api-client/src/generated/api.ts:488

delete?

optional delete?: undefined

get

get: object

Subscriber Count

Description

Live SSE subscriber count for a thread - the suite polls this to know a stream is open before emitting, so an event is never published ahead of the subscriber.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: object

get.parameters.header.X-Bloom-Test-Login-Password?

optional X-Bloom-Test-Login-Password?: string | null

get.parameters.path

path: object

get.parameters.path.thread_id

thread_id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: number

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/health

/health: object

Defined in: packages/api-client/src/generated/api.ts:7

delete?

optional delete?: undefined

get

get: object

Health

Description

Readiness status without secret-bearing runtime details.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/metrics

/metrics: object

Defined in: packages/api-client/src/generated/api.ts:27

delete?

optional delete?: undefined

get

get: object

Metrics

Description

The process-global registry (#354) in Prometheus text exposition format.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: object

get.parameters.header.authorization?

optional authorization?: string | null

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: unknown

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/webhooks/github

/webhooks/github: object

Defined in: packages/api-client/src/generated/api.ts:86

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Github Webhook

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: undefined

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/webhooks/github/setup

/webhooks/github/setup: object

Defined in: packages/api-client/src/generated/api.ts:64

delete?

optional delete?: undefined

get

get: object

Github App Setup

Description

GitHub App post-install redirect: link the new installation to the project thread.

``state`` carries the conversation thread id (passed on the install URL Bloom sends).

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query

query: object

get.parameters.query.installation_id

installation_id: number

get.parameters.query.setup_action?

optional setup_action?: string | null

get.parameters.query.state?

optional state?: string | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Successful Response

get.responses.200.content

content: object

get.responses.200.content.text/html

text/html: string

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.422

422: object

Description

Validation Error

get.responses.422.content

content: object

get.responses.422.content.application/json

application/json: object

get.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

get.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/webhooks/gitlab

/webhooks/gitlab: object

Defined in: packages/api-client/src/generated/api.ts:103

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Gitlab Webhook

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: undefined

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/webhooks/telegram

/webhooks/telegram: object

Defined in: packages/api-client/src/generated/api.ts:47

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Telegram Webhook

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: object

post.parameters.header.X-Telegram-Bot-Api-Secret-Token?

optional X-Telegram-Bot-Api-Secret-Token?: string | null

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: undefined

post.responses

responses: object

post.responses.200

200: object

Description

Successful Response

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

Index Signature

[key: string]: unknown

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation Error

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.detail?

optional detail?: object[]

Detail

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined