Contoh API

Versi

API

Laluan

POST PUT POST

/api/v2/api/translate/uploads
R2 target
/api/v2/api/translate

Parameter

Parameter	Diperlukan	Jenis	Penerangan
`image`	Ya	file[]	Satu atau lebih fail imej, atau satu arkib ZIP
`source_language`	Tidak	string	Pilihan; diperlukan apabila model ialah manga (cth. ja)
`target_language`	Ya	string	Kod bahasa sasaran (cth. en)
`model`	Tidak	string	Model pengecaman; abaikan untuk menggunakan lalai API
`font`	Tidak	string	Gaya fon; abaikan untuk menggunakan lalai API

Parameter	Diperlukan	Jenis	Penerangan
`Idempotency-Key`	Ya	HTTP header	Pengepala permintaan persediaan: kunci stabil untuk mencuba semula senarai fail yang sama dengan selamat selama 8 jam
`platform`	Tidak	string \| null	Permintaan persediaan dan akhir: label platform pilihan yang dilaporkan oleh klien, digunakan hanya untuk audit panggilan API
`files[]`	Ya	array<object>	Permintaan persediaan: metadata fail yang mengandungi filename, content_type, size dan content_sha256
`upload_id`	Ya	string	Permintaan akhir: ID kelompok muat naik legap yang dikembalikan oleh persediaan
`files[].index files[].upload_intent`	Ya	integer string	Permintaan akhir: index dan upload_intent legap bagi setiap fail yang dikembalikan oleh persediaan; hantar hanya selepas setiap muat naik R2 selesai
`source_language`	Tidak	string	Pilihan; diperlukan apabila model ialah manga (cth. ja)
`target_language`	Ya	string	Kod bahasa sasaran (cth. en)
`model`	Tidak	string	Model pengecaman; abaikan untuk menggunakan lalai API
`font`	Tidak	string	Gaya fon; abaikan untuk menggunakan lalai API

Parameter	Diperlukan	Jenis	Penerangan
`batch_id`	Ya	string	Pengecam kelompok untuk menyemak status tugas

Parameter	Diperlukan	Jenis	Penerangan
Tiada parameter

Parameter Respons

Medan	Jenis	Penerangan
`task_id`	string	Pengecam tugas
`batch_id`	string	Pengecam kelompok untuk menyemak status tugas

Medan	Jenis	Penerangan
`status`	integer	Kod status aplikasi; 200 apabila berjaya
`cost_ms`	integer	Masa untuk mengendalikan permintaan API ini dalam milisaat
`request_id`	string	Pengecam permintaan untuk menjejaki panggilan API ini
`data`	object	Pengecam tugas terjemahan yang dikembalikan selepas permintaan diterima
`message`	string	Sentiasa success untuk respons API yang berjaya; tidak bermaksud tugas terjemahan telah selesai
`data.task_id`	string	Pengecam tugas
`data.batch_id`	string	Pengecam kelompok untuk menyemak status tugas

Medan	Jenis	Penerangan
`status_code`	integer	Sentiasa 200 untuk respons Task Status yang berjaya
`request_id`	string	Pengecam permintaan untuk menjejaki panggilan API ini
`auth_type`	string	Sentiasa account untuk permintaan Task Status yang disahkan dengan PAT
`task_reference`	string	batch_id daripada laluan permintaan, dikembalikan tanpa perubahan
`data`	object	Bekas untuk hasil setiap imej dan status keseluruhan tugas
`data.items`	array<object>	Tatasusunan hasil tugas bagi setiap imej
`data.items[].image_id`	string	Pengecam stabil untuk hasil imej
`data.items[].index`	integer	Kedudukan imej berasaskan sifar dalam kelompok
`data.items[].filename`	string	Nama fail imej asal
`data.items[].status`	string	Status hasil imej (pending \| processing \| completed \| failed \| canceled)
`data.items[].original_url`	string	URL imej sumber; tersedia untuk tugas semasa yang dicipta melalui API.
`data.items[].translated_url`	string	URL imej terjemahan; rentetan kosong sehingga hasil tersedia, termasuk untuk imej menunggu, sedang diproses atau gagal.
`data.items[].is_translated`	boolean	true hanya apabila URL imej terjemahan yang siap tersedia
`data.items[].output_file_path`	string	Alias keserasian bagi translated_url; rentetan kosong apabila tiada imej terjemahan tersedia.
`data.items[].message`	string \| null	Mesej maklumat pilihan
`data.items[].error`	string \| null	Butiran ralat apabila tugas imej gagal; selainnya null
`data.items[].inpaint_image_url`	string \| null	URL imej dengan teks dipadam, atau null apabila model atau laluan pelaksanaan yang dipilih tidak menjananya.
`data.items[].block_json`	array<object>	Blok teks berstruktur yang dikekalkan oleh V1; mungkin tatasusunan kosong apabila model atau laluan tidak mengembalikan metadata blok.
`data.task_status`	string	Status keseluruhan tugas (pending \| processing \| completed \| failed \| canceled)

