manifest¶

Variables¶

OPENAI_REALTIME_V1_MODEL¶

const OPENAI_REALTIME_V1_MODEL: "gpt-realtime-2" = "gpt-realtime-2";

openAIVoiceManifestInput¶

const openAIVoiceManifestInput: {
  capabilities: (
     | {
     audiences: "customer-facing"[];
     capability: string;
     changesWorkflow?: never;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect?: never;
   }
     | {
     audiences: "customer-facing"[];
     capability: string;
     changesWorkflow?: never;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect: true;
   }
     | {
     audiences: ("customer-facing" | "internal-support")[];
     capability: string;
     changesWorkflow: true;
     description: string;
     exposesSensitiveData?: never;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect: true;
  })[];
  category: string;
  channelAudiences: ("customer-facing" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url: string;
     }[];
     notes: string[];
     scope: "provider-api-subset";
  };
  credentialRequirements: {
     description: string;
     id: string;
     label: string;
     metadata: {
        minimumAccess: string[];
        projectScoped: boolean;
        scopeModel: string;
     };
     required: true;
  }[];
  directions: "bidirectional"[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "official";
  }[];
  metadata: {
     channelCoverage: {
        ephemeralSessionIssuance: string;
        outboundCalling: string;
        realtimeAudio: string;
        realtimeToolCalls: string;
        realtimeTranscript: string;
        telephony: string;
        transcriptionOnlySessions: string;
     };
     implementation: {
        adapterCoverage: string[];
        rawClientEscapeHatch: boolean;
        sdkPackage: string;
        sdkPackages: string[];
        strategy: string;
        verifiedAt: string;
        verifiedVersion: string;
     };
     integrationEntryPoints: {
        manifest: string;
        runtime: string;
     };
     integrationName: string;
     integrationPackageName: string;
     rawClient: {
        coverage: string;
        export: string;
        option: string;
     };
  };
  name: string;
  operations: (
     | {
     alias: string;
     capability: string;
     exposesSensitiveData: true;
     externallyVisible?: never;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect?: never;
   }
     | {
     alias: string;
     capability: string;
     exposesSensitiveData?: never;
     externallyVisible: true;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect: true;
  })[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "official";
};

Type Declaration¶

