Docs
    Docs
    • Introduction
    • Quick Start Guide
    • Make a request
    • YEScale System API Tutorial
    • Chat Models
      • ChatGpt
        • ChatGPT (Audio)
          • Create transcription by gpt-4o-mini-transcribe & gpt-4o-transcribe
          • Create a voice with gpt-4o-mini-tts
          • Create a voice
          • Create a transcript
          • Create translation
        • ChatGPT (Chat)
          • Chat completion object
          • Create chat completion (streaming)
          • Create chat completion (non-streaming)
          • Create chat image recognition (streaming)
          • Create chat image recognition (streaming) base64
          • Create chat image recognition (non-streaming)
          • Function calling
          • N choices
          • Create chat function call (only non-streaming)
          • Create structured output
        • ChatGPT (Completions)
          • Completion object
          • Creation completed
        • ChatGPT(Embeddings)
          • Embedded Object
          • Create embed
      • Anthropic Claude
        • Offical Format
          • Messages (official Anthropic format)
          • Messages(Image Recognition)
          • Messages(function call)
          • Messages(Web search)
        • Create chat completion (streaming)
        • Create chat completion (non-streaming)
        • Create chat image recognition (streaming)
        • Create chat image recognition (non-streaming)
      • Gemini
        • Gemini Image creation interface (gemini-2.0-flash-exp-image-generation)
        • Chat interface
        • Image recognition interface
        • Function calling - Google Search
        • Function calling - codeExecution
    • Image Models
      • GPT-IMAGE-1
        • Generate Image by gpt-image-1
        • Edit Image by gpt-image-1
      • MJ
        • Submit Imagine task (mj_imagine)
        • Submit Blend task (mj_blend)
        • Submit Describe task (mj_describe)
        • Submit Change task (mj_variation, mj_upscale,mj_reroll)
        • Query task status based on task ID
      • Ideogram
        • Generate with Ideogram 3.0
        • Edit with Ideogram 3.0
        • Remix with Ideogram 3.0
        • Ideogram Upscale
      • Kling Image
        • Submit Image Generation
        • Get Image by Task ID
        • Submit Kolors Virtual Try On
        • Get Kolors Virtual Try On by Task ID
      • Flux
        • Flux on Replicate
          • Submit Image by flux-kontext-pro
          • Submit Image by flux-kontext-max
          • Submit Image by flux-pro
          • Get Image by ID
      • Recraft API
        • Recraft Image
        • Generate Image
        • Generate Vector Image
        • Remove Background
        • Clarity Upscale
        • Generative Upscale
      • Models use Dall-e Format
        • Google Imagen
        • Bytedance - seedream-3.0
        • Recraftv3 use Dall-e endpoint
        • Flux use Dall-e endpoint
      • DALL·E 3
        POST
    • Video Models
      • Kling Video
        • Create Video by Text
        • Get Video by Task ID(text2video)
        • Create Video by Image
        • Get Video by Task ID(image2video)
      • Runway ML Video
        • Create Video by Runway
        • Get Video by Task ID
      • Luma Video
        • Create Video by Luma
        • Get Video by Task ID
      • Pika Video
        • Create Video by Pika
        • Get Video by Task ID
      • Google Veo
        • Submit Video Request
        • Submit Video Request with Frames
        • Get Video by ID
      • Minimax - Hailuo
        • Submit Video Request
        • Get Video
      • Seedance
        • Submit Video Request
        • Get Video by Task ID
      • Mj Video
        • Submit Mj Video Request
        • Get Mj Video by task id
    • Music Model - Suno
      • Illustrate
      • Parameter
      • Task submission
        • Generate songs (inspiration, customization, continuation)
        • Generate lyrics
      • Query interface
        • Query a single task
    • Python Samples
      • python openai official library (using AutoGPT, langchain, etc.)
      • Python uses speech to text
      • Python uses text to speech
      • Python uses Embeddings
      • python calls DALL·E
      • python simple call openai function-calling demo
      • python langchain
      • python llama_index
      • Python uses gpt-4o to identify pictures-local pictures
      • python library streaming output
      • Python uses gpt-4o to identify images
    • Plug-in/software usage tutorials
      • Setting HTTP for Make.com with Yescale
      • Sample Code for gpt-4o-audio/gpt-4o-mini-audio
    • Help Center
      • HTTP status codes
    • Tutorials
      • GPT-Image-1 API: A Step-by-Step Guide With Examples
      • Claude Code via YEScale API

    Make a request

    You can paste the following command into your terminal to run your first API request. Make sure to replace YOUR_API_KEY with your secret API key.
    This request queries the model to complete a text prompt starting with "Say this is a test" using the gpt-3.5-turbo model. You should receive a response similar to the following:
    {
       "id": "chatcmpl-abc123",
       "object": "chat.completion",
       "created": 1677858242,
       "model": "gpt-3.5-turbo-0301",
       "usage": {
          "prompt_tokens": 13,
          "completion_tokens": 7,
          "total_tokens": 20
       },
       "choices": [
          {
             "message": {
                "role": "assistant",
                "content": "\n\nThis is a test!"
             },
             "finish_reason": "stop",
             "index": 0
          }
       ]
    }
    Now you’ve generated your first chat completion. We can see that the finish_reason is stop, which means the API returned a complete response generated by the model. In the above request, we generated only one message, but you can configure the n parameter to generate multiple message options.
    In this example, gpt-3.5-turbo is used primarily for traditional text completion tasks. The model is also optimized for chat-based applications.
    Modified at 2025-02-19 09:04:17
    Previous
    Quick Start Guide
    Next
    YEScale System API Tutorial
    Built with