Skip to content
SupaCloud Docs
Select themeSelect language

post_api_prompt_assist_voice_transcribe

POST
/api/prompt-assist/voice/transcribe
curl --request POST \
  --url https://example.com/api/prompt-assist/voice/transcribe \
  --header 'Content-Type: multipart/form-data' \
  --form audio=@file

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typemultipart/form-data

Multipart upload for POST /prompt-assist/voice/transcribe — the audio form field carries the recorded clip.

object
audio
required

The recorded audio clip (binary form field, sent as multipart/form-data).

string format: binary

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
accepted
required
boolean
action
required
string
created_at
required
string format: date-time
estimated_cost
number | null format: double
id
required
string format: uuid
input_text_redacted
string | null
model
string | null
output_text_redacted
string | null
task_id
string | null format: uuid
user_id
required
string format: uuid
workspace_id
required
string format: uuid
Examplegenerated
{
  "accepted": true,
  "action": "example",
  "created_at": "2026-04-15T12:00:00Z",
  "estimated_cost": 1,
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "input_text_redacted": "example",
  "model": "example",
  "output_text_redacted": "example",
  "task_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

400

Section titled “400”

Audio upload missing or invalid multipart body

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}