Name	Type
`capabilities`	( \| { `audiences`: `"customer-facing"`[]; `capability`: `string`; `changesWorkflow?`: `never`; `description`: `string`; `exposesSensitiveData`: `true`; `label`: `string`; `providerObjects`: { `kind`: `string`; `label`: `string`; }[]; `requiresCredential`: `true`; `sideEffect?`: `never`; } \| { `audiences`: `"customer-facing"`[]; `capability`: `string`; `changesWorkflow?`: `never`; `description`: `string`; `exposesSensitiveData`: `true`; `label`: `string`; `providerObjects`: { `kind`: `string`; `label`: `string`; }[]; `requiresCredential`: `true`; `sideEffect`: `true`; } \| { `audiences`: (`"customer-facing"` \| `"internal-support"`)[]; `capability`: `string`; `changesWorkflow`: `true`; `description`: `string`; `exposesSensitiveData?`: `never`; `label`: `string`; `providerObjects`: { `kind`: `string`; `label`: `string`; }[]; `requiresCredential`: `true`; `sideEffect`: `true`; })[]
`category`	`string`
`channelAudiences`	(`"customer-facing"` \| `"mixed"`)[]
`coverage`	{ `evidence`: { `label`: `string`; `url`: `string`; }[]; `notes`: `string`[]; `scope`: `"provider-api-subset"`; }
`coverage.evidence`	{ `label`: `string`; `url`: `string`; }[]
`coverage.notes`	`string`[]
`coverage.scope`	`"provider-api-subset"`
`credentialRequirements`	{ `description`: `string`; `id`: `string`; `label`: `string`; `metadata`: { `minimumAccess`: `string`[]; `projectScoped`: `boolean`; `scopeModel`: `string`; }; `required`: `true`; }[]
`directions`	`"bidirectional"`[]
`id`	`string`
`limitations`	`string`[]
`maintainers`	{ `name`: `string`; `type`: `"official"`; }[]
`metadata`	{ `channelCoverage`: { `ephemeralSessionIssuance`: `string`; `outboundCalling`: `string`; `realtimeAudio`: `string`; `realtimeToolCalls`: `string`; `realtimeTranscript`: `string`; `telephony`: `string`; `transcriptionOnlySessions`: `string`; }; `implementation`: { `adapterCoverage`: `string`[]; `rawClientEscapeHatch`: `boolean`; `sdkPackage`: `string`; `sdkPackages`: `string`[]; `strategy`: `string`; `verifiedAt`: `string`; `verifiedVersion`: `string`; }; `integrationEntryPoints`: { `manifest`: `string`; `runtime`: `string`; }; `integrationName`: `string`; `integrationPackageName`: `string`; `rawClient`: { `coverage`: `string`; `export`: `string`; `option`: `string`; }; }
`metadata.channelCoverage`	{ `ephemeralSessionIssuance`: `string`; `outboundCalling`: `string`; `realtimeAudio`: `string`; `realtimeToolCalls`: `string`; `realtimeTranscript`: `string`; `telephony`: `string`; `transcriptionOnlySessions`: `string`; }
`metadata.channelCoverage.ephemeralSessionIssuance`	`string`
`metadata.channelCoverage.outboundCalling`	`string`
`metadata.channelCoverage.realtimeAudio`	`string`
`metadata.channelCoverage.realtimeToolCalls`	`string`
`metadata.channelCoverage.realtimeTranscript`	`string`
`metadata.channelCoverage.telephony`	`string`
`metadata.channelCoverage.transcriptionOnlySessions`	`string`
`metadata.implementation`	{ `adapterCoverage`: `string`[]; `rawClientEscapeHatch`: `boolean`; `sdkPackage`: `string`; `sdkPackages`: `string`[]; `strategy`: `string`; `verifiedAt`: `string`; `verifiedVersion`: `string`; }
`metadata.implementation.adapterCoverage`	`string`[]
`metadata.implementation.rawClientEscapeHatch`	`boolean`
`metadata.implementation.sdkPackage`	`string`
`metadata.implementation.sdkPackages`	`string`[]
`metadata.implementation.strategy`	`string`
`metadata.implementation.verifiedAt`	`string`
`metadata.implementation.verifiedVersion`	`string`
`metadata.integrationEntryPoints`	{ `manifest`: `string`; `runtime`: `string`; }
`metadata.integrationEntryPoints.manifest`	`string`
`metadata.integrationEntryPoints.runtime`	`string`
`metadata.integrationName`	`string`
`metadata.integrationPackageName`	`string`
`metadata.rawClient`	{ `coverage`: `string`; `export`: `string`; `option`: `string`; }
`metadata.rawClient.coverage`	`string`
`metadata.rawClient.export`	`string`
`metadata.rawClient.option`	`string`
`name`	`string`
`operations`	( \| { `alias`: `string`; `capability`: `string`; `exposesSensitiveData`: `true`; `externallyVisible?`: `never`; `providerObject`: `string`; `providerOperation`: `string`; `requiresCredential`: `true`; `sideEffect?`: `never`; } \| { `alias`: `string`; `capability`: `string`; `exposesSensitiveData?`: `never`; `externallyVisible`: `true`; `providerObject`: `string`; `providerOperation`: `string`; `requiresCredential`: `true`; `sideEffect`: `true`; })[]
`packageName`	`string`
`privacyNotes`	`string`[]
`provider`	`string`
`trustLevel`	`"official"`

openAIVoiceProviderManifest¶

