如何获取Upstage API密钥(分步指南)

在现代数据处理和文档管理领域，Upstage API 提供了一整套功能强大的工具，涵盖了文本解析、文档问答和OCR（光学字符识别）等多种能力。通过使用 Upstage API，开发者可以快速集成高效的文本处理和智能交互，轻松实现对文档内容的精确解析、问答和文字识别。这些功能让信息处理变得更为便捷和智能，为用户提供了丰富的知识支持和内容管理服务。本文将指导你如何获取 Upstage API 密钥，并在初始集成后进行功能测试，同时探讨使用过程中需关注的关键事项，帮助开发者更好地利用其强大功能。

1. 获取Upstage API秘钥步骤

获取Upstage API密钥的过程相对简单，只需几个步骤即可完成：

1.访问官方网站注册/登录：https://console.upstage.ai/login

2.进入仪表盘：进入仪表盘页面，对密钥进行操作。

3.创建API密钥：点击“仪表盘” >在左侧导航栏中选择 “API密钥”>创建新密钥

4.查看API密钥：新建完以后会提示创建成功，在这里会看到新建的密钥。

2. Upstage API秘钥可用性测试

在获取API密钥后，进行可用性测试是确保其正常工作的重要步骤。以下是使用CURL进行测试的一个案例：

输入：

curl --location 'https://api.upstage.ai/v1/solar/chat/completions' \

--header 'Authorization: Bearer up_5NbV1mb4JG06PEQPFPHDL47ZOTcaM' \

--header 'Content-Type: application/json' \

--data '{

  "model": "solar-pro",

  "messages": [

    {

      "role": "user",

      "content": "Hi, how are you?"

    }

  ],

  "stream": true

}'

输出：

你将得到一个JSON格式的响应，其中包含了详细信息，如当前对话的模型输出内容、模型名称、用户输入的token数量、模型输出的token数量等。

示例输出：

{

"id": "e1a90437-df41-45cd-acc6-a7bacbdd2a86",

"object": "chat.completion",

"created": 1707269210,

"model": "solar-pro-preview-240910",

"choices": [

  {

    "index": 0,

    "message": {

      "role": "assistant",

      "content": "Hello and welcome! How can I assist you today?"

    },

    "logprobs": null,

    "finish_reason": "stop"

  }

],

"usage": {

  "prompt_tokens": 23,

  "completion_tokens": 12,

  "total_tokens": 35

},

"system_fingerprint": null

}

3. 使用Upstage API搭建应用的其他关键考虑因素

在使用Upstage API搭建应用时，除了获取和测试API密钥外，还需考虑以下因素：

错误处理

代码	原因	可能的解决方法
400	请求体格式或数据错误	对于Solar API： • 检查请求体的JSON语法是否正确 • 检查请求体中是否存在所有必需键 • 检查请求体中的所有键是否正确 • 检查请求体中所有值的类型是否正确 • 检查请求体中的所有值是否正确 • 检查是否有拼写错误！对于Document AI API： • 检查请求体中的文档文件位置是否正确 • 检查文档文件是否为支持的格式 • 检查文档文件大小是否小于50MB • 检查是否有拼写错误！
401	提供的API密钥无效	• 检查是否在请求头中设置了API密钥 • 检查Authorization头是否为正确的格式 – “Bearer API_KEY” • 检查API密钥是否未在控制台中删除 • 检查是否有拼写错误！
403	信用额度不足	您的信用额度不足。请注册付款方式。
404	URL路径错误	• 检查请求路径是否正确
405	使用http://的URL路径错误	• 使用https://代替http://
429	在特定时间段内请求过多	• 检查是否发送了超出限制的请求 • 如果需要增加请求频率限制，请联系支持人员
500 / 502 / 503 / 504	处理请求时出现错误	• 稍后重试请求 • 如果仍然收到错误，请联系支持人员

速率限制

为了维护系统稳定性并确保公平的资源分配，我们的服务对 API 请求实施速率限制。

Solar LLM

