# Introduction to Upstage API {% embed url="" %} ## 1. Getting Started: **How to Issue Your API Key** You must first obtain your personal API Key to use the Upstage API. Before proceeding, please ensure you’ve signed up for an account on the **Upstage Console**. ### Step-by-step Instructions 1. 🔗 **Visit the Upstage Console** Go to [console.upstage.ai](http://console.upstage.ai/) in your browser. 2. ✍️ **Sign Up** Click the **Login** button at the top right and follow the sign-up process. You can sign up quickly with your Google account. {% hint style="success" %} If you are a member of the **AI ​​Initiative program**, you can use the Solar Pro and DP models for free(\~March 31st, 2026). To join the Initiative program, please refer to the following page! :point\_right: [**LINK**](https://www.upstage.ai/events/ai-initiative-2025-en) {% endhint %} *** ### 1. What is an API (Application Programming Interface)? Before diving into the API itself, let’s first understand JSON, as most APIs—including Upstage’s—use this format to exchange information. #### 1️⃣ What is JSON?
JSON (JavaScript Object Notation) is a structured format for organizing data. For example, instead of saying: > “Apple, Banana, Orange” (which a person has to read and interpret), You can format it like this in JSON: ```json { "fruits": ["apple", "banana", "orange"] } ``` This makes it much easier for computers to process and extract information. 📚 Think of JSON as a **well-organized library**, while plain text is like a **bag of mixed items**. #### 2️⃣ What is an API?
An API is like a **menu of pre-built functions** that a program can call to perform specific tasks, similar to how you order food from a restaurant menu. 🍔 Example API requests: * “Extract text from this scanned document.” * “Summarize this report using Solar LLM.” These requests are sent via the API, and the response is returned in JSON format. {% hint style="success" %} In short: **API = the way you request a function** **JSON = the way the result is delivered** {% endhint %} #### 3️⃣ Why Use APIs? ✅ **Automate Workflows** APIs can automate repetitive tasks. For example, the Document Parse API can process 100 documents simultaneously instead of manually uploading them one by one. ✅ **Scheduled Data Updates** Set APIs to run at scheduled times and keep data updated automatically. For example, automatically summarize and translate news articles daily using Solar LLM. ✅ **Combine Multiple Functions** Use different APIs together—like document parsing → translation → summarization—in one streamlined flow. ### 2. How to Issue Your Upstage API Key Your API Key is a unique identifier that authorizes your access to Upstage services. Follow the steps below to generate and store your key safely: **🔗 Access Upstage Console** * Go to [console.upstage.ai](http://console.upstage.ai/) 🔍 **Click on ‘API Keys’** * On the dashboard, select the **API Keys** menu. ➕ **Click ‘Create New Key’** * Click the **Create New Key** button to generate a new key. 📋 **Copy & Store Your API Key** * Copy the generated key and store it in a safe place. Do not share it with others. ### **⚠️ API Key Usage Notes** {% hint style="danger" %} API Keys are private and unique to you. **If it is leaked, others can misuse your account.** {% endhint %} * 💾 Always store your key in a **secure and private location**. * 🚫 If you suspect your key was exposed, **regenerate it immediately**. ## 2. Upstage API Product Overview The Upstage Console provides various powerful APIs that can be tested and applied to real-world tasks.\ All products are designed to be accessed through a single API key. Therefore, you do not need to obtain a separate key to use each product. #### 💬 1. \[Model] Chat
Use Upstage’s Solar LLM series to build interactive chatbot interfaces. Ideal for text generation, summarization, and context understanding—suitable for customer support, content creation, etc. #### 📄 2. \[Model] Document Digitization
Includes tools to automate document-based tasks: #### 📊 2.1. Document Parsing Converts complex documents into structured formats (HTML, Markdown).\ Helps LLMs understand document flow for tasks like document Q\&A or summarization. #### 🧾 2.2. Document OCR Extracts text from scanned or image-based documents.\ Accurate across languages and resolutions—ideal for automating scanned data processing. #### 📚 3. \[Model] Information Extraction
Extracts key information (dates, names, amounts) from documents in **structured JSON format**. #### 🌐 3.1. Universal Information Extraction Flexible model that works on any document type—even if the structure isn’t predefined. #### 🧠 3.2. Prebuilt Information Extraction Trained on common document types like invoices and contracts.\ Best for automating repeated extraction tasks from standardized forms. #### 🔧 4. \[Feature] Structured Outputs It allows LLM responses to follow a predefined JSON schema, making integrating into your system or generating structured reports easy. #### 🔗 5. \[Feature] Function Calling Enables LLMs to interact with **external tools like APIs or databases** in real time. Use cases include fetching live weather or currency rates, generating automated responses, and more. #### 👁️‍🗨️ 6. \[Model] Embeddings
Converts text into vectors for meaning-based search or similarity comparison. Useful for clustering, semantic search, and classification tasks. *** ### Wrap Up In this section, we’ve covered the **essential first steps** to start using Upstage APIs: 🔹 **What are API & JSON?** APIs provide a set of functions, and JSON formats the results for easy handling. 🔹 **Why use APIs?** They help automate tasks, process real-time data, and combine functions efficiently. 🔹 **How to get started:** Just sign up and generate your API Key. Be sure to keep it secure. 🔹 **Upstage Product Overview:** Explore practical tools like Chat, Document Parsing, OCR, Information Extraction, and more—ready to integrate into real-world application. **YoungHoon Jeon** | **AI Edu** | **Upstage** --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://upstage-ai-education.gitbook.io/upstage-edustage/basics/editor-3/introduction-to-upstage-api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.