Medan	Jenis	Penerangan
`status`	integer	Kod status aplikasi; 200 apabila berjaya
`cost_ms`	integer	Masa berlalu tugas dalam milisaat; 0 apabila cap masa tugas yang sah tiada
`request_id`	string	Pengecam permintaan untuk menjejaki panggilan API ini
`data`	array<object>	Tatasusunan ringkas hasil bagi setiap imej
`message`	string	Sentiasa success untuk respons API yang berjaya; tidak bermaksud tugas terjemahan telah selesai
`data[].image_id`	string	Pengecam stabil untuk hasil imej
`data[].filename`	string	Nama fail imej asal
`data[].status`	string	Status hasil imej (pending \| processing \| completed \| failed \| canceled)
`data[].original_url`	string	URL imej sumber; tersedia untuk tugas semasa yang dicipta melalui API.
`data[].translated_url`	string	URL imej terjemahan; rentetan kosong sehingga hasil tersedia, termasuk untuk imej menunggu, sedang diproses atau gagal.
`data[].erased_url`	string	URL imej dengan teks dipadam; mungkin rentetan kosong. Model atau laluan yang hanya mengembalikan imej siap, seperti Manga dengan laluan imej siap Auto, tidak menjananya.
`data[].blocks`	array<object>	Blok teks terjemahan berstruktur; mungkin tatasusunan kosong apabila model atau laluan tidak mengembalikan metadata blok, seperti Manga dengan laluan imej siap Auto.
`data[].blocks[].angle`	number	Sudut putaran blok teks
`data[].blocks[].color`	string	Warna heksadesimal yang digunakan untuk teks terjemahan
`data[].blocks[].handwritten`	boolean	Sama ada teks sumber dikesan sebagai tulisan tangan
`data[].blocks[].location`	object	Sempadan empat penjuru blok teks
`data[].blocks[].location.left_bottom`	array<number>	Pasangan koordinat bagi penjuru yang dinamakan
`data[].blocks[].location.right_bottom`	array<number>	Pasangan koordinat bagi penjuru yang dinamakan
`data[].blocks[].location.left_top`	array<number>	Pasangan koordinat bagi penjuru yang dinamakan
`data[].blocks[].location.right_top`	array<number>	Pasangan koordinat bagi penjuru yang dinamakan
`data[].blocks[].text`	string	Teks terjemahan yang dipaparkan untuk blok
`data[].blocks[].direction`	string	Arah tulisan teks terjemahan

Medan	Jenis	Penerangan
`subscription_credits`	integer	Baki kredit bagi kategori yang dinamakan
`subscription_credits_expires_at`	string \| null	Masa tamat kredit langganan dalam format ISO 8601, atau null
`one_time_credits`	integer	Baki kredit bagi kategori yang dinamakan
`one_time_credits_expires_at`	string \| null	Masa tamat kredit sekali guna dalam format ISO 8601, atau null
`free_credits`	integer	Baki kredit bagi kategori yang dinamakan
`total_credits`	integer	Jumlah semua baki kredit yang tersedia
`is_temporary`	boolean	Sama ada baki itu milik akaun sementara

Medan	Jenis	Penerangan
`status`	integer	Kod status aplikasi; 200 apabila berjaya
`cost_ms`	integer	Masa untuk mengendalikan permintaan API ini dalam milisaat
`request_id`	string	Pengecam permintaan untuk menjejaki panggilan API ini
`data`	object	Bekas untuk baki kredit semasa
`message`	string	Sentiasa success untuk respons API yang berjaya; tidak bermaksud tugas terjemahan telah selesai
`data.total_credits`	integer	Jumlah semua baki kredit yang tersedia
`data.is_temporary`	boolean	Sama ada baki itu milik akaun sementara
`data.detail`	object	Pecahan kredit tersedia mengikut kategori
`data.detail.subscription`	object	Baki dan masa tamat kredit bagi kategori tersebut
`data.detail.subscription.credits`	integer	Baki kredit bagi kategori yang dinamakan
`data.detail.subscription.expires_at`	string \| null	Masa tamat kredit dalam format ISO 8601, atau null
`data.detail.one_time`	object	Baki dan masa tamat kredit bagi kategori tersebut
`data.detail.one_time.credits`	integer	Baki kredit bagi kategori yang dinamakan
`data.detail.one_time.expires_at`	string \| null	Masa tamat kredit dalam format ISO 8601, atau null
`data.detail.free`	object	Baki dan masa tamat kredit bagi kategori tersebut
`data.detail.free.credits`	integer	Baki kredit bagi kategori yang dinamakan
`data.detail.free.expires_at`	null	Sentiasa null kerana endpoint agregat ini tidak menyediakan satu masa tamat untuk kredit percuma

Contoh Respons (JSON)

{
  "task_id": "00000000-0000-4000-8000-000000000001",
  "batch_id": "00000000-0000-4000-8000-000000000001"
}

Contoh Respons (JSON)

