DEV3 Echolace REST API
Base URL /api/v1 · Authenticate with Authorization: Bearer n3k_… · OpenAPI 3.1 JSON
/api/v1/mescope: readThe workspace this key belongs to
/api/v1/membersscope: readList members
Parameters: role (query)
/api/v1/usagescope: readUsage for the current billing period and the minute balance
/api/v1/mediascope: readList recordings
Parameters: q (query), folderId (query), limit (query)
/api/v1/mediascope: writeUpload a recording (multipart field "file") or import by URL (JSON {"url"})
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string",
"maxLength": 160
},
"folderId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
}
},
"additionalProperties": false
}/api/v1/media/{id}scope: readGet a recording
Parameters: id (path)
/api/v1/media/{id}scope: writeDelete a recording
Parameters: id (path)
/api/v1/transcriptsscope: readList transcripts
Parameters: status (query), q (query), limit (query)
/api/v1/transcriptsscope: writeStart a transcription for a recording (reserves minutes)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"mediaId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
"language": {
"type": "string",
"minLength": 2,
"maxLength": 8
},
"vocabularyId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
"idempotencyKey": {
"type": "string",
"maxLength": 80
}
},
"required": [
"mediaId"
],
"additionalProperties": false
}/api/v1/transcripts/{id}scope: readGet a transcript with speakers and word timestamps
Parameters: id (path)
/api/v1/transcripts/{id}scope: writeDelete a transcript
Parameters: id (path)
/api/v1/transcripts/{id}/exportscope: readExport as txt, docx, pdf, srt, vtt or json
Parameters: id (path), format (query)
/api/v1/transcripts/{id}/revisionsscope: readList revisions
Parameters: id (path)
/api/v1/transcripts/{id}/revisionsscope: writeSave an edited transcript as the next revision (409 version_conflict with a merge proposal when behind)
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"baseVersion": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"doc": {
"type": "object",
"properties": {
"speakers": {
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 60
},
"colour": {
"type": "string",
"maxLength": 20
}
},
"required": [
"id",
"label",
"colour"
],
"additionalProperties": false
}
},
"segments": {
"maxItems": 20000,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"speaker": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"start": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"words": {
"minItems": 1,
"maxItems": 20000,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"t0": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"t1": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"conf": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"id",
"t0",
"t1",
"text",
"conf"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"speaker",
"start",
"end",
"words"
],
"additionalProperties": false
}
}
},
"required": [
"speakers",
"segments"
],
"additionalProperties": false
},
"note": {
"type": "string",
"maxLength": 200
}
},
"required": [
"baseVersion",
"doc"
],
"additionalProperties": false
}/api/v1/transcripts/{id}/aiscope: readAI outputs (summary, chapters, key points, action items, quotes, translations)
Parameters: id (path)
/api/v1/transcripts/{id}/aiscope: writeRun an AI task (simulated engine by default)
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"task": {
"type": "string",
"enum": [
"summary",
"chapters",
"key_points",
"action_items",
"quotes",
"translate"
]
},
"language": {
"type": "string"
},
"targetLanguage": {
"type": "string"
},
"maxItems": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"idempotencyKey": {
"type": "string",
"maxLength": 80
}
},
"required": [
"task"
],
"additionalProperties": false
}/api/v1/subtitlesscope: readSubtitle sets of a transcript
Parameters: transcriptId (query)
/api/v1/subtitlesscope: writeGenerate subtitles (42 characters x 2 lines, 1-7 s cues by default)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"transcriptId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
"language": {
"type": "string"
},
"settings": {
"type": "object",
"properties": {
"maxChars": {
"type": "integer",
"minimum": 20,
"maximum": 80
},
"maxLines": {
"type": "integer",
"minimum": 1,
"maximum": 3
},
"minDurMs": {
"type": "integer",
"minimum": 300,
"maximum": 5000
},
"maxDurMs": {
"type": "integer",
"minimum": 1000,
"maximum": 15000
}
},
"additionalProperties": false
}
},
"required": [
"transcriptId"
],
"additionalProperties": false
}/api/v1/translatescope: writeTranslate a transcript (and build its subtitles)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"transcriptId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
"targetLanguage": {
"type": "string",
"minLength": 2,
"maxLength": 8
},
"idempotencyKey": {
"type": "string",
"maxLength": 80
}
},
"required": [
"transcriptId",
"targetLanguage"
],
"additionalProperties": false
}/api/v1/voicesscope: readVoice catalogue
/api/v1/voiceoversscope: readList voiceovers
/api/v1/voiceoversscope: writeRender a voiceover from script blocks (billed per 1,000 characters)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"blocks": {
"minItems": 1,
"maxItems": 200,
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"minLength": 1,
"maxLength": 5000
},
"voice": {
"type": "string",
"maxLength": 60
},
"pauseAfterMs": {
"type": "integer",
"minimum": 0,
"maximum": 5000
}
},
"required": [
"text"
],
"additionalProperties": false
}
},
"settings": {
"default": {},
"type": "object",
"properties": {
"speed": {
"type": "number",
"minimum": 0.5,
"maximum": 2
},
"pitchShift": {
"type": "number",
"minimum": -12,
"maximum": 12
},
"gapMs": {
"type": "integer",
"minimum": 0,
"maximum": 500
}
},
"additionalProperties": false
},
"idempotencyKey": {
"type": "string",
"maxLength": 80
}
},
"required": [
"title",
"blocks",
"settings"
],
"additionalProperties": false
}/api/v1/voiceovers/{id}scope: readGet a voiceover (download with ?download=wav|mp3)
Parameters: id (path)
/api/v1/jobs/{id}scope: readJob status and progress
Parameters: id (path)
/api/v1/jobs/{id}/cancelscope: writeCancel a queued or running job (reserved minutes are refunded)
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": {}
}/api/v1/vocabulariesscope: readCustom vocabularies
/api/v1/vocabulariesscope: writeCreate a vocabulary
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"terms": {
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"term": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"soundsLike": {
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
},
"boost": {
"type": "number",
"minimum": 0,
"maximum": 10
}
},
"required": [
"term"
],
"additionalProperties": false
}
}
},
"required": [
"name",
"terms"
],
"additionalProperties": false
}/api/v1/searchscope: readSearch across transcripts; hits carry timestamps
Parameters: q (query), limit (query)