Kaedim

https://docs.kaedim3d.com/
Admin
Kaedim is an AI-powered platform that generates production-ready 3D models from images using machine...
Tokens:32,704
Snippets:568
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Query Documentation with GET Request

Source: https://docs.kaedim3d.com/creating-assets/prototype-assets/upgrade-to-game-ready

Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' query parameter with a specific, self-contained question in natural language to get direct answers and relevant excerpts.

```http
GET https://docs.kaedim3d.com/creating-assets/prototype-assets/upgrade-to-game-ready.md?ask=<question>
```

--------------------------------

### Query Documentation with HTTP GET

Source: https://docs.kaedim3d.com/reviewing-assets/request-revisions/request-revisions-for-prototype-assets

Perform an HTTP GET request to query the documentation dynamically. Use the `ask` query parameter with a specific question. The response includes a direct answer and relevant excerpts.

```http
GET https://docs.kaedim3d.com/reviewing-assets/request-revisions/request-revisions-for-prototype-assets.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/creating-assets/create-page

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query documentation. Use this when information is not explicitly present or for clarification.

```HTTP
GET https://docs.kaedim3d.com/creating-assets/create-page.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/creating-assets/game-ready-assets/block-models

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query documentation. Use this when the answer is not explicitly present, for clarification, or to retrieve related documentation sections.

```http
GET https://docs.kaedim3d.com/creating-assets/game-ready-assets/block-models.md?ask=<question>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.kaedim3d.com/creating-assets/game-ready-assets/upload-base-model

To get information not explicitly present on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.kaedim3d.com/creating-assets/game-ready-assets/upload-base-model.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/removing-assets

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to dynamically query the documentation. Use this when information is not explicitly present or for clarification.

```http
GET https://docs.kaedim3d.com/removing-assets.md?ask=<question>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.kaedim3d.com/welcome/get-started/showcase

To get additional information not directly on the page, perform an HTTP GET request to the current page URL with the `ask` query parameter. The question should be specific and self-contained. Use this for clarifications or retrieving related documentation.

```http
GET https://docs.kaedim3d.com/welcome/get-started/showcase.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/enterprise-features/custom-integrations/apis

To get information not explicitly present on a page, perform an HTTP GET request to the page URL with an 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.kaedim3d.com/enterprise-features/custom-integrations/apis.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/creating-assets/assets-page/asset-management

To get additional information not directly present on a page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.kaedim3d.com/creating-assets/assets-page/asset-management.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/admin/settings/billing/invoices

Perform an HTTP GET request to the current page URL with the `ask` query parameter to dynamically query the documentation. Use this when information is not explicitly present, requires clarification, or to retrieve related documentation sections.

```http
GET https://docs.kaedim3d.com/admin/settings/billing/invoices.md?ask=<question>
```

--------------------------------

### Querying Documentation with GET Request

Source: https://docs.kaedim3d.com/enterprise-features/custom-integrations/apis/web-hooks

To get additional information not directly on the page, perform an HTTP GET request to the page URL with an 'ask' query parameter containing your question.

```http
GET https://docs.kaedim3d.com/enterprise-features/custom-integrations/apis/web-hooks.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/admin

Perform an HTTP GET request to query the documentation dynamically. Use the `ask` query parameter with a specific, self-contained question in natural language. The response will include a direct answer and relevant excerpts.

```http
GET https://docs.kaedim3d.com/admin.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.kaedim3d.com/admin/settings/change-subscription

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to get dynamic answers from the documentation. Use this when information is not explicit or requires clarification.

```HTTP
GET https://docs.kaedim3d.com/admin/settings/change-subscription.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/reviewing-assets/3d-viewer/model-views

To get additional information not present on the current page, perform an HTTP GET request to the page URL with the `ask` query parameter. The question should be specific and in natural language. Use this for clarifications or to retrieve related documentation.

```http
GET https://docs.kaedim3d.com/reviewing-assets/3d-viewer/model-views.md?ask=<question>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.kaedim3d.com/creating-assets/upload-a-3d-model

To get additional information not directly available on a page, perform an HTTP GET request to the current page URL with the `ask` query parameter. The question should be specific and in natural language.

```http
GET https://docs.kaedim3d.com/creating-assets/upload-a-3d-model.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/admin/settings/account-settings

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to dynamically query the documentation. Use this when the answer is not explicitly present, requires clarification, or you need related documentation sections.

```http
GET https://docs.kaedim3d.com/admin/settings/account-settings.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/reviewing-assets/3d-viewer/show-rig

To get additional information not present on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.kaedim3d.com/reviewing-assets/3d-viewer/show-rig.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/managing-assets/exporting-assets

Perform an HTTP GET request to query the documentation dynamically. Use this when the answer is not explicitly present on the current page, or when clarification or additional context is needed.

```http
GET https://docs.kaedim3d.com/managing-assets/exporting-assets.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/removing-assets/delete

