> For the complete documentation index, see [llms.txt](https://docs.projectsim.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.projectsim.ai/readme.md).

# projectsim API

Create 3D assets for robotic perception and manipulation from images or text.

<div align="left"><figure><picture><source srcset="/files/VR7MYUTFaT33IIy689SZ" media="(prefers-color-scheme: dark)"><img src="https://70818391-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWnQtI3aVPkZHPVyrjjFG%2Fuploads%2Fgit-blob-8cef4559ce25dc83a9d51527561948ec3bf17ce6%2Fprojectsim-logo.svg?alt=media" alt="projectsim" width="240"></picture><figcaption></figcaption></figure></div>

## API documentation

Create **3D assets for robotic perception and manipulation** from images or text. Generate one object or related variations, configure their physics, and download the files for simulation.

<a href="https://dashboard.projectsim.ai/?utm_source=docs&#x26;utm_medium=hero&#x26;utm_content=readme" class="button primary">Get an API token</a> <a href="https://www.projectsim.ai/access?utm_source=docs&#x26;utm_medium=hero&#x26;utm_content=readme" class="button secondary">Request a custom dataset</a>

## Choose a generation route

| Route                                                            | Use it when                                                                                           | Don't use it when                                                                                                                                                                                                                |
| ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [High-fidelity](/creating-assets/high-fidelity-variation-set.md) | You need **detailed appearance** and **organic shapes**: strawberries, worn surfaces, dented parcels. | You need **moving joints**, such as a working hinge or sliding drawer.                                                                                                                                                           |
| [Procedural](/creating-assets/procedural-variation-set.md)       | You need **geometric variations** or **moving parts**: boxes, cabinets, desks with drawers.           | You need **realistic organic objects** or **fine surface detail**. Choose High-fidelity for strawberries.                                                                                                                        |
| [Standard](/creating-assets/assets-standard.md)                  | You need **one object** from an **image or text**.                                                    | You need **measured scale**, a related **variation set**, **articulation**, or **evenly spaced repeated details or patterns**. [Procedural](/creating-assets/procedural-variation-set.md) is better suited to repeated geometry. |
| [Measured](/creating-assets/assets-measured.md)                  | You need one object at **measured scale** and have an **image plus a ChArUco capture video**.         | You only have an **image or text**, or need **articulation**.                                                                                                                                                                    |

[Compare routes and limitations →](/creating-assets/choosing-an-endpoint.md)

New to the API? [Start with the quickstart →](/getting-started/quickstart.md) · [API reference →](/api-reference/api-reference.md)

## Get started

{% hint style="info" %}
**Sign-up is self-serve.** Create an account at [dashboard.projectsim.ai](https://dashboard.projectsim.ai/?utm_source=docs\&utm_medium=hint\&utm_content=readme), add a payment method on the **Billing** page to start the free trial (your first 40 credits are free), then create your token on the **API token** page. See [Create an account](/getting-started/create-an-account.md) for details. Have a promo code from a hackathon? [Redeem it](/getting-started/redeem-a-promo-code.md) instead of adding a card.

Need a custom dataset built for you — thousands of assets, or millions? [**Request a dataset →**](https://www.projectsim.ai/access?utm_source=docs\&utm_medium=hint\&utm_content=readme)
{% endhint %}

Go from an API token to your first download. Examples come in cURL and Python.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>1. Get an API token</strong></td><td>Sign up on the dashboard and create a token — self-serve, with free trial credits.</td><td><a href="/getting-started/authentication.md">Authentication</a></td></tr><tr><td><strong>2. Create your first asset</strong></td><td>Follow a complete Python example: submit an image, poll the job, and download the result.</td><td><a href="/getting-started/quickstart.md">Quickstart</a></td></tr><tr><td><strong>3. Build your workflow</strong></td><td>Track background jobs, retry requests safely, and retrieve fresh download links.</td><td><a href="/guides/jobs-and-assets.md">Jobs &amp; assets</a></td></tr></tbody></table>

For independent objects from separate inputs, use [asset batches](/creating-assets/batches.md). For concrete scenarios, [explore the example use cases](/creating-assets/choosing-an-endpoint/worked-use-cases.md).

### Configure for your simulator

Standard, Measured, and High-fidelity support Isaac Sim, MuJoCo, SAPIEN, Genesis, or portable outputs. Procedural currently exports **rigid-body USD**; changing its simulator setting does not select another format.

[Explore physics and output settings →](/creating-assets/parameters.md)

## Explore projectsim

{% columns %}
{% column %}

<figure><picture><source srcset="/files/VR7MYUTFaT33IIy689SZ" media="(prefers-color-scheme: dark)"><img src="https://70818391-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWnQtI3aVPkZHPVyrjjFG%2Fuploads%2Fgit-blob-8cef4559ce25dc83a9d51527561948ec3bf17ce6%2Fprojectsim-logo.svg?alt=media" alt="Website" width="180"></picture><figcaption><p><a href="https://www.projectsim.ai/?utm_source=docs&#x26;utm_medium=explore&#x26;utm_content=readme">Website</a></p></figcaption></figure>
{% endcolumn %}

{% column %}

<figure><img src="https://70818391-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWnQtI3aVPkZHPVyrjjFG%2Fuploads%2Fgit-blob-ab959d165fa5b05a953c9d1c5acc6640f9f536b8%2Fhugging-face-logo.svg?alt=media" alt="Hugging Face" width="48"><figcaption><p><a href="https://huggingface.co/projectsim">Hugging Face</a></p></figcaption></figure>
{% endcolumn %}

{% column %}

<figure><picture><source srcset="/files/tSTeBVvAVPPESHKXU3do" media="(prefers-color-scheme: dark)"><img src="https://70818391-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWnQtI3aVPkZHPVyrjjFG%2Fuploads%2Fgit-blob-39349fea62a87266ac43b5a7769d5543b6cf915a%2Fgithub-logo.svg?alt=media" alt="GitHub" width="140"></picture><figcaption><p><a href="https://github.com/Kaedim/projectsim">GitHub</a></p></figcaption></figure>
{% endcolumn %}
{% endcolumns %}
