# getText3d

#### getText3d

Returns the settings of a 3D Text object.

#### Signature

```typescript
getText3d(name: string): Promise<Text3DNodeSettings | null>
```

#### Parameters

| Name   | Type     | Required | Description                |
| ------ | -------- | -------- | -------------------------- |
| `name` | `string` | Yes      | Name of the 3D Text object |

#### Returns

`Promise<Text3DNodeSettings | null>` — Text settings, or `null` if object not found.

```typescript
type Text3DNodeSettings = {
  text: string;
  fontFamily: string;
  fontSize: number;
  weight: string;
  distanceX: number;
  distanceY: number;
  textAlign: 'LEFT' | 'CENTER' | 'RIGHT' | 'JUSTIFY';
  textHeight: 'DEFAULT' | 'CAMELCASE' | 'UPPERCASE' | 'LOWERCASE';
  curveSegments: number;
  amount: number;
  contourOffset: number;
};
```

#### Usage

```javascript
const settings = await api.getText3d("3D Text");
console.log(settings.text);      // "Example"
console.log(settings.fontSize);  // 50
console.log(settings.fontFamily); // "Open Sans"
```

#### Notes

* Returns `null` for non-existent objects
* Throws error for non-3D-Text objects


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.vectary.com/api/model-api/api-reference/gettext3d.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.