const openAIVoiceProviderManifest: {
  capabilities: {
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension?: boolean;
     label?: string;
     metadata?: Record<string, unknown>;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  category: string;
  channelAudiences: ("customer-facing" | "internal-support" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url?: string;
     }[];
     notes: string[];
     scope:   | "support-workflow-subset"
        | "provider-api-subset"
        | "connector-required"
        | "local-protocol"
        | "full-provider-api";
  };
  credentialRequirements: {
     description?: string;
     id: string;
     label?: string;
     metadata?: Record<string, unknown>;
     required: boolean;
     scopes: string[];
  }[];
  directions: (
     | "receive-only"
     | "send-only"
     | "inbound-only"
     | "outbound-only"
    | "bidirectional")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "community" | "official" | "unknown" | "partner";
     url?: string;
  }[];
  metadata?: Record<string, unknown>;
  name: string;
  operations: {
     alias: string;
     audience?: "customer-facing" | "internal-support" | "mixed";
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension: boolean;
     externallyVisible?: boolean;
     inputSchema?: unknown;
     inputSchemaName?: string;
     inputSchemaRef?: string;
     label?: string;
     metadata?: Record<string, unknown>;
     outputSchema?: unknown;
     outputSchemaName?: string;
     outputSchemaRef?: string;
     providerObject?: string;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     providerOperation?: string;
     requiredPolicyIds?: string[];
     requiresApproval?: boolean;
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "community" | "official" | "verified" | "experimental";
} & {
  capabilities: (
     | {
     audiences: "customer-facing"[];
     capability: string;
     changesWorkflow?: never;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect?: never;
   }
     | {
     audiences: "customer-facing"[];
     capability: string;
     changesWorkflow?: never;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect: true;
   }
     | {
     audiences: ("customer-facing" | "internal-support")[];
     capability: string;
     changesWorkflow: true;
     description: string;
     exposesSensitiveData?: never;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect: true;
  })[];
  category: string;
  channelAudiences: ("customer-facing" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url: string;
     }[];
     notes: string[];
     scope: "provider-api-subset";
  };
  credentialRequirements: {
     description: string;
     id: string;
     label: string;
     metadata: {
        minimumAccess: string[];
        projectScoped: boolean;
        scopeModel: string;
     };
     required: true;
  }[];
  directions: "bidirectional"[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "official";
  }[];
  metadata: {
     channelCoverage: {
        ephemeralSessionIssuance: string;
        outboundCalling: string;
        realtimeAudio: string;
        realtimeToolCalls: string;
        realtimeTranscript: string;
        telephony: string;
        transcriptionOnlySessions: string;
     };
     implementation: {
        adapterCoverage: string[];
        rawClientEscapeHatch: boolean;
        sdkPackage: string;
        sdkPackages: string[];
        strategy: string;
        verifiedAt: string;
        verifiedVersion: string;
     };
     integrationEntryPoints: {
        manifest: string;
        runtime: string;
     };
     integrationName: string;
     integrationPackageName: string;
     rawClient: {
        coverage: string;
        export: string;
        option: string;
     };
  };
  name: string;
  operations: (
     | {
     alias: string;
     capability: string;
     exposesSensitiveData: true;
     externallyVisible?: never;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect?: never;
   }
     | {
     alias: string;
     capability: string;
     exposesSensitiveData?: never;
     externallyVisible: true;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect: true;
  })[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "official";
};

Type Declaration¶

