mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-22 08:38:13 +02:00
chore: add custom recordings documentation
This commit is contained in:
parent
2fa4191d9b
commit
dc800bdd63
6 changed files with 211 additions and 37 deletions
|
|
@ -1064,11 +1064,15 @@ export const getCampaignDefaultsApiV1OrganizationsCampaignDefaultsGet = <ThrowOn
|
|||
|
||||
/**
|
||||
* Generate a signed S3 URL
|
||||
* Return a short-lived signed URL for a transcript or recording file stored on S3.
|
||||
* Return a short-lived signed URL for a file stored on S3 / MinIO.
|
||||
*
|
||||
* Access Control:
|
||||
* * Keys that embed an organization ID (``{prefix}/{org_id}/...``) are
|
||||
* authorized by matching the org_id against the requesting user's
|
||||
* organization.
|
||||
* * Legacy keys (``recordings/{run_id}.wav``, ``transcripts/{run_id}.txt``)
|
||||
* are authorized via the workflow run they belong to.
|
||||
* * Superusers can request any key.
|
||||
* * Regular users can only request resources belonging to **their** workflow runs.
|
||||
*/
|
||||
export const getSignedUrlApiV1S3SignedUrlGet = <ThrowOnError extends boolean = false>(options: Options<GetSignedUrlApiV1S3SignedUrlGetData, ThrowOnError>) => {
|
||||
return (options.client ?? _heyApiClient).get<GetSignedUrlApiV1S3SignedUrlGetResponse, GetSignedUrlApiV1S3SignedUrlGetError, ThrowOnError>({
|
||||
|
|
|
|||
|
|
@ -3964,6 +3964,10 @@ export type GetSignedUrlApiV1S3SignedUrlGetData = {
|
|||
key: string;
|
||||
expires_in?: number;
|
||||
inline?: boolean;
|
||||
/**
|
||||
* Storage backend to use (e.g. 'minio', 's3'). When omitted the backend is inferred from the resource.
|
||||
*/
|
||||
storage_backend?: string | null;
|
||||
};
|
||||
url: '/api/v1/s3/signed-url';
|
||||
};
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue