Get File | Vapi

curl https://api.vapi.ai/file/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "orgId": "org_9a8b7c6d5e4f3g2h1i0j",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "object": "file",
  "status": "processing",
  "name": "Meeting_Audio_Recording",
  "originalName": "meeting_recording_2024_04_20.mp3",
  "bytes": 5242880,
  "purpose": "transcription",
  "mimetype": "audio/mpeg",
  "key": "audio/2024/04/20/meeting_recording_2024_04_20.mp3",
  "path": "/audio/2024/04/20/meeting_recording_2024_04_20.mp3",
  "bucket": "vapi-audio-files",
  "url": "https://vapi-audio-files.s3.amazonaws.com/audio/2024/04/20/meeting_recording_2024_04_20.mp3",
  "parsedTextUrl": "https://vapi-audio-files.s3.amazonaws.com/transcripts/2024/04/20/meeting_recording_2024_04_20.txt",
  "parsedTextBytes": 102400,
  "metadata": {
    "durationSeconds": 3600,
    "language": "en-US",
    "speakerCount": 3
  }
}

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Path parameters

idstringRequired

Response

idstring

This is the unique identifier for the file.

orgIdstring

This is the unique identifier for the org that this file belongs to.

createdAtdatetime

This is the ISO 8601 date-time string of when the file was created.

updatedAtdatetime

This is the ISO 8601 date-time string of when the file was last updated.

objectenum

Allowed values:

statusenum

Allowed values:

namestring<=40 characters

This is the name of the file. This is just for your own reference.

originalNamestring

bytesdouble

purposestring

mimetypestring

keystring

pathstring

bucketstring

urlstring

parsedTextUrlstring

parsedTextBytesdouble

metadataobject

$	curl https://api.vapi.ai/file/id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

1	{
2	"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3	"orgId": "org_9a8b7c6d5e4f3g2h1i0j",
4	"createdAt": "2024-01-15T09:30:00Z",
5	"updatedAt": "2024-01-15T09:30:00Z",
6	"object": "file",
7	"status": "processing",
8	"name": "Meeting_Audio_Recording",
9	"originalName": "meeting_recording_2024_04_20.mp3",
10	"bytes": 5242880,
11	"purpose": "transcription",
12	"mimetype": "audio/mpeg",
13	"key": "audio/2024/04/20/meeting_recording_2024_04_20.mp3",
14	"path": "/audio/2024/04/20/meeting_recording_2024_04_20.mp3",
15	"bucket": "vapi-audio-files",
16	"url": "https://vapi-audio-files.s3.amazonaws.com/audio/2024/04/20/meeting_recording_2024_04_20.mp3",
17	"parsedTextUrl": "https://vapi-audio-files.s3.amazonaws.com/transcripts/2024/04/20/meeting_recording_2024_04_20.txt",
18	"parsedTextBytes": 102400,
19	"metadata": {
20	"durationSeconds": 3600,
21	"language": "en-US",
22	"speakerCount": 3
23	}
24	}