> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ttapi.io/llms.txt
> Use this file to discover all available pages before exploring further.

# NovelAI 图生图 API 文档

> 使用 NovelAI 图生图 API 基于参考图片进行风格转换、重绘和细节增强，适合动漫风格图像创作。



## OpenAPI

````yaml openapi/cn/novel.json POST /novelai/image-to-image
openapi: 3.1.0
info:
  title: Novel API DOCS
  version: 1.0.0
  description: TTAPI Novel AI API 接口服务
servers:
  - url: https://api.ttapi.io
security: []
paths:
  /novelai/image-to-image:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageRequest'
      responses:
        '200':
          $ref: '#/components/responses/SuccessResponse'
        '400':
          $ref: '#/components/responses/400Response'
        '401':
          $ref: '#/components/responses/401Response'
      security:
        - CustomApiKey: []
components:
  schemas:
    ImageRequest:
      type: object
      properties:
        prompt:
          type: string
          description: 生成图像或修改图像描述词
        model:
          type: string
          description: 使用模型
          enum:
            - nai-diffusion-4-5-full
            - nai-diffusion-4-5-curated
        image:
          type: string
          example: https://xxx.png
          description: 垫图地址 <br/> 图片url地址或者base64编码
        'n':
          type: integer
          default: '1'
          example:
            - '1'
            - '2'
            - '3'
            - '4'
          description: 生成图片数量  1 - 4
        width:
          type: integer
          default: '1024'
          description: 图像宽度
        height:
          type: integer
          default: '1024'
          description: 图像高度
        seed:
          type: string
          description: 种子
        steps:
          type: integer
          description: 步骤数
          default: '23'
        scale:
          type: number
          description: 人工智能对提示的响应程度较低的指导值可以产生更具绘画感和柔和的效果，而较高的指导值可以提供更精细的细节和更清晰的效果
          default: '5'
        negative_prompt:
          type: string
          description: 不想要的内容
        quality_toggle:
          type: boolean
          description: 质量开关
          default: 'true'
        sampler:
          type: string
          description: 采样器
          default: Euler Ancestral
          enum:
            - Euler Ancestral
            - Euler
            - DPM++ 2S Ancestral
            - DPM++ 2M SDE
            - DPM++ 2M
            - DPM++ SDE
        noise_schedule:
          type: string
          description: 噪声曲线
          default: karras
          enum:
            - karras
            - exponential
            - polyexponential
        noise:
          type: number
          description: 图片噪声  0.99 ≥ noise ≥ 0
          default: 0
        strength:
          type: number
          description: 强度  0.99 ≥ noise ≥ 0.01
          default: 0.7
        character_prompts:
          type: array
          description: 角色列表
          items:
            type: object
            properties:
              prompt:
                type: string
                description: 角色信息
              uc:
                type: string
                description: 角色不想要的内容
                example: 模糊画质，多余饰品
              center:
                type: object
                description: 角色在画面中的中心坐标
                properties:
                  x:
                    type: number
                    description: X轴坐标（0-1之间）
                    default: 0.5
                  'y':
                    type: number
                    description: Y轴坐标（0-1之间）
                    default: 0.5
                required:
                  - x
                  - 'y'
            required:
              - prompt
              - center
        vibe_transfer:
          type: array
          description: 氛围转移参考
          items:
            type: object
            properties:
              image:
                type: string
                description: 图像，url或base64
                example: https://example.com/ref1.jpg
              strength:
                type: number
                description: 参考强度 ≥ 0 <= 1
                default: 0.6
            required:
              - image
        character_reference:
          type: array
          description: 精确参考
          items:
            type: object
            properties:
              image:
                type: string
                description: 图像，url或base64
                example: https://example.com/ref2.jpg
              type:
                type: string
                description: 参考类型
                enum:
                  - character&style
                  - character
                  - style
                default: character&style
              strength:
                type: number
                description: >-
                  参考强度 ≥ 0 <= 1, <br/> AI
                  会越来越依赖于参考图像中的风格特征、配色方案和其他视觉特征。此设置值越低，AI
                  的创作自由度就越大。相反，值越高，参考图像对输出的影响就越大，这可能导致面部表情、角度和人物姿势与参考图像过于相似
                default: 1
              fidelity:
                type: number
                description: 保真度 ≥ 0 <= 1
                default: 0
            required:
              - image
        hook_url:
          type: string
          description: >-
            回调地址，任务完成或失败将通过请地址进行通知，通知数据结构与<a href="fetch"
            target="_self">fetch结构</a>一致。如果未设置，则需要请求<a href="fetch"
            target="_self">fetch接口</a>进行查询
      required:
        - prompt
        - model
        - image
  responses:
    SuccessResponse:
      description: 请求成功
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: SUCCESS
              message:
                type: string
                example: success
              data:
                type: object
                example:
                  jobId: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
            required:
              - status
              - message
              - data
    400Response:
      description: 参数错误
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: FAILED
              message:
                type: string
                example: '"prompt" cannot be empty.'
              data:
                type: object
            required:
              - status
              - message
    401Response:
      description: 授权失败
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: FAILED
              message:
                type: string
                example: Wrong TT-API-KEY or email is not activated.
            required:
              - status
              - message
  securitySchemes:
    CustomApiKey:
      type: apiKey
      in: header
      name: TT-API-KEY
      description: >-
        请前往 <a href='https://dashboard.ttapi.io' target='_blank'>TTAPI 控制台</a>
        获取 API 密钥。

````