{
  "status": 200,
  "cost_ms": 125,
  "request_id": "4b7370383cacccc7",
  "data": {
    "task_id": "00000000-0000-4000-8000-000000000001",
    "batch_id": "00000000-0000-4000-8000-000000000001"
  },
  "message": "success"
}

Contoh Respons (JSON)

{
  "status_code": 200,
  "request_id": "4b7370383cacccc7",
  "auth_type": "account",
  "task_reference": "00000000-0000-4000-8000-000000000001",
  "data": {
    "items": [
      {
        "image_id": "00000000-0000-4000-8000-000000000001_0",
        "index": 0,
        "filename": "007.jpg",
        "status": "completed",
        "original_url": "https://storage.example.com/manga-demo/input/00000000-0000-4000-8000-000000000001/007.jpg",
        "translated_url": "https://storage.example.com/manga-demo/output/00000000-0000-4000-8000-000000000001/007.jpg",
        "is_translated": true,
        "output_file_path": "https://storage.example.com/manga-demo/output/00000000-0000-4000-8000-000000000001/007.jpg",
        "message": "ok",
        "error": null,
        "inpaint_image_url": "https://storage.example.com/manga-demo/output/00000000-0000-4000-8000-000000000001/007-erased.jpg",
        "block_json": []
      }
    ],
    "task_status": "completed"
  }
}

Contoh Respons (JSON)

{
  "status": 200,
  "cost_ms": 5300,
  "request_id": "4b7370383cacccc7",
  "data": [
    {
      "image_id": "00000000-0000-4000-8000-000000000001_0",
      "filename": "007.jpg",
      "status": "completed",
      "original_url": "https://storage.example.com/manga-demo/input/00000000-0000-4000-8000-000000000001/007.jpg",
      "translated_url": "https://storage.example.com/manga-demo/output/00000000-0000-4000-8000-000000000001/007.jpg",
      "erased_url": "https://storage.example.com/manga-demo/output/00000000-0000-4000-8000-000000000001/007-erased.jpg",
      "blocks": [
        {
          "angle": 0,
          "color": "#484848",
          "handwritten": false,
          "location": {
            "left_bottom": [1685, 293],
            "right_bottom": [1786, 293],
            "left_top": [1685, 264],
            "right_top": [1786, 264]
          },
          "text": "OOOUGH!",
          "direction": "horizontal"
        }
      ]
    }
  ],
  "message": "success"
}

Contoh Respons (JSON)

{
  "subscription_credits": 0,
  "subscription_credits_expires_at": null,
  "one_time_credits": 0,
  "one_time_credits_expires_at": null,
  "free_credits": 10,
  "total_credits": 10,
  "is_temporary": true
}

Contoh Respons (JSON)

{
  "status": 200,
  "cost_ms": 4,
  "request_id": "4b7370383cacccc7",
  "data": {
    "total_credits": 10,
    "is_temporary": true,
    "detail": {
      "subscription": {
        "credits": 0,
        "expires_at": null
      },
      "one_time": {
        "credits": 0,
        "expires_at": null
      },
      "free": {
        "credits": 10,
        "expires_at": null
      }
    }
  },
  "message": "success"
}

Parameter Respons Ralat

Apabila V2 gagal, status HTTP dikekalkan dan sampul lima medan yang sama dikembalikan.

Medan	Jenis	Penerangan
`status`	integer	Kod status ralat HTTP sebenar
`cost_ms`	integer	Masa untuk mengendalikan permintaan API ini dalam milisaat
`request_id`	string	Pengecam permintaan untuk menjejaki panggilan API ini
`data`	object	Bekas data ralat yang hanya mengandungi kod stabil yang boleh dibaca mesin
`message`	string	Mesej ralat awam; butiran diagnostik dalaman tidak didedahkan
`data.code`	string	Kod ralat stabil yang boleh dibaca mesin

Contoh Respons Ralat (JSON)

{
  "status": 400,
  "cost_ms": 1,
  "request_id": "4b7370383cacccc7",
  "data": {
    "code": "PZ_API_ACCESS_BAD_REQUEST"
  },
  "message": "Invalid target language"
}

Input contoh

Kunci API

Bahasa sumber

Bahasa sasaran

Model

Fon

Contoh API

Laluan

Parameter

Parameter Respons

Contoh Respons (JSON)

Contoh Respons (JSON)

Contoh Respons (JSON)

Contoh Respons (JSON)

Contoh Respons (JSON)

Contoh Respons (JSON)

Parameter Respons Ralat

Contoh Respons Ralat (JSON)

Input contoh

Contoh Python3

Contoh cURL

Contoh Python3

cURL

Contoh Python3

cURL

Laluan

Parameter

Parameter Respons

Contoh Respons (JSON)

Contoh Respons (JSON)

Contoh Respons (JSON)

Contoh Respons (JSON)

Contoh Respons (JSON)

Contoh Respons (JSON)

Parameter Respons Ralat

Contoh Respons Ralat (JSON)

Input contoh

Contoh Python3

Contoh cURL

Contoh Python3

cURL

Contoh Python3

cURL

Keutamaan Kuki