GoAPI
HomeDashboard
HomeDashboard
Join Discord
  1. Joycaption
  • Get Started
  • Endpoints
    • Flux
      • Flux API with Redux Variation, Fill, Inpaint and Outpaint
      • Flux with LoRA and Controlnet
      • Available LoRA and Controlnet
      • Create Task
        • Text to Image
        • Image to Image
        • Kontext
      • Get Task
    • Gemini
      • Gemini-2.5-flash-image
      • Nano Banana Pro
      • Nano Banana 2
      • Get Task
    • Veo3
      • Veo3 Text to Video
      • Veo3 Image to Video
      • Veo3.1 Text to Video
      • Veo3.1 Image to Video
      • Get Task
    • Sora2
      • Sora2-preview Text to Video
      • Sora2 Text to Video
      • Sora2-Pro Text to Video
      • Sora2 Remove Watermark
      • Get Task
    • Omni Human
      • Omni Human 1.5
      • Get Task
    • Seedance
      • Moderation and Penalty
      • Seedance 2 preview
      • Seedance 2
      • Video Watermark Remover
      • Get Task
    • Seedream
      • Seedream 5 Lite
      • Get Task
    • Qwen Image
      • Text to Image
      • Image Edit
      • Get Task
    • Z-Image
      • Text to Image
      • Get Task
    • AI Hug
      • Create Task
      • Get Task
    • Midjourney
      • Detailed Explaination on Midjourney Task Result
      • GoAPI Penalties on Midjourney Usage
      • Midjourney V7 Instructions
      • Create Task
        • Imagine
        • Upscale
        • Variation
        • Reroll
        • Describe
        • Seed
        • Blend
        • Inpaint
        • Outpaint
        • Pan
      • Cancel Task
        • Cancel Task
        • Cancel Tasks
      • Get Task
    • Faceswap
      • Multi Faceswap
      • Image Faceswap
      • Video Faceswap
      • Get Task
    • Suno
      • Music
      • Lyrics
      • Get Task
    • Song (Udio)
      • Song API Task Creation Examples(Udio and Suno)
      • [Udio] Song Extend
      • Create Task
      • [Udio] Generate Lyrics
      • Get Task
    • TTS
      • Zeroshot Text-to-Speech F5-TTS
      • Get Task
    • DiffRhythm
      • Generate an Audio
      • Get Task
    • Ace Step
      • Create Task
        • Text to Audio
        • Audio to Audio
        • Audio Edit
        • Audio Extend
      • Get Task
    • Joycaption
      • Image Caption
        POST
      • Get Task
        GET
    • Mmaudio
      • Generate Audio
      • Get task
    • Dream Machine
      • Create Task
      • Get Task
    • Kling
      • Lipsync API Examples
      • Motion Brush Example
      • Kling Elements Video Generation API
      • Kling Effects Video Generation
      • Cancel Task
        • Cancel Task
        • Cancel Tasks
      • Create Task
      • Get Task
      • Kling Virtual Try-On
      • Kling Effects
      • Kling Sound
      • Kling Avatar
      • Kling Motion Control
      • Kling Turbo
      • Kling 3.0
    • Kling Omni
      • Kling o1
      • Kling 3.0 omni
      • Get Task
    • Hailuo
      • Generate Video
      • Get Task
    • Hunyuan Video
      • How to Make a Hunyuan API Call
      • Available Hunyuan Lora models
      • Generate Video
      • Get Task
    • WanX
      • Generate WanX Task with LoRA Using GoAPI
      • Available LoRA Types for Wanx
      • Use Cases for Wanx LoRA
      • Use Cases for Wanx Control Camera
      • Create Task
      • Get Task
    • Wan
      • Wan2.6 Text to Video
      • Wan2.6 Image to Video
      • Get Task
    • Skyreels
      • Create Task
      • Get Task
    • Framepack
      • Create Task
      • Get Task
    • Trellis
      • Trellis Create Task
      • Trellis2 Create Task
      • Get Task
    • GPTs API
      • ChatGPT Account Configuration
      • Examples for files upload into conversations in GPTs API
      • Conversation API
        • Create conversation
        • Add message to conversation
        • Upload file to conversation
        • Download file from code interpretor's sandbox
        • Download file from conversation
        • Get Task
    • LLM
      • LLM API | Basic Completions
      • Transcription API
      • TTS API
      • Embeddings API
      • Dall E 3 API
    • Account Management
      • Account Notification Webhook
      • Account Info
      • Task List Info
      • User Task History
    • Tools
      • File Upload API
      • Remove Background API
      • Remove Background-Get task
      • Segment With Prompt API
      • Segment with Prompt-Get task Copy
      • Image Upscale(Super Resolution) API
      • Image Upscale-Get task
      • Video Upscale
      • Video Upscale-Get task
      • Video Remove Background
      • Video Remove Background-Get task
    • GPT-image
      • GPT-image API
    • Seedance 2
  • Resources
    • Pricing Plan
    • Unified API Schema
    • Unified API Webhook
    • Technical Questions
    • Bulk Generation Service
    • Change Log
    • Common Error Message
    • Output Storage
    • Dashboard Manual
      • BYOA | Back-up Account
      • BYOA | Debug Checklist
      • BYOA | Connected Account Status
    • Announcements
      • GoAPI 2025 January 1st Pricing Update
      • The discontinued support for midjourney
      • Sunsetting Suno
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
    • Schemas
      • Motion Brush
      • Float2 Point
      • Control Points
      • txt2video-1.3b
      • txt2video-14b
      • txt2video-14b-lora
      • img2video-14b
      • img2video-14b-lora
      • img2video-14b-keyframe
      • img2video-14b-control-camera
      • wan22-txt2video-14b
      • wan22-img2video-14b
      • ErrorResponse
      • Trellis API/text-to-3D
      • Trellis API/image-to-3D
      • Trellis2 API/image-to-3D
      • Create Task
      • VideoGenerationResponse
      • camera control
      • Cancel Params
      • TaskConfig
      • TaskResponse
    • Response
      • Unified-Task-Response
    • RequestBodies
      • Unified-Task-Request-Body
    • config
    • control_net_setting
    • lora_setting
    • Kling omni multi shot
  1. Joycaption

