> For the complete documentation index, see [llms.txt](https://help.vectary.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.vectary.com/api/model-api/api-reference/getobjects.md).

# getObjects

#### getObjects

Returns objects from the scene by name or ID, or all objects if no parameter is specified.

#### **Signature**

```typescript
getObjects(objectNamesOrIds?: string | string[]): Promise<Object[]>
```

#### **Parameters**

<table><thead><tr><th width="188.05859375">Parameter</th><th width="167.140625">Type</th><th width="114.07421875">Required</th><th>Description</th></tr></thead><tbody><tr><td>objectNamesOrIds</td><td>string | string[]</td><td>No</td><td>Object name/ID or array of names/IDs. If omitted, returns all objects.</td></tr></tbody></table>

#### **Returns**

`Promise<Object[]>` - Array of matching objects.

See [Object](/api/model-api/api-reference.md#object) in Common Types.

#### **Usage**

```javascript
// Get all objects
const allObjects = await api.getObjects();

// Get single object by name
const sphere = await api.getObjects("Sphere");

// Get multiple objects by names
const objects = await api.getObjects(["Sphere", "Box"]);
```

#### **Notes**

* Wildcard `"*"` does NOT work — returns empty array
* Both string and array parameters are accepted
* Returns empty array if no objects match


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.