CLI and schema reference
Commands, JSON schemas, and exit codes.
This reference is generated from reviewed snapshots of the CLI commands and schemas. CLI schema version: 8. Envelope protocol version: 1. To inspect your installed version, run:
guildscribe help
guildscribe recordings --help
guildscribe doctor --schema init.request
guildscribe doctor --schema config.update.requestAutomation behavior
Finite commands write one compact JSON envelope to stdout with protocolVersion,
requestID, command context, and ok. Success data is under result; failures
provide error.code, message, details, and retrySafety. Diagnostics go to
stderr. Check both exit status and ok. The daemon is long-running.
Use --request-id to supply a caller ID; one is generated otherwise. Duration
flags require units such as --timeout 30s. Structured input and secrets use
request files or stdin. --no-input and --non-interactive disable prompts but
do not grant confirmation. The generated options show available previews.
| Exit | Class |
|---|---|
| 0 | Success |
| 1 | Internal failure |
| 2 | Invalid input |
| 3 | Configuration |
| 4 | Unsupported |
| 5 | External dependency |
| 6 | Timeout |
| 7 | Resource error |
| 8 | Confirmation required |
Retry safety is safe, unsafe, or never. Set a retry limit for safe failures. Never
repeatedly issue unsafe mutations automatically: an effect may already have
happened even when a timeout or transport failure is reported. Inspect state
first. never requires changed input or state.
Commands
Generated from the reviewed command catalog. Global options:
-V, --version--home <absolute-path>--request-id <ID>--timeout <duration>--no-input--non-interactive--quiet--verbose--verbosity <level>
inspect local readiness and optional live Discord permissions
Mutation: no. Request schema: none. Result schema: capabilities.result.
- --live
- check Discord without mutations. Optional.
- --channel <ID>
- channel permission scope. Optional.
send text or embeds to a Discord channel
Mutation: yes. Request schema: messages.send.request. Result schema: messages.send.result.
- --request <file-or-dash>
- JSON request file or stdin. Required.
- --dry-run
- validate without sending. Optional.
register configured guild slash commands
Mutation: yes. Request schema: none. Result schema: commands.sync.result.
- --dry-run
- preview registration. Optional.
browse stored messages
Mutation: no. Request schema: none. Result schema: messages.page.result.
- --channel <ID>
- channel ID. Optional.
- --after <timestamp>
- inclusive ISO timestamp. Optional.
- --before <timestamp>
- exclusive ISO timestamp. Optional.
- --limit <count>
- page size from 1 to 200. Optional. Default: "50".
- --cursor <cursor>
- next page cursor. Optional.
- --author <ID>
- author ID. Optional.
- --include-threads
- include child threads of the selected channel. Optional.
read one stored message
Mutation: no. Request schema: none. Result schema: messages.get.result.
search message text
Mutation: no. Request schema: none. Result schema: messages.page.result.
- --channel <ID>
- channel ID. Optional.
- --after <timestamp>
- inclusive ISO timestamp. Optional.
- --before <timestamp>
- exclusive ISO timestamp. Optional.
- --limit <count>
- page size from 1 to 200. Optional. Default: "50".
- --cursor <cursor>
- next page cursor. Optional.
- --author <ID>
- author ID. Optional.
- --include-threads
- include child threads of the selected channel. Optional.
read transcript metadata and optional segments
Mutation: no. Request schema: none. Result schema: transcript.get.result.
- --include-segments
- include a page of transcript segments. Optional.
- --limit <count>
- segment page size from 1 to 200. Optional. Default: "50".
- --cursor <cursor>
- next segment page. Optional.
search spoken text
Mutation: no. Request schema: none. Result schema: transcript.search.result.
- --channel <ID>
- channel ID. Optional.
- --after <timestamp>
- inclusive ISO timestamp. Optional.
- --before <timestamp>
- exclusive ISO timestamp. Optional.
- --limit <count>
- page size from 1 to 200. Optional. Default: "50".
- --cursor <cursor>
- next page cursor. Optional.
- --speaker <ID>
- speaker Discord user ID. Optional.
export transcript text, JSON, or subtitles
Mutation: yes. Request schema: none. Result schema: transcript.export.result.
- --destination <absolute-path>
- new export file. Required.
- --format <format>
- export format. Optional. Default: "txt". Choices: txt, json, srt, vtt.
- --dry-run
- preview without writing. Optional.
queue an explicit retry of failed transcription
Mutation: yes. Request schema: transcript.retry.request. Result schema: transcript.retry.result.
- --request <file-or-dash>
- JSON request file or stdin. Required.
- --dry-run
- preview without queuing. Optional.
show database version, size, and counts
Mutation: no. Request schema: none. Result schema: database.status.result.
check database and search index integrity
Mutation: no. Request schema: none. Result schema: database.verify.result.
create a consistent database backup
Mutation: yes. Request schema: none. Result schema: database.backup.result.
- --destination <absolute-path>
- new SQLite backup file. Required.
- --dry-run
- preview without writing. Optional.
list commands and their machine-readable contracts
Mutation: no. Request schema: none. Result schema: help.result.
print version and protocol information
Mutation: no. Request schema: none. Result schema: version.result.
create a new Guildscribe runtime home
Mutation: yes. Request schema: init.request. Result schema: init.result.
- --request <file-or-dash>
- JSON request file or - for stdin. Required.
- --dry-run
- validate without writing. Optional.
validate local tools, configuration, Discord, and contracts
Mutation: no. Request schema: none. Result schema: doctor.result.
- --schema <name>
- include one published JSON schema. Optional.
show daemon, recording, and storage status
Mutation: no. Request schema: none. Result schema: status.result.
show configuration with the Discord token redacted
Mutation: no. Request schema: none. Result schema: configuration.result.
atomically update configuration
Mutation: yes. Request schema: config.update.request. Result schema: config.update.result.
- --request <file-or-dash>
- JSON request file or - for stdin. Required.
- --dry-run
- validate and preview without writing. Optional.
list published and in-progress recordings
Mutation: no. Request schema: none. Result schema: recordings.list.result.
show one recording and its artifact sizes
Mutation: no. Request schema: none. Result schema: recording.summary.
validate recording artifacts and calculate checksums
Mutation: no. Request schema: none. Result schema: recording.verify.result.
copy a recording into a portable checksummed directory
Mutation: yes. Request schema: none. Result schema: recording.export.result.
- --destination <absolute-path>
- new export directory. Required.
- --wav
- also render a PCM WAV copy with FFmpeg. Optional.
- --dry-run
- show the export plan without writing. Optional.
run the recorder in the foreground
Mutation: yes. Request schema: none. Result schema: result.any.
install and load the per-user macOS LaunchAgent
Mutation: yes. Request schema: none. Result schema: startup.install.result.
- --dry-run
- render the LaunchAgent without installing it. Optional.
unload the LaunchAgent and remove its plist
Mutation: yes. Request schema: none. Result schema: startup.wrappedStatus.result.
show the LaunchAgent's installed and running state
Mutation: no. Request schema: none. Result schema: startup.status.result.
start an installed LaunchAgent
Mutation: yes. Request schema: none. Result schema: startup.status.result.
gracefully stop the LaunchAgent until it is started again
Mutation: yes. Request schema: none. Result schema: startup.status.result.
gracefully stop and start the LaunchAgent
Mutation: yes. Request schema: none. Result schema: startup.status.result.
read recent daemon and LaunchAgent logs
Mutation: no. Request schema: none. Result schema: startup.logs.result.
- --lines <count>
- lines to return from each log. Optional. Default: "100".
JSON schemas
Contract schema version 8. This page is rendered directly from
contracts/guildscribe/schemas.json.| Property | Type | Required |
|---|---|---|
| channel | object | null | yes |
| commands | array<object> | yes |
| limitations | array<string> | yes |
| live | boolean | yes |
| operations | object | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"channel": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"channelID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"embedLinks": {
"type": [
"boolean",
"null"
]
},
"sendMessages": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"channelID",
"sendMessages",
"embedLinks"
],
"type": "object"
},
{
"type": "null"
}
]
},
"commands": {
"items": {
"additionalProperties": false,
"properties": {
"allowedUserIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"type": "array"
},
"channelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"type": "array"
},
"ephemeral": {
"type": "boolean"
},
"executableReady": {
"type": "boolean"
},
"guildID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"name": {
"type": "string"
},
"registration": {
"enum": [
"unknown",
"matching",
"missing",
"different"
],
"type": "string"
}
},
"required": [
"guildID",
"name",
"executableReady",
"registration",
"allowedUserIDs",
"channelIDs",
"ephemeral"
],
"type": "object"
},
"type": "array"
},
"limitations": {
"items": {
"type": "string"
},
"type": "array"
},
"live": {
"type": "boolean"
},
"operations": {
"additionalProperties": false,
"properties": {
"embeds": {
"type": "boolean"
},
"sendMessages": {
"type": "boolean"
},
"slashHooks": {
"type": "boolean"
}
},
"required": [
"sendMessages",
"embeds",
"slashHooks"
],
"type": "object"
}
},
"required": [
"live",
"operations",
"channel",
"commands",
"limitations"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| commands | array<string> | yes |
| dryRun | boolean | yes |
| operation | string | yes |
| registrations | array<object> | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"commands": {
"items": {
"type": "string"
},
"type": "array"
},
"dryRun": {
"type": "boolean"
},
"operation": {
"const": "commands.sync",
"type": "string"
},
"registrations": {
"items": {
"additionalProperties": false,
"properties": {
"definition": {
"additionalProperties": false,
"properties": {
"default_member_permissions": {
"const": "0",
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"options": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"type": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
}
},
"required": [
"name",
"description",
"required",
"type"
],
"type": "object"
},
"type": "array"
},
"type": {
"const": 1,
"type": "number"
}
},
"required": [
"name",
"description",
"type",
"default_member_permissions",
"options"
],
"type": "object"
},
"guildID": {
"pattern": "^\\d{15,22}$",
"type": "string"
}
},
"required": [
"guildID",
"definition"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"dryRun",
"commands",
"operation",
"registrations"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| discordToken | string | no |
| emptyGraceMs | integer | no |
| hooks | object | no |
| hookTimeoutMs | integer | no |
| messageChannelIDs | array<string> | no |
| ownerUserID | string | null | no |
| slashCommands | array<object> | no |
| transcriptionHook | string | null | no |
| voiceChannelIDs | array<string> | no |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"discordToken": {
"minLength": 1,
"type": "string"
},
"emptyGraceMs": {
"maximum": 3600000,
"minimum": 0,
"type": "integer"
},
"hooks": {
"additionalProperties": false,
"properties": {
"channelJoined": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
]
},
"channelLeft": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
]
},
"recordingCompleted": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
]
},
"recordingFailed": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
]
},
"recordingStarted": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
]
},
"transcriptionCompleted": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
]
},
"transcriptionFailed": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
]
}
},
"type": "object"
},
"hookTimeoutMs": {
"maximum": 3600000,
"minimum": 1,
"type": "integer"
},
"messageChannelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"type": "array"
},
"ownerUserID": {
"anyOf": [
{
"pattern": "^\\d{15,22}$",
"type": "string"
},
{
"type": "null"
}
]
},
"slashCommands": {
"items": {
"additionalProperties": false,
"properties": {
"allowedUserIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"channelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"ephemeral": {
"default": true,
"type": "boolean"
},
"executable": {
"minLength": 1,
"type": "string"
},
"guildID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"name": {
"pattern": "^[a-z0-9_-]{1,32}$",
"type": "string"
},
"options": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"name": {
"pattern": "^[a-z0-9_-]{1,32}$",
"type": "string"
},
"required": {
"type": "boolean"
},
"type": {
"enum": [
"string",
"integer",
"number",
"boolean",
"user",
"channel",
"role"
],
"type": "string"
}
},
"required": [
"name",
"description",
"type"
],
"type": "object"
},
"maxItems": 25,
"type": "array"
}
},
"required": [
"name",
"description",
"guildID",
"executable",
"allowedUserIDs",
"ephemeral",
"options"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"transcriptionHook": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
]
},
"voiceChannelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}| Property | Type | Required |
|---|---|---|
| changed | boolean | yes |
| configuration | object | yes |
| dryRun | boolean | yes |
| restartRequired | boolean | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"changed": {
"type": "boolean"
},
"configuration": {
"additionalProperties": false,
"properties": {
"discordToken": {
"const": "[redacted]",
"type": "string"
},
"emptyGraceMs": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"hooks": {
"additionalProperties": {
"type": "string"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"hookTimeoutMs": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"messageChannelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"type": "array"
},
"ownerUserID": {
"anyOf": [
{
"pattern": "^\\d{15,22}$",
"type": "string"
},
{
"type": "null"
}
]
},
"slashCommands": {
"items": {
"additionalProperties": false,
"properties": {
"allowedUserIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"channelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"ephemeral": {
"default": true,
"type": "boolean"
},
"executable": {
"minLength": 1,
"type": "string"
},
"guildID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"name": {
"pattern": "^[a-z0-9_-]{1,32}$",
"type": "string"
},
"options": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"name": {
"pattern": "^[a-z0-9_-]{1,32}$",
"type": "string"
},
"required": {
"type": "boolean"
},
"type": {
"enum": [
"string",
"integer",
"number",
"boolean",
"user",
"channel",
"role"
],
"type": "string"
}
},
"required": [
"name",
"description",
"type"
],
"type": "object"
},
"maxItems": 25,
"type": "array"
}
},
"required": [
"name",
"description",
"guildID",
"executable",
"allowedUserIDs",
"ephemeral",
"options"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"transcriptionHook": {
"type": [
"string",
"null"
]
},
"voiceChannelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"type": "array"
}
},
"required": [
"discordToken",
"ownerUserID",
"messageChannelIDs",
"voiceChannelIDs",
"emptyGraceMs",
"hookTimeoutMs",
"transcriptionHook",
"hooks"
],
"type": "object"
},
"dryRun": {
"type": "boolean"
},
"restartRequired": {
"type": "boolean"
}
},
"required": [
"changed",
"dryRun",
"restartRequired",
"configuration"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| discordToken | string | yes |
| emptyGraceMs | integer | yes |
| hooks | object | yes |
| hookTimeoutMs | integer | yes |
| messageChannelIDs | array<string> | yes |
| ownerUserID | string | null | yes |
| slashCommands | array<object> | no |
| transcriptionHook | string | null | yes |
| voiceChannelIDs | array<string> | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"discordToken": {
"const": "[redacted]",
"type": "string"
},
"emptyGraceMs": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"hooks": {
"additionalProperties": {
"type": "string"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"hookTimeoutMs": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"messageChannelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"type": "array"
},
"ownerUserID": {
"anyOf": [
{
"pattern": "^\\d{15,22}$",
"type": "string"
},
{
"type": "null"
}
]
},
"slashCommands": {
"items": {
"additionalProperties": false,
"properties": {
"allowedUserIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"channelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"ephemeral": {
"default": true,
"type": "boolean"
},
"executable": {
"minLength": 1,
"type": "string"
},
"guildID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"name": {
"pattern": "^[a-z0-9_-]{1,32}$",
"type": "string"
},
"options": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"name": {
"pattern": "^[a-z0-9_-]{1,32}$",
"type": "string"
},
"required": {
"type": "boolean"
},
"type": {
"enum": [
"string",
"integer",
"number",
"boolean",
"user",
"channel",
"role"
],
"type": "string"
}
},
"required": [
"name",
"description",
"type"
],
"type": "object"
},
"maxItems": 25,
"type": "array"
}
},
"required": [
"name",
"description",
"guildID",
"executable",
"allowedUserIDs",
"ephemeral",
"options"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"transcriptionHook": {
"type": [
"string",
"null"
]
},
"voiceChannelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"type": "array"
}
},
"required": [
"discordToken",
"ownerUserID",
"messageChannelIDs",
"voiceChannelIDs",
"emptyGraceMs",
"hookTimeoutMs",
"transcriptionHook",
"hooks"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| bytes | integer | null | yes |
| changed | boolean | yes |
| destination | string | yes |
| dryRun | boolean | yes |
| sha256 | string | null | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"bytes": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
]
},
"changed": {
"type": "boolean"
},
"destination": {
"type": "string"
},
"dryRun": {
"type": "boolean"
},
"sha256": {
"type": [
"string",
"null"
]
}
},
"required": [
"changed",
"dryRun",
"destination",
"bytes",
"sha256"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| counts | object | yes |
| databaseBytes | integer | yes |
| databasePath | string | yes |
| schemaVersion | integer | yes |
| walBytes | integer | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"counts": {
"additionalProperties": false,
"properties": {
"messages": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"recordings": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"transcripts": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"transcriptSegments": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
}
},
"required": [
"messages",
"recordings",
"transcripts",
"transcriptSegments"
],
"type": "object"
},
"databaseBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"databasePath": {
"type": "string"
},
"schemaVersion": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"walBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
}
},
"required": [
"databasePath",
"schemaVersion",
"databaseBytes",
"walBytes",
"counts"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| checks | array<object> | yes |
| passed | boolean | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"checks": {
"items": {
"additionalProperties": false,
"properties": {
"detail": {
"type": "string"
},
"name": {
"type": "string"
},
"passed": {
"type": "boolean"
}
},
"required": [
"name",
"passed",
"detail"
],
"type": "object"
},
"type": "array"
},
"passed": {
"type": "boolean"
}
},
"required": [
"passed",
"checks"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| checks | array<object> | yes |
| contracts | object | yes |
| passed | boolean | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"checks": {
"items": {
"additionalProperties": false,
"properties": {
"details": {
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"ok": {
"type": "boolean"
}
},
"required": [
"name",
"ok",
"message"
],
"type": "object"
},
"type": "array"
},
"contracts": {
"additionalProperties": false,
"properties": {
"names": {
"items": {
"type": "string"
},
"type": "array"
},
"schemaVersion": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"selected": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"schema": {
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"name",
"schema"
],
"type": "object"
},
{
"type": "null"
}
]
}
},
"required": [
"schemaVersion",
"names",
"selected"
],
"type": "object"
},
"passed": {
"type": "boolean"
}
},
"required": [
"checks",
"passed",
"contracts"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| command | string | yes |
| error | object | yes |
| ok | boolean | yes |
| protocolVersion | number | yes |
| requestID | string | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"details": {
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"message": {
"type": "string"
},
"retrySafety": {
"enum": [
"safe",
"unsafe",
"never"
],
"type": "string"
}
},
"required": [
"code",
"details",
"message",
"retrySafety"
],
"type": "object"
},
"ok": {
"const": false,
"type": "boolean"
},
"protocolVersion": {
"const": 1,
"type": "number"
},
"requestID": {
"type": "string"
}
},
"required": [
"command",
"error",
"ok",
"protocolVersion",
"requestID"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| command | string | yes |
| ok | boolean | yes |
| protocolVersion | number | yes |
| requestID | string | yes |
| result | unknown | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"protocolVersion": {
"const": 1,
"type": "number"
},
"requestID": {
"type": "string"
},
"result": {}
},
"required": [
"command",
"ok",
"protocolVersion",
"requestID",
"result"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| commands | array<string> | yes |
| definitions | array<object> | yes |
| globalOptions | array<string> | yes |
| scope | array<string> | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"commands": {
"items": {
"type": "string"
},
"type": "array"
},
"definitions": {
"items": {
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"description": {
"type": "string"
},
"mutation": {
"type": "boolean"
},
"options": {
"items": {
"additionalProperties": false,
"properties": {
"choices": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"defaultValue": {},
"description": {
"type": "string"
},
"flags": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"flags",
"description",
"required",
"defaultValue",
"choices"
],
"type": "object"
},
"type": "array"
},
"requestSchema": {
"type": [
"string",
"null"
]
},
"resultSchema": {
"type": "string"
}
},
"required": [
"command",
"description",
"mutation",
"requestSchema",
"resultSchema",
"options"
],
"type": "object"
},
"type": "array"
},
"globalOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"scope",
"commands",
"definitions",
"globalOptions"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| discordToken | string | yes |
| emptyGraceMs | integer | no |
| hooks | object | no |
| hookTimeoutMs | integer | no |
| messageChannelIDs | array<string> | no |
| ownerUserID | string | no |
| slashCommands | array<object> | no |
| transcriptionHook | string | no |
| voiceChannelIDs | array<string> | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"discordToken": {
"minLength": 1,
"type": "string"
},
"emptyGraceMs": {
"maximum": 3600000,
"minimum": 0,
"type": "integer"
},
"hooks": {
"additionalProperties": false,
"properties": {
"channelJoined": {
"minLength": 1,
"type": "string"
},
"channelLeft": {
"minLength": 1,
"type": "string"
},
"recordingCompleted": {
"minLength": 1,
"type": "string"
},
"recordingFailed": {
"minLength": 1,
"type": "string"
},
"recordingStarted": {
"minLength": 1,
"type": "string"
},
"transcriptionCompleted": {
"minLength": 1,
"type": "string"
},
"transcriptionFailed": {
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"hookTimeoutMs": {
"maximum": 3600000,
"minimum": 1,
"type": "integer"
},
"messageChannelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"type": "array"
},
"ownerUserID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"slashCommands": {
"items": {
"additionalProperties": false,
"properties": {
"allowedUserIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"channelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"ephemeral": {
"default": true,
"type": "boolean"
},
"executable": {
"minLength": 1,
"type": "string"
},
"guildID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"name": {
"pattern": "^[a-z0-9_-]{1,32}$",
"type": "string"
},
"options": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"name": {
"pattern": "^[a-z0-9_-]{1,32}$",
"type": "string"
},
"required": {
"type": "boolean"
},
"type": {
"enum": [
"string",
"integer",
"number",
"boolean",
"user",
"channel",
"role"
],
"type": "string"
}
},
"required": [
"name",
"description",
"type"
],
"type": "object"
},
"maxItems": 25,
"type": "array"
}
},
"required": [
"name",
"description",
"guildID",
"executable",
"allowedUserIDs",
"ephemeral",
"options"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"transcriptionHook": {
"minLength": 1,
"type": "string"
},
"voiceChannelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"discordToken",
"voiceChannelIDs"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| configurationPath | string | yes |
| created | boolean | yes |
| discordToken | string | yes |
| dryRun | boolean | yes |
| home | string | yes |
| messageChannelIDs | array<string> | yes |
| ownerUserID | string | null | yes |
| slashCommands | array<object> | no |
| voiceChannelIDs | array<string> | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"configurationPath": {
"type": "string"
},
"created": {
"type": "boolean"
},
"discordToken": {
"const": "[redacted]",
"type": "string"
},
"dryRun": {
"type": "boolean"
},
"home": {
"type": "string"
},
"messageChannelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"type": "array"
},
"ownerUserID": {
"anyOf": [
{
"pattern": "^\\d{15,22}$",
"type": "string"
},
{
"type": "null"
}
]
},
"slashCommands": {
"items": {
"additionalProperties": false,
"properties": {
"allowedUserIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"channelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"ephemeral": {
"default": true,
"type": "boolean"
},
"executable": {
"minLength": 1,
"type": "string"
},
"guildID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"name": {
"pattern": "^[a-z0-9_-]{1,32}$",
"type": "string"
},
"options": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"name": {
"pattern": "^[a-z0-9_-]{1,32}$",
"type": "string"
},
"required": {
"type": "boolean"
},
"type": {
"enum": [
"string",
"integer",
"number",
"boolean",
"user",
"channel",
"role"
],
"type": "string"
}
},
"required": [
"name",
"description",
"type"
],
"type": "object"
},
"maxItems": 25,
"type": "array"
}
},
"required": [
"name",
"description",
"guildID",
"executable",
"allowedUserIDs",
"ephemeral",
"options"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"voiceChannelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"type": "array"
}
},
"required": [
"created",
"home",
"configurationPath",
"dryRun",
"discordToken",
"ownerUserID",
"messageChannelIDs",
"voiceChannelIDs"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| attachments | array<object> | yes |
| authorDisplayName | string | null | yes |
| authorID | string | yes |
| authorIsBot | boolean | yes |
| authorUsername | string | yes |
| channelID | string | yes |
| channelName | string | null | yes |
| content | string | yes |
| createdAt | integer | yes |
| editedAt | integer | null | yes |
| embeds | array<object> | yes |
| guildID | string | yes |
| messageID | string | yes |
| messageType | integer | yes |
| observedAt | integer | yes |
| parentChannelID | string | null | yes |
| replyToMessageID | string | null | yes |
| webhookID | string | null | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"attachments": {
"items": {
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"type": "array"
},
"authorDisplayName": {
"type": [
"string",
"null"
]
},
"authorID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"authorIsBot": {
"type": "boolean"
},
"authorUsername": {
"type": "string"
},
"channelID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"channelName": {
"type": [
"string",
"null"
]
},
"content": {
"type": "string"
},
"createdAt": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"editedAt": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
{
"type": "null"
}
]
},
"embeds": {
"items": {
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"type": "array"
},
"guildID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"messageID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"messageType": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"observedAt": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"parentChannelID": {
"anyOf": [
{
"pattern": "^\\d{15,22}$",
"type": "string"
},
{
"type": "null"
}
]
},
"replyToMessageID": {
"anyOf": [
{
"pattern": "^\\d{15,22}$",
"type": "string"
},
{
"type": "null"
}
]
},
"webhookID": {
"anyOf": [
{
"pattern": "^\\d{15,22}$",
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"messageID",
"guildID",
"channelID",
"parentChannelID",
"channelName",
"authorID",
"authorUsername",
"authorDisplayName",
"authorIsBot",
"webhookID",
"messageType",
"content",
"replyToMessageID",
"createdAt",
"editedAt",
"observedAt",
"attachments",
"embeds"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| items | array<object> | yes |
| nextCursor | string | null | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"items": {
"items": {
"additionalProperties": false,
"properties": {
"attachments": {
"items": {
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"type": "array"
},
"authorDisplayName": {
"type": [
"string",
"null"
]
},
"authorID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"authorIsBot": {
"type": "boolean"
},
"authorUsername": {
"type": "string"
},
"channelID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"channelName": {
"type": [
"string",
"null"
]
},
"content": {
"type": "string"
},
"createdAt": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"editedAt": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
{
"type": "null"
}
]
},
"embeds": {
"items": {
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"type": "array"
},
"guildID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"messageID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"messageType": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"observedAt": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"parentChannelID": {
"anyOf": [
{
"pattern": "^\\d{15,22}$",
"type": "string"
},
{
"type": "null"
}
]
},
"replyToMessageID": {
"anyOf": [
{
"pattern": "^\\d{15,22}$",
"type": "string"
},
{
"type": "null"
}
]
},
"webhookID": {
"anyOf": [
{
"pattern": "^\\d{15,22}$",
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"messageID",
"guildID",
"channelID",
"parentChannelID",
"channelName",
"authorID",
"authorUsername",
"authorDisplayName",
"authorIsBot",
"webhookID",
"messageType",
"content",
"replyToMessageID",
"createdAt",
"editedAt",
"observedAt",
"attachments",
"embeds"
],
"type": "object"
},
"type": "array"
},
"nextCursor": {
"type": [
"string",
"null"
]
}
},
"required": [
"items",
"nextCursor"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| channelID | string | yes |
| message | object | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"channelID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"message": {
"additionalProperties": false,
"properties": {
"content": {
"maxLength": 2000,
"minLength": 1,
"type": "string"
},
"embeds": {
"items": {
"additionalProperties": false,
"properties": {
"author": {
"additionalProperties": false,
"properties": {
"icon_url": {
"format": "uri",
"type": "string"
},
"name": {
"maxLength": 256,
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"color": {
"maximum": 16777215,
"minimum": 0,
"type": "integer"
},
"description": {
"maxLength": 4096,
"type": "string"
},
"fields": {
"items": {
"additionalProperties": false,
"properties": {
"inline": {
"type": "boolean"
},
"name": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"value": {
"maxLength": 1024,
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 25,
"type": "array"
},
"footer": {
"additionalProperties": false,
"properties": {
"icon_url": {
"format": "uri",
"type": "string"
},
"text": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"thumbnail": {
"additionalProperties": false,
"properties": {
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"timestamp": {
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"type": "string"
},
"title": {
"maxLength": 256,
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
},
"required": [
"channelID",
"message"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| channelID | string | yes |
| dryRun | boolean | yes |
| messageID | string | null | yes |
| operation | string | yes |
| payload | object | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"channelID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"dryRun": {
"type": "boolean"
},
"messageID": {
"anyOf": [
{
"pattern": "^\\d{15,22}$",
"type": "string"
},
{
"type": "null"
}
]
},
"operation": {
"const": "messages.send",
"type": "string"
},
"payload": {
"additionalProperties": false,
"properties": {
"allowed_mentions": {
"additionalProperties": false,
"properties": {
"parse": {
"items": {
"type": "string"
},
"maxItems": 0,
"type": "array"
}
},
"required": [
"parse"
],
"type": "object"
},
"content": {
"maxLength": 2000,
"minLength": 1,
"type": "string"
},
"embeds": {
"items": {
"additionalProperties": false,
"properties": {
"author": {
"additionalProperties": false,
"properties": {
"icon_url": {
"format": "uri",
"type": "string"
},
"name": {
"maxLength": 256,
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"color": {
"maximum": 16777215,
"minimum": 0,
"type": "integer"
},
"description": {
"maxLength": 4096,
"type": "string"
},
"fields": {
"items": {
"additionalProperties": false,
"properties": {
"inline": {
"type": "boolean"
},
"name": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"value": {
"maxLength": 1024,
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 25,
"type": "array"
},
"footer": {
"additionalProperties": false,
"properties": {
"icon_url": {
"format": "uri",
"type": "string"
},
"text": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"thumbnail": {
"additionalProperties": false,
"properties": {
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"timestamp": {
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"type": "string"
},
"title": {
"maxLength": 256,
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
}
},
"required": [
"allowed_mentions"
],
"type": "object"
}
},
"required": [
"dryRun",
"channelID",
"messageID",
"operation",
"payload"
],
"type": "object"
}object | object
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"additionalProperties": false,
"properties": {
"changed": {
"const": false,
"type": "boolean"
},
"destination": {
"type": "string"
},
"dryRun": {
"const": true,
"type": "boolean"
},
"files": {
"items": {
"type": "string"
},
"type": "array"
},
"recordingID": {
"type": "string"
}
},
"required": [
"changed",
"dryRun",
"recordingID",
"destination",
"files"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"changed": {
"const": true,
"type": "boolean"
},
"checksumsFile": {
"type": "string"
},
"destination": {
"type": "string"
},
"dryRun": {
"const": false,
"type": "boolean"
},
"fileCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"recordingID": {
"type": "string"
},
"sourceBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"wavFile": {
"type": [
"string",
"null"
]
}
},
"required": [
"changed",
"dryRun",
"recordingID",
"destination",
"fileCount",
"sourceBytes",
"wavFile",
"checksumsFile"
],
"type": "object"
}
]
}| Property | Type | Required |
|---|---|---|
| audioFile | string | null | yes |
| audioFileBytes | integer | yes |
| channelID | string | yes |
| channelName | string | null | yes |
| directory | string | yes |
| durationMs | number | null | yes |
| endedAt | string | null | yes |
| fileCount | integer | yes |
| guildID | string | yes |
| guildName | string | null | yes |
| participantCount | integer | yes |
| pcmFileBytes | integer | yes |
| pcmFileCount | integer | yes |
| recordingID | string | yes |
| recoveredAfterRestart | boolean | yes |
| startedAt | string | yes |
| status | string | yes |
| storage | "inProgress" | "published" | yes |
| totalBytes | integer | yes |
| transcriptionStatus | string | null | yes |
| transcriptSegmentCount | integer | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"audioFile": {
"type": [
"string",
"null"
]
},
"audioFileBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"channelID": {
"type": "string"
},
"channelName": {
"type": [
"string",
"null"
]
},
"directory": {
"type": "string"
},
"durationMs": {
"type": [
"number",
"null"
]
},
"endedAt": {
"type": [
"string",
"null"
]
},
"fileCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"guildID": {
"type": "string"
},
"guildName": {
"type": [
"string",
"null"
]
},
"participantCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"pcmFileBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"pcmFileCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"recordingID": {
"type": "string"
},
"recoveredAfterRestart": {
"type": "boolean"
},
"startedAt": {
"type": "string"
},
"status": {
"type": "string"
},
"storage": {
"enum": [
"inProgress",
"published"
],
"type": "string"
},
"totalBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"transcriptionStatus": {
"type": [
"string",
"null"
]
},
"transcriptSegmentCount": {
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
}
},
"required": [
"recordingID",
"guildID",
"guildName",
"channelID",
"channelName",
"status",
"storage",
"directory",
"startedAt",
"endedAt",
"durationMs",
"recoveredAfterRestart",
"audioFile",
"audioFileBytes",
"transcriptionStatus",
"transcriptSegmentCount",
"participantCount",
"pcmFileCount",
"pcmFileBytes",
"fileCount",
"totalBytes"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| checks | array<object> | yes |
| files | array<object> | yes |
| passed | boolean | yes |
| recordingID | string | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"checks": {
"items": {
"additionalProperties": false,
"properties": {
"details": {
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"enum": [
"pass",
"warn",
"fail"
],
"type": "string"
}
},
"required": [
"name",
"status",
"message"
],
"type": "object"
},
"type": "array"
},
"files": {
"items": {
"additionalProperties": false,
"properties": {
"bytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"relativePath": {
"type": "string"
},
"sha256": {
"type": "string"
}
},
"required": [
"relativePath",
"bytes",
"sha256"
],
"type": "object"
},
"type": "array"
},
"passed": {
"type": "boolean"
},
"recordingID": {
"type": "string"
}
},
"required": [
"recordingID",
"passed",
"checks",
"files"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| recordings | array<object> | yes |
| totals | object | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"recordings": {
"items": {
"additionalProperties": false,
"properties": {
"audioFile": {
"type": [
"string",
"null"
]
},
"audioFileBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"channelID": {
"type": "string"
},
"channelName": {
"type": [
"string",
"null"
]
},
"directory": {
"type": "string"
},
"durationMs": {
"type": [
"number",
"null"
]
},
"endedAt": {
"type": [
"string",
"null"
]
},
"fileCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"guildID": {
"type": "string"
},
"guildName": {
"type": [
"string",
"null"
]
},
"participantCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"pcmFileBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"pcmFileCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"recordingID": {
"type": "string"
},
"recoveredAfterRestart": {
"type": "boolean"
},
"startedAt": {
"type": "string"
},
"status": {
"type": "string"
},
"storage": {
"enum": [
"inProgress",
"published"
],
"type": "string"
},
"totalBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"transcriptionStatus": {
"type": [
"string",
"null"
]
},
"transcriptSegmentCount": {
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
}
},
"required": [
"recordingID",
"guildID",
"guildName",
"channelID",
"channelName",
"status",
"storage",
"directory",
"startedAt",
"endedAt",
"durationMs",
"recoveredAfterRestart",
"audioFile",
"audioFileBytes",
"transcriptionStatus",
"transcriptSegmentCount",
"participantCount",
"pcmFileCount",
"pcmFileBytes",
"fileCount",
"totalBytes"
],
"type": "object"
},
"type": "array"
},
"totals": {
"additionalProperties": false,
"properties": {
"audioFileBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"fileCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"pcmFileBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"pcmFileCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"recordingCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"totalBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
}
},
"required": [
"recordingCount",
"audioFileBytes",
"pcmFileCount",
"pcmFileBytes",
"fileCount",
"totalBytes"
],
"type": "object"
}
},
"required": [
"recordings",
"totals"
],
"type": "object"
}unknown
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema"
}array<object>
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"items": {
"additionalProperties": false,
"properties": {
"allowedUserIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"channelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"ephemeral": {
"default": true,
"type": "boolean"
},
"executable": {
"minLength": 1,
"type": "string"
},
"guildID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"name": {
"pattern": "^[a-z0-9_-]{1,32}$",
"type": "string"
},
"options": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"name": {
"pattern": "^[a-z0-9_-]{1,32}$",
"type": "string"
},
"required": {
"type": "boolean"
},
"type": {
"enum": [
"string",
"integer",
"number",
"boolean",
"user",
"channel",
"role"
],
"type": "string"
}
},
"required": [
"name",
"description",
"type"
],
"type": "object"
},
"maxItems": 25,
"type": "array"
}
},
"required": [
"name",
"description",
"guildID",
"executable",
"allowedUserIDs",
"ephemeral",
"options"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
}| Property | Type | Required |
|---|---|---|
| content | string | no |
| embeds | array<object> | no |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"content": {
"maxLength": 2000,
"minLength": 1,
"type": "string"
},
"embeds": {
"items": {
"additionalProperties": false,
"properties": {
"author": {
"additionalProperties": false,
"properties": {
"icon_url": {
"format": "uri",
"type": "string"
},
"name": {
"maxLength": 256,
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"color": {
"maximum": 16777215,
"minimum": 0,
"type": "integer"
},
"description": {
"maxLength": 4096,
"type": "string"
},
"fields": {
"items": {
"additionalProperties": false,
"properties": {
"inline": {
"type": "boolean"
},
"name": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"value": {
"maxLength": 1024,
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"maxItems": 25,
"type": "array"
},
"footer": {
"additionalProperties": false,
"properties": {
"icon_url": {
"format": "uri",
"type": "string"
},
"text": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"thumbnail": {
"additionalProperties": false,
"properties": {
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"timestamp": {
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"type": "string"
},
"title": {
"maxLength": 256,
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
}
},
"type": "object"
}object | object
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"additionalProperties": false,
"properties": {
"dryRun": {
"const": true,
"type": "boolean"
},
"label": {
"type": "string"
},
"plist": {
"type": "string"
},
"plistPath": {
"type": "string"
}
},
"required": [
"dryRun",
"label",
"plistPath",
"plist"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"dryRun": {
"const": false,
"type": "boolean"
},
"status": {
"additionalProperties": false,
"properties": {
"configured": {
"type": "boolean"
},
"label": {
"type": "string"
},
"lastExitStatus": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
{
"type": "null"
}
]
},
"loaded": {
"type": "boolean"
},
"pid": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
{
"type": "null"
}
]
},
"plistPath": {
"type": "string"
},
"running": {
"type": "boolean"
},
"state": {
"type": [
"string",
"null"
]
}
},
"required": [
"label",
"plistPath",
"configured",
"loaded",
"running",
"state",
"pid",
"lastExitStatus"
],
"type": "object"
}
},
"required": [
"dryRun",
"status"
],
"type": "object"
}
]
}| Property | Type | Required |
|---|---|---|
| files | array<object> | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"files": {
"items": {
"additionalProperties": false,
"properties": {
"lines": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
}
},
"required": [
"path",
"lines"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"files"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| configured | boolean | yes |
| label | string | yes |
| lastExitStatus | integer | null | yes |
| loaded | boolean | yes |
| pid | integer | null | yes |
| plistPath | string | yes |
| running | boolean | yes |
| state | string | null | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"configured": {
"type": "boolean"
},
"label": {
"type": "string"
},
"lastExitStatus": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
{
"type": "null"
}
]
},
"loaded": {
"type": "boolean"
},
"pid": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
{
"type": "null"
}
]
},
"plistPath": {
"type": "string"
},
"running": {
"type": "boolean"
},
"state": {
"type": [
"string",
"null"
]
}
},
"required": [
"label",
"plistPath",
"configured",
"loaded",
"running",
"state",
"pid",
"lastExitStatus"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| status | object | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"status": {
"additionalProperties": false,
"properties": {
"configured": {
"type": "boolean"
},
"label": {
"type": "string"
},
"lastExitStatus": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
{
"type": "null"
}
]
},
"loaded": {
"type": "boolean"
},
"pid": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
{
"type": "null"
}
]
},
"plistPath": {
"type": "string"
},
"running": {
"type": "boolean"
},
"state": {
"type": [
"string",
"null"
]
}
},
"required": [
"label",
"plistPath",
"configured",
"loaded",
"running",
"state",
"pid",
"lastExitStatus"
],
"type": "object"
}
},
"required": [
"status"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| configuration | object | yes |
| daemon | object | yes |
| latestRecording | object | null | yes |
| recording | object | null | yes |
| storage | object | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"configuration": {
"additionalProperties": false,
"properties": {
"emptyGraceMs": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"transcriptionEnabled": {
"type": "boolean"
},
"voiceChannelIDs": {
"items": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"type": "array"
}
},
"required": [
"voiceChannelIDs",
"emptyGraceMs",
"transcriptionEnabled"
],
"type": "object"
},
"daemon": {
"additionalProperties": false,
"properties": {
"discordReady": {
"type": [
"boolean",
"null"
]
},
"health": {
"enum": [
"stopped",
"starting",
"ready",
"recording",
"degraded",
"stopping",
"stale"
],
"type": "string"
},
"heartbeatAt": {
"type": [
"string",
"null"
]
},
"lastError": {
"type": [
"string",
"null"
]
},
"pid": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
{
"type": "null"
}
]
},
"running": {
"type": "boolean"
},
"startedAt": {
"type": [
"string",
"null"
]
},
"uptimeMs": {
"type": [
"number",
"null"
]
}
},
"required": [
"health",
"running",
"pid",
"startedAt",
"uptimeMs",
"heartbeatAt",
"discordReady",
"lastError"
],
"type": "object"
},
"latestRecording": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"audioFile": {
"type": [
"string",
"null"
]
},
"audioFileBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"channelID": {
"type": "string"
},
"channelName": {
"type": [
"string",
"null"
]
},
"directory": {
"type": "string"
},
"durationMs": {
"type": [
"number",
"null"
]
},
"endedAt": {
"type": [
"string",
"null"
]
},
"fileCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"guildID": {
"type": "string"
},
"guildName": {
"type": [
"string",
"null"
]
},
"participantCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"pcmFileBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"pcmFileCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"recordingID": {
"type": "string"
},
"recoveredAfterRestart": {
"type": "boolean"
},
"startedAt": {
"type": "string"
},
"status": {
"type": "string"
},
"storage": {
"enum": [
"inProgress",
"published"
],
"type": "string"
},
"totalBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"transcriptionStatus": {
"type": [
"string",
"null"
]
},
"transcriptSegmentCount": {
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
}
},
"required": [
"recordingID",
"guildID",
"guildName",
"channelID",
"channelName",
"status",
"storage",
"directory",
"startedAt",
"endedAt",
"durationMs",
"recoveredAfterRestart",
"audioFile",
"audioFileBytes",
"transcriptionStatus",
"transcriptSegmentCount",
"participantCount",
"pcmFileCount",
"pcmFileBytes",
"fileCount",
"totalBytes"
],
"type": "object"
},
{
"type": "null"
}
]
},
"recording": {
"anyOf": [
{
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
]
},
"storage": {
"additionalProperties": false,
"properties": {
"audioFileBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"fileCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"pcmFileBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"pcmFileCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"recordingCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"totalBytes": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
}
},
"required": [
"recordingCount",
"audioFileBytes",
"pcmFileCount",
"pcmFileBytes",
"fileCount",
"totalBytes"
],
"type": "object"
}
},
"required": [
"daemon",
"configuration",
"recording",
"latestRecording",
"storage"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| bytes | integer | null | yes |
| changed | boolean | yes |
| destination | string | yes |
| dryRun | boolean | yes |
| format | "txt" | "json" | "srt" | "vtt" | yes |
| recordingID | string (uuid) | yes |
| sha256 | string | null | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"bytes": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
]
},
"changed": {
"type": "boolean"
},
"destination": {
"type": "string"
},
"dryRun": {
"type": "boolean"
},
"format": {
"enum": [
"txt",
"json",
"srt",
"vtt"
],
"type": "string"
},
"recordingID": {
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
"sha256": {
"type": [
"string",
"null"
]
}
},
"required": [
"changed",
"dryRun",
"destination",
"bytes",
"sha256",
"recordingID",
"format"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| attempts | integer | yes |
| error | string | null | yes |
| finishedAt | integer | null | yes |
| language | string | null | yes |
| nextCursor | string | null | yes |
| queuedAt | integer | yes |
| recordingID | string (uuid) | yes |
| segmentCount | integer | yes |
| segments | array<object> | no |
| startedAt | integer | null | yes |
| status | "pending" | "running" | "complete" | "failed" | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"attempts": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
},
"finishedAt": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
{
"type": "null"
}
]
},
"language": {
"type": [
"string",
"null"
]
},
"nextCursor": {
"type": [
"string",
"null"
]
},
"queuedAt": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"recordingID": {
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
"segmentCount": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"segments": {
"items": {
"additionalProperties": false,
"properties": {
"endOffsetMs": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"recordingID": {
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
"segmentID": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"segmentIndex": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"sourceIntervalID": {
"type": [
"string",
"null"
]
},
"speakerDisplayName": {
"type": [
"string",
"null"
]
},
"speakerUserID": {
"type": [
"string",
"null"
]
},
"speakerUsername": {
"type": [
"string",
"null"
]
},
"startOffsetMs": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"text": {
"type": "string"
}
},
"required": [
"segmentID",
"recordingID",
"segmentIndex",
"startOffsetMs",
"endOffsetMs",
"text",
"sourceIntervalID",
"speakerUserID",
"speakerUsername",
"speakerDisplayName"
],
"type": "object"
},
"type": "array"
},
"startedAt": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"pending",
"running",
"complete",
"failed"
],
"type": "string"
}
},
"required": [
"recordingID",
"status",
"attempts",
"queuedAt",
"startedAt",
"finishedAt",
"error",
"language",
"segmentCount",
"nextCursor"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| recordingID | string (uuid) | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"recordingID": {
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
}
},
"required": [
"recordingID"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| attempts | integer | yes |
| changed | boolean | yes |
| dryRun | boolean | yes |
| recordingID | string (uuid) | yes |
| status | "pending" | "running" | "complete" | "failed" | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"attempts": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"changed": {
"type": "boolean"
},
"dryRun": {
"type": "boolean"
},
"recordingID": {
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
"status": {
"enum": [
"pending",
"running",
"complete",
"failed"
],
"type": "string"
}
},
"required": [
"recordingID",
"changed",
"dryRun",
"status",
"attempts"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| items | array<object> | yes |
| nextCursor | string | null | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"items": {
"items": {
"additionalProperties": false,
"properties": {
"channelID": {
"pattern": "^\\d{15,22}$",
"type": "string"
},
"channelName": {
"type": [
"string",
"null"
]
},
"endOffsetMs": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"recordingID": {
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
"recordingStartedAt": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"segmentID": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"segmentIndex": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"sourceIntervalID": {
"type": [
"string",
"null"
]
},
"speakerDisplayName": {
"type": [
"string",
"null"
]
},
"speakerUserID": {
"type": [
"string",
"null"
]
},
"speakerUsername": {
"type": [
"string",
"null"
]
},
"startOffsetMs": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"text": {
"type": "string"
}
},
"required": [
"segmentID",
"recordingID",
"segmentIndex",
"startOffsetMs",
"endOffsetMs",
"text",
"sourceIntervalID",
"speakerUserID",
"speakerUsername",
"speakerDisplayName",
"channelID",
"channelName",
"recordingStartedAt"
],
"type": "object"
},
"type": "array"
},
"nextCursor": {
"type": [
"string",
"null"
]
}
},
"required": [
"items",
"nextCursor"
],
"type": "object"
}| Property | Type | Required |
|---|---|---|
| protocolVersion | number | yes |
| schemaVersion | number | yes |
| version | string | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"protocolVersion": {
"const": 1,
"type": "number"
},
"schemaVersion": {
"const": 8,
"type": "number"
},
"version": {
"type": "string"
}
},
"required": [
"protocolVersion",
"schemaVersion",
"version"
],
"type": "object"
}