API Access

API Key

Get your api key here https://dashboard.ravenra.io/api-dashboard

Base URL

https://api.ravenra.io

Headers

  • Content-Type: application/json

  • Authorization: Include if your environment requires it (for example: x-api-key: <YOUR_API_KEY>)

Workflow Overview

  • Text-to-3D generation (Preview)

  • Poll task status to retrieve results

  • Optional refinement step for texturing/colorizing

  • Text-to-Image generation

  • 3D-from-Image generation (Preview)

Common Response Fields

Field
Type
Description

id

string

Internal identifier for the record.

taskId

string

The external task identifier to use when polling for results.

status

string

Processing status (e.g., IN_PROGRESS).

obj_url

string or null

URL to the generated OBJ file (when available).

created_at

string

ISO timestamp when the task was created.

updated_at

string

ISO timestamp when the task was last updated.

created_by

string

Creator identifier.

thumbnail_url

string or null

URL to a preview/thumbnail image (when available).

texture_url

string or null

URL to textures (when available).

mtl_url

string or null

URL to the MTL file (material library) for OBJ (when available).

progress

number

A numeric indicator of task progress.

image_source_url

string or null

If an image source was used, the resolved URL (when available).

type

string

Task type (e.g., text-to-3d).

prompt

string

The original prompt.

parent_task_id

string or null

Reference to a parent task (for refinement flows).

Notes:

  • Poll with the taskId.

  • Treat non-null asset URLs (obj_url, texture_url, thumbnail_url, mtl_url) as signals that output is ready.

  • progress increases during processing; use it to inform UI updates.

Endpoints

1) Create Task: Text to 3D (Preview)

  • URL: https://api.ravenra.io/task/create-task

  • Method: POST

  • Use case: Kick off a text-to-3D generation in preview mode.

Request payload:

Response:

Example request:

Example response:

2) Get Task Result (Poll)

  • URL: https://api.ravenra.io/task/result/:task-id

  • Method: GET

  • Use case: Poll to check task status and retrieve asset URLs.

Example:

Response (shape):

Tips:

  • Poll every 3–10 seconds.

  • Consider the task ready when the relevant URLs (e.g., obj_url, texture_url) are non-null.

3) Create Task: Texturized / Colorized (Refine)

  • URL: https://api.ravenra.io/task/create-task

  • Method: POST

  • Use case: Refine a preview 3D task to add textures or colorization.

Request payload:

Response:

Example request:

4) Text to Image

  • URL: https://api.ravenra.io/task/text-to-image

  • Method: POST

  • Use case: Generate an image from a text prompt.

Request payload:

Response:

Example request:

Note:

  • For image generation tasks, look for thumbnail_url or similar fields for the output image.

5) Create Task: 3D from Image (Preview)

  • URL: https://api.ravenra.io/task/create-task

  • Method: POST

  • Use case: Generate a 3D model using a text prompt plus an image reference.

Request payload:

  • image_source: Provide a string pointing to your image source. In most setups this is a publicly accessible image URL.

Response:

Example request:

Implementation Tips

  • Polling:

    • Start polling immediately after receiving taskId.

    • Back off your polling interval if needed (e.g., 3s → 5s → 10s).

    • Consider a timeout to fail gracefully in UI/clients.

  • Completion detection:

    • Consider the task complete when required asset URLs are present (e.g., obj_url and texture_url).

    • status will also update when processing finishes. The exact list of possible statuses may vary.

  • File handling:

    • obj_url points to the OBJ mesh.

    • mtl_url is the material library for OBJ.

    • texture_url may point to a texture bundle or a specific texture asset.

    • thumbnail_url is useful for quick previews in UI.

Minimal Client Examples

JavaScript (fetch):

Python (requests):

PreviousGenerative TechnologiesNextPlatform Plans

Last updated