> ## Documentation Index
> Fetch the complete documentation index at: https://docs.deapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Audio-to-Text (X Spaces Transcription)
> Endpoint for requesting audio transcription (Twitter Spaces)
**Prerequisite:** To ensure a successful request, you must first consult the [Model Selection](/api/v1/utilities/model-selection) endpoint to identify a valid model `slug`, check specific **limits** and **features**, and verify **LoRA** availability.
## Technical Notes & Constraints
### Spaces Support
* **Completed Spaces Only**: The API does not support live (ongoing) X Spaces. If a URL for an active Space is provided, the API will return a validation error. Please ensure the Space has ended before submission.
* **Max Duration**: 90 minutes
### Progress Tracking (URL/Spaces)
* **Download Phase:** Due to external stream handling, the task progress will remain at 0% for the entire duration of the audio download.
* **Transcription Phase**: Once the download is complete, the progress status will jump to 50% and update incrementally until finished.
* A prolonged 0% status is normal behavior for long X Spaces.
Transcription for standard video posts on X is handled via the [Video-to-Text](/api/v1/analysis/video-to-text) endpoint.
## OpenAPI
````yaml openapi.json POST /api/v1/client/aud2txt
openapi: 3.0.0
info:
title: deAPI REST API
description: >-
Decentralized AI inference API for image generation, video processing, audio
transcription, and more.
contact:
name: deAPI Support
url: https://deapi.ai
email: support@deapi.ai
version: 0.0.1
servers:
- url: https://api.deapi.ai
description: Production API Server base URL
security:
- bearerAuth: []
tags:
- name: Client API
description: Endpoints for client operations
paths:
/api/v1/client/aud2txt:
post:
tags:
- Client API
description: Endpoint for requesting audio transcription (Twitter Spaces)
operationId: requestAud2Txt
parameters:
- $ref: '#/components/parameters/AcceptHeader'
requestBody:
description: Audio transcription parameters
required: true
content:
application/json:
schema:
required:
- audio_url
- include_ts
- model
properties:
audio_url:
description: URL of Twitter Spaces audio to transcribe
type: string
example: https://twitter.com/i/spaces/1nAKEERkeLbKL
include_ts:
description: Should transcription include timestamps
type: boolean
model:
description: >-
The model to use for transcription. Available models can be
retrieved via the GET /api/v1/client/models endpoint.
type: string
example: WhisperLargeV3
return_result_in_response:
description: >-
If true, the result will be returned directly in the
response instead of only download url. Optional parameter.
type: boolean
default: false
example: false
nullable: true
webhook_url:
description: >-
Optional HTTPS URL to receive webhook notifications for job
status changes (processing, completed, failed). Must be
HTTPS. Max 2048 characters. See [Webhook
Documentation](/execution-modes-and-integrations/webhooks)
for payload structure and authentication details.
type: string
format: uri
maxLength: 2048
example: https://your-server.com/webhooks/deapi
nullable: true
type: object
responses:
'200':
description: ID of the inference request.
content:
application/json:
schema:
$ref: '#/components/schemas/JobRequestResponseResource'
'401':
description: Unauthorized user.
content:
application/json:
schema:
$ref: '#/components/schemas/response_error_default'
'404':
description: Not found.
content:
application/json:
schema:
$ref: '#/components/schemas/response_error_default'
'422':
$ref: '#/components/responses/ValidationError'
'429':
$ref: '#/components/responses/RateLimitExceeded'
security:
- bearerAuth: []
components:
parameters:
AcceptHeader:
name: Accept
in: header
required: true
schema:
type: string
default: application/json
enum:
- application/json
schemas:
JobRequestResponseResource:
properties:
data:
description: Information from success endpoint
properties:
request_id:
description: Request Id
required:
- request_id
type: string
example: c08a339c-73e5-4d67-a4d5-231302fbff9a
type: object
type: object
response_error_default:
properties:
data:
description: Information from success endpoint
type: object
message:
description: Error general message
type: string
errors:
description: Information about errors
type: array
items: {}
statusCode:
description: Status code
type: integer
type: object
response_error_rate_limit:
description: Rate limit exceeded response
properties:
message:
description: Error message
type: string
example: Too Many Attempts.
type: object
responses:
ValidationError:
description: >-
Validation failed. Common errors include: model does not exist, model
does not support the inference type for this endpoint, or invalid
request parameters.
content:
application/json:
schema:
properties:
message:
description: General error message
type: string
example: The selected model does not support Text To Image.
errors:
description: Detailed validation errors by field
type: object
example:
model:
- The selected model does not support Text To Image.
type: object
RateLimitExceeded:
description: >-
Rate limit exceeded. Check X-RateLimit-Type header to determine if
minute (RPM) or daily (RPD) limit was hit.
headers:
X-RateLimit-Limit:
description: Maximum requests allowed per minute (RPM)
schema:
type: integer
example: 3
X-RateLimit-Remaining:
description: Remaining requests in current minute window
schema:
type: integer
example: 0
X-RateLimit-Daily-Limit:
description: Maximum requests allowed per day (RPD)
schema:
type: integer
example: 100
X-RateLimit-Daily-Remaining:
description: Remaining requests in current day window
schema:
type: integer
example: 95
X-RateLimit-Type:
description: 'Type of rate limit exceeded: "minute" for RPM, "daily" for RPD'
schema:
type: string
enum:
- minute
- daily
example: minute
Retry-After:
description: >-
Seconds until rate limit resets (60 for minute, up to 86400 for
daily)
schema:
type: integer
example: 60
content:
application/json:
schema:
$ref: '#/components/schemas/response_error_rate_limit'
securitySchemes:
bearerAuth:
type: http
bearerFormat: JWT
scheme: bearer
````