Langdock Images API

openapi: 3.2.0
info:
  title: Langdock Images API
  version: 3.0.0
servers:
- url: https://api.langdock.com
  description: Production
security:
- bearerAuth: []
tags:
- name: Images
paths:
  /openai/{region}/v1/images/generations:
    post:
      tags:
      - Images
      summary: Generates one standard image as base64
      description: Generates one standard-resolution image with a Completion API key. Returns b64_json only. Does not support n other than 1, URL output, HD, or image edits.
      operationId: createImage
      parameters:
      - name: region
        in: path
        required: true
        description: The region of the API to use. Must be eu or us.
        schema:
          type: string
          enum:
          - eu
          - us
          default: eu
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
              - model
              - prompt
              properties:
                model:
                  type: string
                  minLength: 1
                  description: Image generation model ID from your workspace. GET /openai/{region}/v1/models lists chat models, not image models.
                prompt:
                  type: string
                  minLength: 1
                  description: The image description.
                n:
                  type: integer
                  enum:
                  - 1
                  description: Number of images. Only 1 is supported.
                size:
                  type: string
                  enum:
                  - auto
                  - 1024x1024
                  - 1536x1024
                  - 1024x1536
                  default: auto
                  description: Output size. auto and 1024x1024 map to square, 1536x1024 to landscape, and 1024x1536 to portrait.
                quality:
                  type: string
                  enum:
                  - auto
                  - low
                  - medium
                  - high
                  description: Quality hint forwarded to the image model. Not every image model uses it.
                response_format:
                  type: string
                  enum:
                  - b64_json
                  description: Response format. Only b64_json is supported.
                user:
                  type: string
                  description: Optional end-user identifier. Accepted for OpenAI compatibility.
            example:
              model: your-image-model-id
              prompt: A lighthouse at dusk
              n: 1
              size: 1024x1024
              response_format: b64_json
      responses:
        '200':
          description: OK
          headers:
            ld-model-id:
              description: The image model ID used for the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                required:
                - created
                - data
                properties:
                  created:
                    type: integer
                    description: Unix timestamp in seconds.
                  data:
                    type: array
                    minItems: 1
                    maxItems: 1
                    items:
                      type: object
                      required:
                      - b64_json
                      properties:
                        b64_json:
                          type: string
                          description: Base64-encoded image.
                        revised_prompt:
                          type: string
                          description: Revised prompt when the model returns one.
              example:
                created: 1721722200
                data:
                - b64_json: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==
                  revised_prompt: A coastal lighthouse at dusk, warm lantern light.
        '400':
          description: Invalid fields, an unavailable image model, or no image models in the region.
        '401':
          description: Missing, invalid, or expired API key.
        '403':
          description: API key without the Completion API scope.
        '429':
          description: Usage or rate limit exceeded.
        '504':
          description: The model did not respond in time. Please retry.
        '500':
          description: Internal server or upstream provider error.
      security:
      - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: API key as Bearer token. Format "Bearer YOUR_API_KEY"
x-provenance:
  method: harvested
  publisher: Langdock
  source: https://docs.langdock.com/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)