OpenPost Image generation API
The Image generation API from OpenPost — 3 operation(s) for image generation.
The Image generation API from OpenPost — 3 operation(s) for image generation.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/openpo-st:openpo-st-image-generation-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
contact:
email: hello@openpo.st
name: OpenPost support
url: https://openpo.st/contact
description: OpenPost HTTP API for workspace-scoped social publishing. Use it to inspect accounts and provider readiness, manage media and publications, schedule work, and read publishing results. Every operation still follows token scopes, workspace roles, plan limits, provider capabilities, and destination validation.
license:
identifier: AGPL-3.0-only
name: AGPL-3.0-only
termsOfService: https://openpo.st/terms
title: OpenPost Image generation API
version: 1.0.0
servers:
- description: OpenPost Hosted service
url: https://app.openpo.st/api/v1
- description: The OpenPost instance serving this contract
url: /api/v1
security:
- bearerAuth: []
- sessionCookie: []
tags:
- name: Image generation
paths:
/image-generations:
get:
operationId: list-image-generations
parameters:
- explode: false
in: query
name: workspace_id
required: true
schema:
maxLength: 200
type: string
- explode: false
in: query
name: project_id
required: true
schema:
maxLength: 200
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListImageGenerationsOutputBody'
description: OK
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'403':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Forbidden
'404':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Not Found
'409':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Conflict
'422':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Unprocessable Entity
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Internal Server Error
'503':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Service Unavailable
summary: Read the current user's image generation history
tags:
- Image generation
post:
operationId: create-image-generation
parameters:
- in: header
name: Idempotency-Key
required: true
schema:
maxLength: 160
minLength: 8
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ImageGenerationRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ImageGenerationRun'
description: OK
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'403':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Forbidden
'404':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Not Found
'409':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Conflict
'422':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Unprocessable Entity
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Internal Server Error
'503':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Service Unavailable
summary: Generate, edit or fill an image for review
tags:
- Image generation
/image-generations/config:
get:
operationId: image-generation-config
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ImageGenerationConfigOutputBody'
description: OK
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'403':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Forbidden
'404':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Not Found
'409':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Conflict
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Internal Server Error
'503':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Service Unavailable
summary: Read signed-in image generation capabilities
tags:
- Image generation
/image-generations/{id}:
get:
operationId: get-image-generation
parameters:
- in: path
name: id
required: true
schema:
maxLength: 200
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ImageGenerationRun'
description: OK
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'403':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Forbidden
'404':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Not Found
'409':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Conflict
'422':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Unprocessable Entity
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Internal Server Error
'503':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Service Unavailable
summary: Read a saved image generation request
tags:
- Image generation
components:
schemas:
ImageGenerationRun:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/ImageGenerationRun.json
format: uri
readOnly: true
type: string
billing_state:
type: string
cost_microusd:
format: int64
type:
- integer
- 'null'
created_at:
format: date-time
type: string
error_message:
type: string
id:
type: string
model:
type: string
operation:
type: string
page_id:
type: string
project_id:
type: string
prompt:
type: string
result_media_id:
type: string
source_media_id:
type: string
state:
type: string
target_fingerprint:
type: string
target_layer_id:
type: string
workspace_id:
type: string
required:
- source_media_id
- id
- workspace_id
- project_id
- page_id
- operation
- prompt
- model
- state
- error_message
- result_media_id
- target_layer_id
- target_fingerprint
- cost_microusd
- billing_state
- created_at
type: object
ImageGenerationConfigOutputBody:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/ImageGenerationConfigOutputBody.json
format: uri
readOnly: true
type: string
available:
type: boolean
default_model:
type: string
models:
items:
$ref: '#/components/schemas/ImageModel'
type:
- array
- 'null'
required:
- available
- default_model
- models
type: object
ImageModel:
additionalProperties: false
properties:
id:
type: string
name:
type: string
required:
- id
- name
type: object
ErrorModel:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/ErrorModel.json
format: uri
readOnly: true
type: string
detail:
description: A human-readable explanation specific to this occurrence of the problem.
examples:
- Property foo is required but is missing.
type: string
errors:
description: Optional list of individual error details
items:
$ref: '#/components/schemas/ErrorDetail'
type:
- array
- 'null'
instance:
description: A URI reference that identifies the specific occurrence of the problem.
examples:
- https://example.com/error-log/abc123
format: uri
type: string
status:
description: HTTP status code
examples:
- 400
format: int64
type: integer
title:
description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
examples:
- Bad Request
type: string
type:
default: about:blank
description: A URI reference to human-readable documentation for the error.
examples:
- https://example.com/errors/example
format: uri
type: string
type: object
ImageGenerationRequest:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/ImageGenerationRequest.json
format: uri
readOnly: true
type: string
background:
enum:
- auto
- opaque
- transparent
type: string
mask_png:
description: Base64 PNG; transparent pixels are selected. Fill only.
maxLength: 5592408
type: string
model:
enum:
- gpt-image-2.5-flare
- gpt-image-2.5-sunburst
type: string
operation:
enum:
- generate
- edit
- fill
type: string
page_id:
maxLength: 200
minLength: 1
type: string
project_id:
maxLength: 200
minLength: 1
type: string
prompt:
maxLength: 8000
minLength: 1
type: string
quality:
enum:
- low
- medium
- high
- xhigh
- max
- auto
type: string
size:
enum:
- square_hd
- portrait_4_3
- portrait_16_9
- landscape_4_3
- landscape_16_9
- auto
type: string
source_media_id:
maxLength: 200
type: string
target_fingerprint:
description: Browser snapshot fingerprint used to prevent stale application
maxLength: 100
type: string
target_layer_id:
maxLength: 200
type: string
workspace_id:
maxLength: 200
minLength: 1
type: string
required:
- workspace_id
- project_id
- page_id
- operation
- prompt
- model
- quality
- size
- background
type: object
ListImageGenerationsOutputBody:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/ListImageGenerationsOutputBody.json
format: uri
readOnly: true
type: string
runs:
items:
$ref: '#/components/schemas/ImageGenerationRun'
type:
- array
- 'null'
required:
- runs
type: object
ErrorDetail:
additionalProperties: false
properties:
location:
description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
type: string
message:
description: Error message text
type: string
value:
description: The value at the given location
type: object
securitySchemes:
bearerAuth:
bearerFormat: OpenPost API token or session JWT
scheme: bearer
type: http
sessionCookie:
in: cookie
name: openpost_session
type: apiKey