Name	Type
`capabilities`	{ `audiences?`: (`"customer-facing"` \| `"internal-support"` \| `"mixed"`)[]; `capability`: `string`; `changesWorkflow?`: `boolean`; `description?`: `string`; `exposesSensitiveData?`: `boolean`; `extension?`: `boolean`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `providerObjects?`: { `description?`: `string`; `kind`: `string`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `schemaName?`: `string`; }[]; `requiresCredential?`: `boolean`; `sideEffect?`: `boolean`; }[]
`category`	`string`
`channelAudiences`	(`"customer-facing"` \| `"internal-support"` \| `"mixed"`)[]
`coverage`	{ `evidence`: { `label`: `string`; `url?`: `string`; }[]; `notes`: `string`[]; `scope`: \| `"support-workflow-subset"` \| `"provider-api-subset"` \| `"connector-required"` \| `"local-protocol"` \| `"full-provider-api"`; }
`coverage.evidence`	{ `label`: `string`; `url?`: `string`; }[]
`coverage.notes`	`string`[]
`coverage.scope`	\| `"support-workflow-subset"` \| `"provider-api-subset"` \| `"connector-required"` \| `"local-protocol"` \| `"full-provider-api"`
`credentialRequirements`	{ `description?`: `string`; `id`: `string`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `required`: `boolean`; `scopes`: `string`[]; }[]
`directions`	( \| `"receive-only"` \| `"send-only"` \| `"inbound-only"` \| `"outbound-only"` \| `"bidirectional"`)[]
`id`	`string`
`limitations`	`string`[]
`maintainers`	{ `name`: `string`; `type`: `"community"` \| `"official"` \| `"unknown"` \| `"partner"`; `url?`: `string`; }[]
`metadata?`	`Record`\<`string`, `unknown`>
`name`	`string`
`operations`	{ `alias`: `string`; `audience?`: `"customer-facing"` \| `"internal-support"` \| `"mixed"`; `audiences?`: (`"customer-facing"` \| `"internal-support"` \| `"mixed"`)[]; `capability`: `string`; `changesWorkflow?`: `boolean`; `description?`: `string`; `exposesSensitiveData?`: `boolean`; `extension`: `boolean`; `externallyVisible?`: `boolean`; `inputSchema?`: `unknown`; `inputSchemaName?`: `string`; `inputSchemaRef?`: `string`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `outputSchema?`: `unknown`; `outputSchemaName?`: `string`; `outputSchemaRef?`: `string`; `providerObject?`: `string`; `providerObjects?`: { `description?`: `string`; `kind`: `string`; `label?`: `string`; `metadata?`: `Record`\<`string`, `unknown`>; `schemaName?`: `string`; }[]; `providerOperation?`: `string`; `requiredPolicyIds?`: `string`[]; `requiresApproval?`: `boolean`; `requiresCredential?`: `boolean`; `sideEffect?`: `boolean`; }[]
`packageName`	`string`
`privacyNotes`	`string`[]
`provider`	`string`
`trustLevel`	`"community"` \| `"official"` \| `"verified"` \| `"experimental"`

Type Declaration¶

