Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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: Createprints Ai Account API
version: 1.1.0
contact:
name: Create Prints support
url: https://www.createprints.ai/contact
license:
name: Proprietary
url: https://www.createprints.ai/terms
description: 'Operations tagged Account across 2 of this provider''s published API definitions: createprints-ai-openapi.json, createprints-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.createprints.ai
description: Create Prints API origin
tags:
- name: Account
description: Read account resources used by the artwork workflow.
paths:
/api/credits-balance:
get:
operationId: getCreditsBalance
summary: Get the artwork-generation credit balance
description: Returns the remaining generation-job count. This endpoint currently accepts a Create Prints MCP OAuth access token with `orders:read` or a signed-in user-session token. It does not accept an account API key.
tags:
- Account
security:
- userSessionBearer: []
- oauth2:
- orders:read
responses:
'200':
description: Current remaining generation credits.
content:
application/json:
schema:
$ref: '#/components/schemas/CreditsBalance'
example:
generation_jobs_count: 4
creditsRemaining: 4
'401':
description: The credential is missing, invalid, revoked, or expired.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: The credential lacks the required scope or cannot perform this operation.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Create Prints could not complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.createprints.ai
description: Create Prints API origin
components:
schemas:
CreditsBalance:
type: object
required:
- generation_jobs_count
- creditsRemaining
properties:
generation_jobs_count:
type:
- integer
- 'null'
minimum: 0
creditsRemaining:
type:
- integer
- 'null'
minimum: 0
Error:
type: object
description: Errors use `error`; some endpoints also return a stable `code`, validation `details`, or `retryable` hint.
properties:
error:
type: string
code:
type: string
details:
type: array
items:
type: string
retryable:
type: boolean
additionalProperties: true
securitySchemes:
agentApiKey:
type: apiKey
in: header
name: X-API-Key
description: Create Prints account API key beginning with `cp_`. Required scopes vary by operation.
agentBearer:
type: http
scheme: bearer
description: Account API key (`cp_…`) or MCP OAuth token (`cp_mcp_access_…`) in Authorization.
userSessionBearer:
type: http
scheme: bearer
bearerFormat: JWT
description: Signed-in Create Prints user-session token; supported only where this scheme is listed.
oauth2:
type: oauth2
description: Create Prints OAuth 2.0 authorization-code flow with PKCE for MCP and agent clients.
flows:
authorizationCode:
authorizationUrl: https://api.createprints.ai/api/oauth/authorize
tokenUrl: https://api.createprints.ai/api/oauth/token
scopes:
artwork:create: Create, import, and retry artwork jobs.
artwork:read: Read and list artwork jobs.
print_options:read: Read print variants, frames, prices, and postage estimates.
checkout:create: Create checkout sessions and retry production submission.
checkout:read: Read checkout, fulfilment, and shipment status.
orders:read: Read orders and, on the current credit endpoint, generation credits.
externalDocs:
description: Create Prints developer resources
url: https://www.createprints.ai/developers
x-refined-from:
- createprints-ai-openapi.json
- createprints-ai-openapi.yml