Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: AI3D Studio Workflows API
version: 1.0.0
description: Public, API-key-authenticated endpoints for AI generation. Authenticate with your `sk-` key as a Bearer token (or `x-api-key`). Generation bills credits to the key’s account.
servers:
- url: https://ai3d.studio/v1
security:
- bearerAuth: []
- apiKeyHeader: []
tags:
- name: Workflows
paths:
/workflows/{id}:
get:
operationId: getWorkflow
x-required-scope: read
summary: Poll a generation workflow
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Workflow status + result
content:
application/json:
schema:
type: object
additionalProperties: true
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Unknown workflow
security:
- bearerAuth: []
- apiKeyHeader: []
- oauth2:
- read
tags:
- Workflows
components:
schemas:
Error:
type: object
properties:
code:
type: integer
example: -1
message:
type: string
required:
- code
- message
responses:
Unauthorized:
description: Missing, malformed, or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Your `sk-` API key (`sk-[A-Za-z0-9]{38}`, checksummed) presented as a Bearer token. API access is a plan right (see pricing); a plan that does not include it answers 403 `plan_required`.
apiKeyHeader:
type: apiKey
in: header
name: x-api-key
description: Your `sk-` API key in the `x-api-key` header.
oauth2:
type: oauth2
description: 'OAuth 2.1 for an agent acting for a signed-in account: the authorization code flow with PKCE (S256), or client credentials for a client registered from the dashboard. Send the RFC 8707 `resource` parameter `https://ai3d.studio/v1` on the authorization and token requests: a token minted for another resource, the MCP server included, is refused here. Authorization server metadata: `https://ai3d.studio/.well-known/oauth-authorization-server`.'
flows:
authorizationCode:
authorizationUrl: https://ai3d.studio/api/auth/oauth2/authorize
tokenUrl: https://ai3d.studio/api/auth/oauth2/token
refreshUrl: https://ai3d.studio/api/auth/oauth2/token
scopes:
read: Read the account, models, quotes, runs, batches and the Library.
generate: Start runs that spend credits, and file new creations in the Library.
clientCredentials:
tokenUrl: https://ai3d.studio/api/auth/oauth2/token
scopes:
read: Read the account, models, quotes, runs, batches and the Library.
generate: Start runs that spend credits, and file new creations in the Library.