# API 访问

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /optimize:
    post:
      summary: API 访问
      deprecated: false
      description: >+
        需要 API 密钥。您可以使用它们以编程方式访问 API。


        不要与他人共享您的 API 密钥，或将其暴露在浏览器或其他客户端代码中。 为了保护您帐户的安全，我们也可能会自动轮换我们已经拥有的任何 API
        密钥 成立 已公开泄露。


        有了秘钥，您就可以以编程方式调用我们的 API。具体来说，我们提供了两个端点：用于单个提示词优化的 `/optimize`；和
        `/optimizeBatch` 用于更快的批量优化，一次最多可以优化 16
        个提示词。当您有很多优化提示词时，它会快得多。有关详细信息，请参阅下面的 API 文档。


        此外，我们还提供提示词即服务和大模型即数据库的端点。您可以在您的每个[服务*launch*](https://promptperfect.jina.ai/services)
        和[数据库*launch*](https://promptperfect.jina.ai/databases) 对应的设置中查看详细信息。

      tags: []
      parameters:
        - name: x-api-key
          in: header
          description: ''
          required: true
          example: token $YOUR_GENERATED_SECRET
          schema:
            type: string
        - name: content-type
          in: header
          description: ''
          required: true
          example: application/json
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    prompt:
                      type: string
                      description: 原有提示词待优化。它可以是单行或多行提示词。
                    targetModel:
                      type: string
                      description: >-
                        此提示词将用于的目标模型。 允许值:  chatgpt gpt-4-turbo claude-2 gpt-4
                        claude ernie-bot-4 chatglm-turbo llama-2-70b-chat
                        mistral-7b-instruct llama-2-13b-chat llama-2-7b-chat
                        ernie-bot-turbo cogenerate stablelm-tuned-alpha-7b
                        jinachat text-davinci-003 dalle-3 sdxl midjourney sd
                        kandinsky dreamshaper absolutereality anything
                        deliberate sdxl-emoji dalle
                    imagePrompt:
                      type: string
                      description: >-
                        从上传的图像中导出原始文本提示词。当给出此参数时，“prompt”参数将被忽略，并将被派生的提示词覆盖。您可以使用
                        base64 编码的 PNG（推荐）或图像 URL
                  required:
                    - prompt
                    - targetModel
                    - imagePrompt
                  x-apifox-orders:
                    - prompt
                    - targetModel
                    - imagePrompt
                  description: >-
                    请求正文。对于“optimize”端点，这应该是以下选项。对于“optimizeBatch”端点，这应该是以下选项的数组。
              required:
                - data
              x-apifox-orders:
                - data
            example:
              data:
                prompt: my prompt
                targetModel: chatgpt
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apifox-name: 成功
      security: []
      x-apifox-folder: ''
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/3751205/apis/api-133114100-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: http://dev-cn.your-api-server.com
    description: 开发环境
  - url: http://test-cn.your-api-server.com
    description: 测试环境
  - url: https://api.promptperfect.jina.ai
    description: 正式环境
security: []

```