Skip to main content
GET
/
v1
/
predictions
/
{prediction_id}
Get Prediction
curl --request GET \
  --url https://api.shuyou.ai/v1/predictions/{prediction_id} \
  --header 'Authorization: Bearer <token>'
{
  "code": "0",
  "usage": {
    "upstream_cost": 0.039,
    "discount": 0.00975,
    "discount_percent": 0.75,
    "cost": 0.02925
  },
  "data": {
    "task_id": "fa746cb19082452b82fea4f496f4065a",
    "task_status": "success",
    "output": [
      {
        "type": "image",
        "image": "https://cdn.shuyou.ai/model/20a60c33ba954d85a669ee0f24da8e38.png?e=1778427598&token=Lk3Kb36M3K8oq2d5pU6CaYyoud2Au-APFP-ThE8B:cZUtU2t4yclXCeW0X3j0gJ8Oc58="
      }
    ]
  },
  "request_id": "8bd6b5784a1e42b79bf172607f476f56"
}
Use the data.task_id returned from Create Prediction as the path parameter prediction_id.

​
Response fields

FieldTypeDescription
codestringResponse status code. "0" indicates success.
usageobjectBilling summary. May be omitted while the task is still processing.
usage.upstream_costnumberUpstream cost before discount (USD).
usage.discountnumberDiscount amount (USD).
usage.discount_percentnumberDiscount rate as a decimal (e.g. 0.75 = 75% off).
usage.costnumberFinal billed cost after discount (USD).
data.task_idstringAsync task ID.
data.task_statusstringTask status, e.g. processing, success, or failed.
data.outputarrayGenerated outputs when the task succeeds.
data.output[].typestringOutput media type, e.g. image or video.
data.output[].imagestringImage URL when type is image. URLs may be time-limited.
request_idstringUnique request identifier for support and debugging.
{
  "code": "0",
  "usage": {
    "upstream_cost": 0.039,
    "discount": 0.00975,
    "discount_percent": 0.75,
    "cost": 0.02925
  },
  "data": {
    "task_id": "fa746cb19082452b82fea4f496f4065a",
    "task_status": "success",
    "output": [
      {
        "type": "image",
        "image": "https://cdn.shuyou.ai/model/20a60c33ba954d85a669ee0f24da8e38.png?e=1778427598&token=Lk3Kb36M3K8oq2d5pU6CaYyoud2Au-APFP-ThE8B:cZUtU2t4yclXCeW0X3j0gJ8Oc58="
      }
    ]
  },
  "request_id": "8bd6b5784a1e42b79bf172607f476f56"
}

Authorizations

​
Authorization
string
header
required

Authorization: Bearer YOUR_API_KEY

Path Parameters

​
prediction_id
string
required

Task ID (data.task_id) returned when the prediction was created.

Response

Prediction detail

​
code
string
required

Response status code. "0" indicates success.

Example:

"0"

​
data
object
required
​
request_id
string
required

Unique request identifier for support and debugging.

Example:

"8bd6b5784a1e42b79bf172607f476f56"

​
usage
object

Billing summary for the prediction. May be omitted while the task is still processing.