To get information not present on the current page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language. Use this for clarifications or to retrieve related documentation.

```HTTP
GET https://docs.kaedim3d.com/removing-assets/delete.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/creating-assets/game-ready-assets/stages-of-a-game-ready-asset

Perform an HTTP GET request on a documentation URL with the 'ask' query parameter to retrieve specific information. The question should be natural language, self-contained, and specific.

```http
GET https://docs.kaedim3d.com/creating-assets/game-ready-assets/stages-of-a-game-ready-asset.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.kaedim3d.com/reviewing-assets/3d-viewer/select-meshes

Perform an HTTP GET request to query the documentation dynamically. The question should be specific and self-contained. Use this when the answer is not explicitly present or for clarification.

```http
GET https://docs.kaedim3d.com/reviewing-assets/3d-viewer/select-meshes.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/dev-logs

Use this method to dynamically query the documentation. Include a specific, natural language question in the 'ask' query parameter.

```http
GET https://docs.kaedim3d.com/dev-logs.md?ask=<question>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.kaedim3d.com/reviewing-assets/3d-viewer/show-uv-texture-maps

Use this method to retrieve information not explicitly present on the current page. The question should be specific and self-contained.

```http
GET https://docs.kaedim3d.com/reviewing-assets/3d-viewer/show-uv-texture-maps.md?ask=<question>
```

--------------------------------

### Example Webhook Request Payload

Source: https://docs.kaedim3d.com/enterprise-features/custom-integrations/apis/web-hooks

An example of the JSON payload structure that Kaedim sends to your configured webhook endpoint.

```APIDOC
## Example Webhook Request Payload

### Description
This is an example of the data structure you can expect to receive in a webhook request from Kaedim. It includes details about the asset, its status, type, and completion information.

### Method
POST (as described in the general webhook setup)

### Endpoint
Your configured webhook URL

### Parameters
This is a sample request body, not a list of parameters.

### Request Example
```json
{
  "results": {
    "status": "uploaded",
    "userID": "94d... ",
    "studioID": null,
    "requestID": "927... ",
    "iterationID": 2,
    "name": "",
    "image": "https://... ",
    "type": "generation",
    "isRevision": false,
    "createdAt": "2025-02-22T05:49:57.000Z",
    "completedAt": null,
    "assetComplete": false,
    "completedModels": {
      "fbx": "https://... ",
      "glb": "https://... ",
      "mtl": "https://... ",
      "obj": "https://... ",
      "usd": "https://... ",
      "gltf": "https://... "
    },
    "devID": "94d... "
  }
}
```

### Response
#### Success Response (200)
Your endpoint should return a success status code (e.g., 200 OK) to acknowledge receipt of the webhook. The content of the response is not specified.

#### Response Example
(No specific example provided in source, but a 200 OK status is implied for successful receipt.)
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.kaedim3d.com/creating-assets/input-guidelines/input-image-examples/characters

Use this method to ask questions about the documentation when information is not directly available. The question should be specific and self-contained. The response contains a direct answer and relevant excerpts.

```http
GET https://docs.kaedim3d.com/creating-assets/input-guidelines/input-image-examples/characters.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.kaedim3d.com/reviewing-assets/3d-viewer/geometry-details

Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' query parameter with a specific, self-contained question in natural language. The response will include a direct answer and relevant excerpts.

```http
GET https://docs.kaedim3d.com/reviewing-assets/3d-viewer/geometry-details.md?ask=<question>
```

--------------------------------

### Example Webhook Request Payload

Source: https://docs.kaedim3d.com/enterprise-features/custom-integrations/apis/web-hooks

This is an example of the JSON payload structure received by a Kaedim webhook endpoint. It includes details about the asset generation status, type, and completion.

```json
{
  "results": {
    "status": "uploaded",
    "userID": "94d... ",
    "studioID": null,
    "requestID": "927... ",
    "iterationID": 2,
    "name": "",
    "image": "https://... ",
    "type": "generation",
    "isRevision": false,
    "createdAt": "2025-02-22T05:49:57.000Z",
    "completedAt": null,
    "assetComplete": false,
    "completedModels": {
      "fbx": "https://... ",
      "glb": "https://... ",
      "mtl": "https://... ",
      "obj": "https://... ",
      "usd": "https://... ",
      "gltf": "https://... "
    },
    "devID": "94d... "
  }
}
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.kaedim3d.com/welcome/get-started/sign-in

Perform an HTTP GET request to query the documentation dynamically. Use the `ask` query parameter with a specific, self-contained question in natural language.

```http
GET https://docs.kaedim3d.com/welcome/get-started/sign-in.md?ask=<question>
```
Tokens:
Raw