PiAPI
HomeWorkspace
HomeWorkspace
Join Discord
  1. Joycaption
  • Get Started
    • Overview
    • Quickstart
    • Make Instruction: How to Use PiAPI to Build a Workflow on Make?
  • Endpoints
    • Song(Udio)
      • Song API Task Creation Examples
      • [Udio] Song Extend
      • Get Task
      • Create Task
      • [Udio] Generate Lyrics
    • Kling
      • Lipsync With PiAPI Kling API Examples
      • Motion Brush With PiAPI Kling API Example
      • Kling Elements Video Generation API
      • Kling Effects Video Generation
      • Cancel Task
        • Cancel Tasks
        • Cancel Task
      • Get Task
      • Create Task
      • Kling Virtual Try-On
      • Kling Effects
      • Kling Sound
    • Hailuo
      • Hailuo Director Mode Example
      • Generate Video
      • Get Task
    • Flux
      • Flux with LoRA and Controlnet
      • Available LoRA and Controlnet
      • Flux API with Redux Variation, Fill, Inpaint and Outpaint
      • Create Task
        • Text to Image
        • Image to Image
        • Kontext
      • Get task
    • AI Hug
      • Get Task
      • Create Task
    • LLM
      • Use Cases for GPT-4o Image API
      • How To Avoid Timeouts in Completion API
      • GPT-4o Image Generation API
      • LLM API | Basic Completions
      • Get Task
    • Midjourney
      • PiAPI Penalties on Midjourney Usage
      • Detailed Explaination on Midjourney Task Result
      • Midjourney V7 API 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
    • TTS
      • Zeroshot Text-to-Speech F5-TTS
      • Get Task
    • Trellis
      • Create Task
      • Get Task
    • Luma Dream Machine
      • Cancel Task
        • Cancel Tasks
        • Cancel Task
      • Create Task
      • Get Task
    • WanX
      • Generate WanX Task with LoRA Using PiAPI
      • Available LoRA Types for Wanx
      • Use Cases for Wanx LoRA
      • Use Cases for Wanx Control Camera
      • Create Task
      • Get Task
    • Skyreels
      • Create Task
      • Get Task
    • Framepack
      • Create Task
      • Get Task
    • Hunyuan Video
      • How to Make a Hunyuan API Call
      • Get Task
      • Generate Video
    • Mmaudio
      • Get Task
      • Generate Audio
    • DiffRhythm
      • Generate 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
    • Tools
      • File Upload API
      • Video Upscale
      • Video Upscale-Get Task
      • Remove Background API
      • Remove Background-Get Task
      • Segment With Prompt API
      • Segment With Prompt API-Get Task
      • Image Upscale(Super Resolution) API
      • Image Upscale-Get Task
    • PiAPI Account Management
      • PiAPI Account Info
      • Task List Info
      • User Task History
  • Resources
    • Change Log
    • Output Storage
    • Unified API Schema
    • Webhook
    • Bulk Generation Service
    • Billings
    • PiAPI MCP Server
    • Workspace Manual
      • Host-your-account (HYA) | Back-up Account
      • Host-your-account (HYA) | Debug Checklist
      • Host-your-account (HYA) | Connected Account Status
    • Announcements
      • PiAPI 2025 January 1st Pricing Update
  • Legacy Documentation
    • Midjourney
      • Midjourney Webhook
      • Imagine
      • Reroll
      • Upscale
      • Variation
      • Inpaint
      • Outpaint
      • Pan
      • Describe
      • Blend
      • Seed
      • Fetch
      • Multi Fetch
      • Cancel
    • Face Swap
      • Video Faceswap
      • Multi-face-swap
      • Fetch
    • Dream Machine
      • Video Generation
      • Video Extend
      • Get Video Generation
    • Kling
      • Video Generation
      • Video Extend
      • Get Video Generation
  1. Joycaption

Get Task

GET
https://api.piapi.ai/api/v1/task/{task_id}
This endpoint from PiAPI's Joycaption API retrieves the output of the Joycaption task where users could check their task output.

Request

Path Params
task_id
string 
required
Header Params
X-API-Key
string 
required
Your API KEY used for request authorization

Request 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.piapi.ai/api/v1/task/' \
--header 'X-API-Key;'

Responses

🟢200OK
application/json
OK-Successful Response
Body
code
integer 
optional
data
object 
optional
task_id
string 
optional
input
string 
optional
status
string 
optional
metadata
object 
optional
task
object 
optional
works
array [object {18}] 
optional
message
string 
optional
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
        }
    }
}
🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Modified at 2025-07-17 02:53:23
Previous
Image Caption
Next
File Upload API