--- id: Model3DAdapter title: Model3DAdapter --- Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:40](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L40) **`Experimental`** 3D model adapter interface with pre-resolved generics. A provider function makes the adapter: `provider('model')` → `adapter`. All type resolution happens at the provider call site, not in this interface. Generation is a job: `create3DModelJob` starts it, `get3DModelStatus` polls it, and `get3DModel` reads the finished model. Generic parameters: - TModel: The specific model name (e.g., 'fal-ai/hunyuan3d-v3/image-to-3d') - TProviderOptions: Provider-specific options (already resolved) - TModelProviderOptionsByName: Map from model name to its specific provider options - TModelInputModalitiesByName: Map from model name to the non-text prompt modalities it accepts (constrains the `prompt` part types at compile time) 3D model generation is experimental and may change. ## Type Parameters ### TModel `TModel` *extends* `string` = `string` ### TProviderOptions `TProviderOptions` *extends* `object` = `Record`\<`string`, `unknown`\> ### TModelProviderOptionsByName `TModelProviderOptionsByName` *extends* `Record`\<`string`, `any`\> = `Record`\<`string`, `any`\> ### TModelInputModalitiesByName `TModelInputModalitiesByName` *extends* [`ModelInputModalitiesByName`](../type-aliases/ModelInputModalitiesByName.md) = [`ModelInputModalitiesByName`](../type-aliases/ModelInputModalitiesByName.md) ## Properties ### ~types ```ts ~types: object; ``` Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:63](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L63) **`Internal`** Type-only properties for inference. Not assigned at runtime. #### modelInputModalitiesByName ```ts modelInputModalitiesByName: TModelInputModalitiesByName; ``` #### modelProviderOptionsByName ```ts modelProviderOptionsByName: TModelProviderOptionsByName; ``` #### providerOptions ```ts providerOptions: TProviderOptions; ``` *** ### cancel3DModelJob? ```ts optional cancel3DModelJob?: (jobId, options?) => Promise; ``` Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:100](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L100) **`Experimental`** Optional. Ask the provider to stop a job that is not finished. Implement it only when the provider has a real cancel API. #### Parameters ##### jobId `string` ##### options? ###### abortSignal? `AbortSignal` #### Returns `Promise`\<`void`\> *** ### create3DModelJob ```ts create3DModelJob: (options) => Promise; ``` Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:73](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L73) **`Experimental`** Create a new 3D model generation job. Returns a job ID to poll the status and to read the finished model. #### Parameters ##### options [`Model3DGenerationOptions`](Model3DGenerationOptions.md)\<`TProviderOptions`\> #### Returns `Promise`\<[`Model3DJobResult`](Model3DJobResult.md)\> *** ### get3DModel ```ts get3DModel: (jobId, options?) => Promise; ``` Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:91](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L91) **`Experimental`** Get the finished 3D model. Call it only after the status is 'completed'. Adapters should give `options.abortSignal` to the provider request when supported. #### Parameters ##### jobId `string` ##### options? ###### abortSignal? `AbortSignal` #### Returns `Promise`\<[`Model3DResult`](Model3DResult.md)\> *** ### get3DModelStatus ```ts get3DModelStatus: (jobId, options?) => Promise; ``` Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:81](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L81) **`Experimental`** Get the current status of a 3D model generation job. Adapters should give `options.abortSignal` to the provider request when supported. #### Parameters ##### jobId `string` ##### options? ###### abortSignal? `AbortSignal` #### Returns `Promise`\<[`Model3DStatusResult`](Model3DStatusResult.md)\> *** ### kind ```ts readonly kind: "3dModel"; ``` Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:48](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L48) **`Experimental`** Discriminator for adapter kind - used to determine API shape *** ### model ```ts readonly model: TModel; ``` Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:58](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L58) **`Experimental`** The model this adapter is configured for *** ### name ```ts readonly name: string; ``` Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:50](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L50) **`Experimental`** Adapter name identifier *** ### supportsFileSources? ```ts readonly optional supportsFileSources?: boolean; ``` Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:56](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L56) **`Experimental`** Declares that this adapter can consume `{ type: 'file' }` content sources (provider Files API references). The activity rejects file sources before the request for adapters that do not declare this.