Developer platform

Build text-to-3D workflows on a clear, typed API

Create textured 3D assets from text prompts, poll asynchronous jobs, and download completed GLB files. The public discovery surface is open; generation operations remain protected by subscriber-owned API keys.

Create or manage a key View OpenAPI 3.1

Version: v1
Authentication: Bearer key
Output: GLB
Access: Pro or Max

Quickstart

Make a safe first request

1
Enable API access
Use an active Pro or Max subscription, then open API access while signed in.
2
Create one secret key
Copy it once and store it only in a trusted server-side environment variable.
3
Submit and poll
Create one job, retain its ID, and respect Retry-After while it is processing.

Create a generation

curl

export GOBLIN3D_API_KEY="paste_your_key_here"

curl -X POST "https://goblin3d.ai/api/v1/generations" \
  -H "Authorization: Bearer $GOBLIN3D_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: generation_demo_001" \
  -d '{
    "prompt": "A stylized forest guardian with moss armor",
    "quality": "standard"
  }'

API keys are secrets. Never place a key in browser JavaScript, a mobile bundle, a public repository, a prompt transcript, or application logs.

REST reference

Small surface, predictable lifecycle

The capabilities endpoint is public so tools can understand the API before asking for credentials. Every generation route verifies the Bearer key, subscription entitlement, rate limit, and asset ownership.

Method	Path	Auth	Purpose
GET	/api/v1/capabilities	Public	Discover version, authentication, output, and agent guidance.
POST	/api/v1/generations	Bearer	Start one asynchronous text-to-3D generation.
GET	/api/v1/generations	Bearer	List generation jobs owned by the authenticated subscriber.
GET	/api/v1/generations/{id}	Bearer	Poll a job until it succeeds or fails.
GET	/api/v1/generations/{id}/download	Bearer	Receive a short-lived redirect for a completed GLB.

Errors and limits

Handle every failure as typed JSON

Error responses include type, code, message, parameter, resolution, documentation URL, and request ID. Preserve the request ID for support. On HTTP 429, wait for Retry-After instead of retrying immediately.

{
  "error": {
    "type": "authentication_error",
    "code": "INVALID_API_KEY",
    "message": "Provide a valid Goblin3D API key as a Bearer token.",
    "param": null,
    "resolution": "Create an API key, then send it as a Bearer token.",
    "documentation_url": "https://goblin3d.ai/en/developers#errors",
    "request_id": "8c8f7e7d-..."
  }
}

Agent guidance

Use generation only with clear intent

Use the API when a user explicitly wants a textured 3D asset from a text prompt and can review the result.
Confirm before starting a job because an accepted generation can consume credits. Do not create multiple speculative variations by default.
Do not promise deterministic visuals, production-ready topology, rigging, or a synchronous response. Human review remains required.

Compatibility

Versioning and deprecation

The stable major version is part of every API path: /api/v1. Additive fields and endpoints may be introduced within v1, so clients should ignore unknown response fields. Breaking request or response changes require a new major path.

No v1 operation is currently deprecated. A future deprecation will be marked with deprecated: true in OpenAPI and an RFC 9745 Deprecation response header. This page will publish a migration guide and timeline, and an RFC 8594 Sunset header will announce removal at least 90 days in advance. Clients should migrate before that published sunset date.

Ready to automate one generation?

Compare subscriber plans, create a server-side key, then use the OpenAPI schema as the source of truth for requests and responses.

Compare plans Open API access