AdnovaDocs
Creative Hub

Generate a file transcription

Start an AI transcription job for a specific file version. Transcription is only supported for **video** files. The job runs asynchronously — the response returns immediately with status: inprogress; poll Get a file transcription until status is success. Idempotent — if a transcription already exists for the version, the existing record is returned instead of starting a new job. Subject to your plan's transcription quota.

POST
/files/{fileId}/versions/{versionId}/transcription

Authentication

authentication
api-key<token>

Create an API key from the Adnova dashboard (Account integrations). Pass the key value in the api-key request header on every call.

In: header

Path Parameters

fileId*string

File id.

Length1 <= length
versionId*string

File version id (returned by the upload-complete endpoints).

Length1 <= length

Header Parameters

x-workspace-id*string

Workspace the request operates in. Get it from List workspaces.

Length1 <= length
x-org-id*string

Organization context (required on every endpoint).

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.adnova.ai/creative-hub/v1/files/01J8ZF9K8M7N6P5R4S3T2V1W0X/versions/01J8ZG0L9N8P7Q6R5S4T3V2W1Y/transcription" \  -H "x-workspace-id: 01J8ZQ9X2K3M4N5P6R7S8T9V0W" \  -H "x-org-id: 01J8ZQ7B3C4D5F6G7H8K9M0N1P"
{
  "fileId": "01J8ZF9K8M7N6P5R4S3T2V1W0X",
  "versionId": "01J8ZG0L9N8P7Q6R5S4T3V2W1Y",
  "status": "success",
  "transcription": {
    "text": "Introducing the spring collection...",
    "segments": [
      {
        "id": 0,
        "start": 0,
        "end": 3.2,
        "text": "Introducing the spring collection"
      }
    ]
  },
  "error": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "finishedAt": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}