diff --git a/fern/assistants/call-recording.mdx b/fern/assistants/call-recording.mdx index 855949d14..6cc9f3263 100644 --- a/fern/assistants/call-recording.mdx +++ b/fern/assistants/call-recording.mdx @@ -398,6 +398,10 @@ console.log("Messages:", call.artifact.messages); console.log("Nodes:", call.artifact.nodes); ``` + + The `recording` and `logUrl` values are private, authenticated URLs — they can't be downloaded directly. See [Retrieve call artifacts](/assistants/retrieve-call-artifacts) for how to fetch the actual files. + + ## Privacy and Compliance ### Legal Considerations @@ -438,7 +442,6 @@ Use the comprehensive artifact data for analysis: { "callId": "call-123", "artifact": { - "recording": "https://api.vapi.ai/recordings/call-123.mp3", "transcript": [ { "role": "assistant", @@ -451,7 +454,6 @@ Use the comprehensive artifact data for analysis: "time": 3.2 } ], - "logUrl": "https://api.vapi.ai/logs/call-123.json", "messages": [ { "role": "assistant", diff --git a/fern/security-and-privacy/retrieve-call-artifacts.mdx b/fern/assistants/retrieve-call-artifacts.mdx similarity index 92% rename from fern/security-and-privacy/retrieve-call-artifacts.mdx rename to fern/assistants/retrieve-call-artifacts.mdx index 3c30851b0..883afcfb6 100644 --- a/fern/security-and-privacy/retrieve-call-artifacts.mdx +++ b/fern/assistants/retrieve-call-artifacts.mdx @@ -2,12 +2,12 @@ title: Retrieve call artifacts subtitle: Download recordings and call logs from Vapi's private storage using authenticated, short-lived URLs. description: How to download call recordings and logs from Vapi's private storage using your Private API Key and short-lived, authenticated redirect URLs. -slug: security-and-privacy/retrieve-call-artifacts +slug: assistants/retrieve-call-artifacts --- ## Overview -For HIPAA-enabled organizations, call recordings and logs are stored in a private bucket. These URLs are not directly downloadable. +Call recordings and logs are stored in a private bucket. These URLs aren't directly downloadable. To retrieve a recording or log file, call the Vapi API with your **Private API Key**. The API responds with a `302` redirect to a short-lived, authenticated download URL. @@ -67,4 +67,4 @@ curl -L \ Signed URLs returned by these endpoints expire after a short period. Always request a fresh URL from the API rather than caching the redirect target. - \ No newline at end of file + diff --git a/fern/docs.yml b/fern/docs.yml index 3a8641ad6..31f77c4b4 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -386,6 +386,9 @@ navigation: - page: Call recording path: assistants/call-recording.mdx icon: fa-light fa-circle-dot + - page: Retrieve call artifacts + path: assistants/retrieve-call-artifacts.mdx + icon: fa-light fa-download # Squads moved to top-level section - section: Outbound Campaigns @@ -754,8 +757,6 @@ navigation: path: security-and-privacy/hipaa.mdx - page: Zero Data Retention (ZDR) path: security-and-privacy/zero-data-retention.mdx - - page: Retrieve call artifacts - path: security-and-privacy/retrieve-call-artifacts.mdx - page: PCI compliance path: security-and-privacy/PCI.mdx - page: Proxy server guide @@ -885,6 +886,8 @@ navigation: - tab: changelog redirects: + - source: /security-and-privacy/retrieve-call-artifacts + destination: /assistants/retrieve-call-artifacts - source: /developer-documentation destination: /introduction - source: /documentation/general/changelog diff --git a/fern/fern.config.json b/fern/fern.config.json index c3f63d1c3..11fe60d5f 100644 --- a/fern/fern.config.json +++ b/fern/fern.config.json @@ -1,4 +1,4 @@ { "organization": "vapi", - "version": "5.59.0" + "version": "5.72.1" } diff --git a/fern/security-and-privacy/hipaa.mdx b/fern/security-and-privacy/hipaa.mdx index ffff1cd0a..73fa7149c 100644 --- a/fern/security-and-privacy/hipaa.mdx +++ b/fern/security-and-privacy/hipaa.mdx @@ -217,7 +217,7 @@ When HIPAA mode is enabled, Vapi does not store structured outputs by default. T ## Retrieving Call Artifacts from Private Storage -For HIPAA-enabled organizations, call recordings and logs are stored in a private bucket and cannot be downloaded directly from the URLs returned in webhooks or API responses. To retrieve recordings, call logs, or other artifacts, call the Vapi API with your Private API Key, see [Retrieve call artifacts](/security-and-privacy/retrieve-call-artifacts) for the full list of endpoints and example requests. This retrieval method is the same for HIPAA and non-HIPAA organizations alike. +For HIPAA-enabled organizations, call recordings and logs are stored in a private bucket and cannot be downloaded directly from the URLs returned in webhooks or API responses. To retrieve recordings, call logs, or other artifacts, call the Vapi API with your Private API Key, see [Retrieve call artifacts](/assistants/retrieve-call-artifacts) for the full list of endpoints and example requests. This retrieval method is the same for HIPAA and non-HIPAA organizations alike. ## Need Further Assistance?