Name	Type
`capabilities`	( \| { `audiences`: `"customer-facing"`[]; `capability`: `string`; `changesWorkflow?`: `never`; `description`: `string`; `exposesSensitiveData`: `true`; `label`: `string`; `providerObjects`: { `kind`: `string`; `label`: `string`; }[]; `requiresCredential`: `true`; `sideEffect?`: `never`; } \| { `audiences`: `"customer-facing"`[]; `capability`: `string`; `changesWorkflow?`: `never`; `description`: `string`; `exposesSensitiveData`: `true`; `label`: `string`; `providerObjects`: { `kind`: `string`; `label`: `string`; }[]; `requiresCredential`: `true`; `sideEffect`: `true`; } \| { `audiences`: (`"customer-facing"` \| `"internal-support"`)[]; `capability`: `string`; `changesWorkflow`: `true`; `description`: `string`; `exposesSensitiveData?`: `never`; `label`: `string`; `providerObjects`: { `kind`: `string`; `label`: `string`; }[]; `requiresCredential`: `true`; `sideEffect`: `true`; })[]
`category`	`string`
`channelAudiences`	(`"customer-facing"` \| `"mixed"`)[]
`coverage`	{ `evidence`: { `label`: `string`; `url`: `string`; }[]; `notes`: `string`[]; `scope`: `"provider-api-subset"`; }
`coverage.evidence`	{ `label`: `string`; `url`: `string`; }[]
`coverage.notes`	`string`[]
`coverage.scope`	`"provider-api-subset"`
`credentialRequirements`	{ `description`: `string`; `id`: `string`; `label`: `string`; `metadata`: { `minimumAccess`: `string`[]; `projectScoped`: `boolean`; `scopeModel`: `string`; }; `required`: `true`; }[]
`directions`	`"bidirectional"`[]
`id`	`string`
`limitations`	`string`[]
`maintainers`	{ `name`: `string`; `type`: `"official"`; }[]
`metadata`	{ `channelCoverage`: { `ephemeralSessionIssuance`: `string`; `outboundCalling`: `string`; `realtimeAudio`: `string`; `realtimeToolCalls`: `string`; `realtimeTranscript`: `string`; `telephony`: `string`; `transcriptionOnlySessions`: `string`; }; `implementation`: { `adapterCoverage`: `string`[]; `rawClientEscapeHatch`: `boolean`; `sdkPackage`: `string`; `sdkPackages`: `string`[]; `strategy`: `string`; `verifiedAt`: `string`; `verifiedVersion`: `string`; }; `integrationEntryPoints`: { `manifest`: `string`; `runtime`: `string`; }; `integrationName`: `string`; `integrationPackageName`: `string`; `rawClient`: { `coverage`: `string`; `export`: `string`; `option`: `string`; }; }
`metadata.channelCoverage`	{ `ephemeralSessionIssuance`: `string`; `outboundCalling`: `string`; `realtimeAudio`: `string`; `realtimeToolCalls`: `string`; `realtimeTranscript`: `string`; `telephony`: `string`; `transcriptionOnlySessions`: `string`; }
`metadata.channelCoverage.ephemeralSessionIssuance`	`string`
`metadata.channelCoverage.outboundCalling`	`string`
`metadata.channelCoverage.realtimeAudio`	`string`
`metadata.channelCoverage.realtimeToolCalls`	`string`
`metadata.channelCoverage.realtimeTranscript`	`string`
`metadata.channelCoverage.telephony`	`string`
`metadata.channelCoverage.transcriptionOnlySessions`	`string`
`metadata.implementation`	{ `adapterCoverage`: `string`[]; `rawClientEscapeHatch`: `boolean`; `sdkPackage`: `string`; `sdkPackages`: `string`[]; `strategy`: `string`; `verifiedAt`: `string`; `verifiedVersion`: `string`; }
`metadata.implementation.adapterCoverage`	`string`[]
`metadata.implementation.rawClientEscapeHatch`	`boolean`
`metadata.implementation.sdkPackage`	`string`
`metadata.implementation.sdkPackages`	`string`[]
`metadata.implementation.strategy`	`string`
`metadata.implementation.verifiedAt`	`string`
`metadata.implementation.verifiedVersion`	`string`
`metadata.integrationEntryPoints`	{ `manifest`: `string`; `runtime`: `string`; }
`metadata.integrationEntryPoints.manifest`	`string`
`metadata.integrationEntryPoints.runtime`	`string`
`metadata.integrationName`	`string`
`metadata.integrationPackageName`	`string`
`metadata.rawClient`	{ `coverage`: `string`; `export`: `string`; `option`: `string`; }
`metadata.rawClient.coverage`	`string`
`metadata.rawClient.export`	`string`
`metadata.rawClient.option`	`string`
`name`	`string`
`operations`	( \| { `alias`: `string`; `capability`: `string`; `exposesSensitiveData`: `true`; `externallyVisible?`: `never`; `providerObject`: `string`; `providerOperation`: `string`; `requiresCredential`: `true`; `sideEffect?`: `never`; } \| { `alias`: `string`; `capability`: `string`; `exposesSensitiveData?`: `never`; `externallyVisible`: `true`; `providerObject`: `string`; `providerOperation`: `string`; `requiresCredential`: `true`; `sideEffect`: `true`; })[]
`packageName`	`string`
`privacyNotes`	`string`[]
`provider`	`string`
`trustLevel`	`"official"`