AutoClip

REST API · v1

Audio transcription

Requests use snake_case and responses use shared camelCase DTOs. Use the advertised model and funded AutoClip credits. Duration-only quotes are estimates; prepare a source for an exact quote. Keep operation IDs and approved budgets unchanged during recovery. Availability is controlled by the server.

https://polished-turtle-977.convex.siteGet an API key
GET

/api/v1/transcription/operations

Recover original submission

Input
?operation_id=original&kind=job|source
Response shape
{state:'absent'|'created'|'abandoned',actorId,scopeKey,jobId?,sourceId?,job?:DTO|null,source?:DTO|null}; absent is not cancellation

Available to free accounts.

curl --request GET 'https://polished-turtle-977.convex.site/api/v1/transcription/operations' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
POST

/api/v1/transcription/operations/abandon

Discard unresolved request

Input
{operation_id,kind:'job'|'source',expected_scope_key?}
Response shape
OperationState; only abandoned fences late insertion; created never auto-cancels/deletes; independently read before clearing recovery

Available to free accounts.

curl --request POST 'https://polished-turtle-977.convex.site/api/v1/transcription/operations/abandon' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY" \
  --header "Content-Type: application/json" \
  --data @request.json

Save the input fields as request.json before running a write request. Replace path placeholders with your own IDs.

DELETE

/api/v1/transcription/sources/{id}

Discard audio source

Input
{expected_scope_key?}
Response shape
{sourceId,deleted:true}; active paid job pins source; replay same-ID deletion and read back after lost ACK

Available to free accounts.

curl --request DELETE 'https://polished-turtle-977.convex.site/api/v1/transcription/sources/{id}' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY" \
  --header "Content-Type: application/json" \
  --data @request.json
GET

/api/v1/transcription/capabilities

Audio transcription

Response shape
{actorId,available,canPrepare,canManage,reason,scopeKey,models,limits}

Available to free accounts.

curl --request GET 'https://polished-turtle-977.convex.site/api/v1/transcription/capabilities' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
GET

/api/v1/transcription/models

Scribe v2

Response shape
{models:[{id,available,priceVersion,minimumCredits,languages,parameters,maxSourceBytes,maxDurationSeconds,…}]}

Available to free accounts.

curl --request GET 'https://polished-turtle-977.convex.site/api/v1/transcription/models' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
POST

/api/v1/transcription/uploads

Upload audio

Input
{operation_id,filename,content_type,size_bytes,expected_scope_key?}; operation_id may instead be matching Idempotency-Key (ASCII8–128, excludes auto:)
Response shape
{uploadId,source,upload:{url,method:'PUT',headers,expiresAt,sizeBytes}|null}; upload:null means read source, never PUT again
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/transcription/uploads' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY" \
  --header "Content-Type: application/json" \
  --data @request.json

Save the input fields as request.json before running a write request. Replace path placeholders with your own IDs.

POST

/api/v1/transcription/sources

Prepare audio

Input
{operation_id,upload_id|audio_url,expected_scope_key?}; reuse upload operation_id
Response shape
SourceDTO {sourceId,actorId,operationId,scopeKey,status,durationSeconds,sourceIdentity,clock,error}
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/transcription/sources' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY" \
  --header "Content-Type: application/json" \
  --data @request.json

Save the input fields as request.json before running a write request. Replace path placeholders with your own IDs.

GET

/api/v1/transcription/sources

Recover original source

Input
?operation_id=original-operation
Response shape
SourceDTO or404; absence does not cancel an in-flight operation

Available to free accounts.

curl --request GET 'https://polished-turtle-977.convex.site/api/v1/transcription/sources' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
GET

/api/v1/transcription/sources/{id}

Audio source

Response shape
SourceDTO; submission_unknown preserves original preparation receipt

Available to free accounts.

curl --request GET 'https://polished-turtle-977.convex.site/api/v1/transcription/sources/{id}' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
POST

/api/v1/transcription/sources/{id}/reconcile

Check preparation receipt

Input
{expected_scope_key?}; max8 GET-only recovery checks
Response shape
SourceDTO; no new source decode, provider POST or debit

Available to free accounts.

curl --request POST 'https://polished-turtle-977.convex.site/api/v1/transcription/sources/{id}/reconcile' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY" \
  --header "Content-Type: application/json" \
  --data @request.json

Save the input fields as request.json before running a write request. Replace path placeholders with your own IDs.

POST

/api/v1/transcription/quote

Get exact quote

Input
{model,source_id|duration_seconds,language?,diarize?,tag_audio_events?,keyterms?,num_speakers?:null}
Response shape
Exact {quoteId,sourceIdentity,scopeKey,options,estimatedCredits,canStart,reason,expiresAt}; estimate {quoteId:null,authoritative:false}
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/transcription/quote' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY" \
  --header "Content-Type: application/json" \
  --data @request.json

Save the input fields as request.json before running a write request. Replace path placeholders with your own IDs.

POST

/api/v1/transcription/jobs

Approve and transcribe

Input
{operation_id,source_id,quote_id,expected_scope_key,max_credits}
Response shape
202 JobDTO {jobId,actorId,operationId,scopeKey,status,reservedCredits,chargedCredits,refundedCredits,…}
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/transcription/jobs' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY" \
  --header "Content-Type: application/json" \
  --data @request.json

Save the input fields as request.json before running a write request. Replace path placeholders with your own IDs.

POST

/api/v1/transcription/audio/transcriptions

Audio transcription

Input
{operation_id,model,upload_id|audio_url,language?,diarize?,tag_audio_events?,keyterms?,max_credits?,webhook_url?,expected_scope_key?}; omitted max_credits approves900s tariff ceiling; webhook must be registered active endpoint
Response shape
202 JobDTO; preparing may hold0 until trusted source admits exact tariff; submission_unknown stays held
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/transcription/audio/transcriptions' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY" \
  --header "Content-Type: application/json" \
  --data @request.json

Save the input fields as request.json before running a write request. Replace path placeholders with your own IDs.

GET

/api/v1/transcription/jobs

Transcription history

Input
?limit=20 (1–100)&scope=key|org&after=opaque-cursor
Response shape
{jobs,continueCursor,isDone}; key scope default

Available to free accounts.

curl --request GET 'https://polished-turtle-977.convex.site/api/v1/transcription/jobs' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
GET

/api/v1/transcription/jobs/{id}

Audio transcription

Response shape
JobDTO {status,clock,resultExpired,error,estimatedCredits,reservedCredits,chargedCredits,refundedCredits,…}

Available to free accounts.

curl --request GET 'https://polished-turtle-977.convex.site/api/v1/transcription/jobs/{id}' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
GET

/api/v1/transcription/jobs/{id}/result

Load transcript and downloads

Response shape
{job,result|null,downloads:[{format,url,expiresAt,sizeBytes,sha256}],inlineResultOmittedReason?:'download_required'}; canonical_audio timestamps;7day retention; no rerun

Available to free accounts.

curl --request GET 'https://polished-turtle-977.convex.site/api/v1/transcription/jobs/{id}/result' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
POST

/api/v1/transcription/jobs/{id}/cancel

Cancel before dispatch

Input
{expected_scope_key?}
Response shape
JobDTO; dispatched/unknown work remains held

Available to free accounts.

curl --request POST 'https://polished-turtle-977.convex.site/api/v1/transcription/jobs/{id}/cancel' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY" \
  --header "Content-Type: application/json" \
  --data @request.json

Save the input fields as request.json before running a write request. Replace path placeholders with your own IDs.

DELETE

/api/v1/transcription/jobs/{id}

Delete transcription

Input
{expected_scope_key?}
Response shape
{jobId,deleted:true}; durable tombstones retained; replay and independent readback after lost ACK

Available to free accounts.

curl --request DELETE 'https://polished-turtle-977.convex.site/api/v1/transcription/jobs/{id}' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY" \
  --header "Content-Type: application/json" \
  --data @request.json