Get Task

GET
https://api.goapi.ai/api/v1/task/{task_id}
Retrive task result using task_id. In most scenarios you will need a fetch call to retrive the task result, using task_id.

Request

Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.goapi.ai/api/v1/task/' \
--header 'x-api-key;'

Responses

🟢200Success
application/json
Body

Example
{
  "timestamp": 1752646924,
  "data": {
    "task_id": "1e829971-31b6-44e6-83cc-84d20b9e089c",
    "model": "Qubico/joycaption",
    "task_type": "joycaption-beta-one",
    "status": "completed",
    "config": {
      "service_mode": "",
      "webhook_config": {
        "endpoint": "",
        "secret": ""
      }
    },
    "input": {
      "caption_length": "any",
      "image": "https://piapi.ai/workspace/flux/input_example.png",
      "prompt_style": "Descriptive"
    },
    "output": {
      "text": "This is a vibrant, digitally-created photograph featuring the word \"PIPI\" made entirely from colorful, textured flower petals. The letters are positioned horizontally in the center of the image, with \"P\" on the left in bright pink petals, \"I\" in the middle with a mix of pink and purple petals, and \"P\" on the right in vivid orange petals. Each letter is topped with a single, full-bloomed flower, with \"P\" on the left and right having yellow daisies, and the middle \"I\" having a pink daisy. The background showcases a clear blue sky with fluffy white clouds, adding a sense of depth and openness. The ground is covered in lush, green grass interspersed with a variety of small, colorful flowers, including white daisies with yellow centers and pink and yellow flowers. The flowers in the foreground are slightly blurred, creating a shallow depth of field that brings the flower-petal letters into sharp focus. The overall style is bright, cheerful, and whimsical, evoking a sense of springtime and natural beauty. The image combines realistic textures with a playful, artistic touch, making it visually engaging and joyful."
    },
    "meta": {
      "created_at": "2025-07-16T06:21:33.896480518Z",
      "started_at": "2025-07-16T06:21:34.85615288Z",
      "ended_at": "2025-07-16T06:22:04.704104422Z",
      "usage": {
        "type": "llm",
        "frozen": 0,
        "consume": 100000
      },
      "is_using_private_pool": false
    },
    "detail": null,
    "logs": [],
    "error": {
      "code": 0,
      "raw_message": "",
      "message": "",
      "detail": null
    }
  }
}
Modified at 2025-07-17 02:00:36
Previous
Image Caption
Next
Generate Audio