模型	每分钟请求限制 (RPM)	每月请求限制 (TPM)
solar-pro	100	100,000
solar-docvision	50	100,000
solar-mini	100	100,000
translation-koen	100	100,000
translation-enko	100	100,000
groundedness-check	100	100,000

Embeddings

模型	每分钟请求限制 (RPM)	每月请求限制 (TPM)
embedding-passage	300	300,000
embedding-query	300	300,000

文档解析

模型	每秒请求限制 (RPS)
document-parse	10
document-parse (异步)	30

文档OCR

模型	每秒请求限制 (RPS)
ocr-2.2.1	1

关键信息提

模型	每秒请求限制 (RPS)
air-waybill-extraction-4.1.6	1
bill-of-lading-and-shipping-request-extraction-4.1.6	1
commercial-invoice-and-packing-list-extraction-4.1.6	1
kr-export-declaration-certificate-extraction-4.1.6	1
receipt-extraction-3.2.0	1

4. Upstage API密钥申请和使用中的常见问题

在申请和使用 Upstage API密钥过程中，你可能会遇到以下常见问题：

1. 我在登录或注册时遇到问题？

请等待一段时间后再次尝试注册。
如果问题仍未解决，请尝试使用不同的设备（PC 或移动设备）从不同的位置进行注册
如果问题仍未解决，可能是由于您的互联网连接设置造成的。

2. 为什么我在 API 请求期间收到“401 未经授权”错误？

当无法使用 api 密钥执行身份验证时，会出现此问题。请检查您是否在请求标头中正确写入了Authorization值。

3. 为什么我在 API 请求期间收到“415 不支持的媒体类型”错误？

当文档格式不受支持时会出现此问题。检查正在使用的 API 支持的文件格式。

4. 我可以一次请求多份文件吗？

我们目前不提供一次请求多个文档的接口。我们建议一次连续发送一张图像，而不是同时发送多个请求。一次发送多个请求可能会导致“429 Too Many Requests”错误。

5. 为什么我会收到 429 错误（速率限制）？

速率限制是我们的 API 对用户在给定时间范围内发出请求的频率设置的限制。详细信息请参阅速率限制页面。如果遇到 429 错误，请降低请求频率，并在几秒或一分钟后重试。要请求更高的速率限制，请访问我们的支持页面并提交限制增加请求。

5. Upstage API进阶指引

在获得Upstage API密钥之后，即可开启API接口对接，本文整理了多篇使用Upstage API的案例，帮助读者更有效地使用Upstage API：

文档解析、文档QA、文档OCR、关键信息抓取

6. 常见问题

问题1：什么是幂简集成平台？

幂简集成是蜜堂有信在2023年打造的一款SAAS产品，建设着国内最全的API平台，为开发者提供全面、高效、易用的API集成管理方案，一站搜索、试用、集成国内和国外API。让用户在AI时代全方位接入互联网，用API连接一切服务和算力，实现价值倍增。

问题2：如何找到Upstage API

幂简API平台可以通过以下两种方式找到所需API：通过关键词搜索API(例如，输入’Upstage API‘这类品类词，更容易找到结果)、或者从API hub分类页进入寻找。

问题3：Upstage API的替代品有哪些？

市场上存在免费、付费两种替代者

例如

医疗大模型API接口介绍及对接

Copilot AI大模型API接口介绍及对接

Perplexity AI大模型API接口介绍及对接

豆包大模型API接口介绍及对接-字节跳动

Dolly开源大语言模型API接口介绍及对接

更多竞品可以在Upstage开放平台找到。

7. 总结

本文详细介绍了如何申请、测试和使用Upstage API密钥，并为开发者提供了实际的API使用示例和常见问题解答。通过API密钥的获取与测试，开发者可以确保API正常工作并进行应用开发。在搭建应用时，除了密钥的管理，还需注意错误处理、速率限制和不同服务的请求限制，以优化使用体验。此外，我们还提供了常见问题的解答，帮助开发者在使用过程中解决常见问题。最后，我们介绍了Upstage的进阶使用指引和其他相关API服务，帮助开发者更好地集成并利用Upstage平台的功能。