Skip to main content
POST
Pobierz stan, wymiary i termin wygaśnięcia obrazu wygenerowanego przez połączone konto.

Uwierzytelnianie i uprawnienia

string
wymagane
Wyślij klucz API VoiceCheap w tym nagłówku. Obsługiwany jest również nagłówek Authorization: Bearer z tym samym kluczem API. Tokeny dostępu OAuth są akceptowane tylko przez MCP, a nie przez ten endpoint REST.
Wymagane uprawnienia: images:read. Wymagana jest aktywna płatna subskrypcja. Uprawnienia nie zmieniają ról w zespole, własności zasobów, kredytów na multimedia ani limitów planu.

Parametry

string
wymagane
Identyfikator generowania zwrócony przez akcję generowania lub historii.Wzorzec: ^[A-Za-z0-9_-]{1,128}$.
Poniższy JSON Schema zachowuje dokładne nazwy pól, typy zagnieżdżone, wartości domyślne, ograniczenia i akceptowane wartości udostępniane przez mechanizm wykrywania. Dodatkowe reguły zależności między polami znajdują się w uwagach do operacji.

Przykłady żądań

Zastąp przykładowe identyfikatory zasobów i klucze multimediów wartościami zwróconymi dla Twojego konta. Przy ponawianiu tej samej operacji zmieniającej dane zachowaj identyfikator żądania.

Odpowiedź

Pierwsze pomyślne wykonanie zwraca HTTP 200 z wynikiem operacji w data. Ponowienie może zamiast tego zwrócić zapisany stan żądania. Przykład przedstawia jedną obsługiwaną odpowiedź, bez wszystkich opcjonalnych pól. Publiczne metadane własnego obrazu aplikacji, w tym bieżący status, wymiary i termin wygaśnięcia. Dane obrazu są pobierane oddzielnie.

Pola wyniku

Uwagi do operacji

  • Wymaga images:read. generationId musi zawierać 1–128 liter ASCII, cyfr, podkreśleń lub łączników.
  • Ta akcja korzysta z własnych utworzonych materiałów i przesłanych plików połączonego użytkownika, również gdy dane uwierzytelniające są połączone w kontekście zespołu.
  • Rekord może wskazywać pending, completed, failed lub expired. Szerokość i wysokość mają wartość null, gdy nie są dostępne. Rekord może pozostać widoczny jako expired do czasu usunięcia podczas czyszczenia; pomyślne get nie gwarantuje dostępności pobierania.
  • Użyj images_download, aby pobrać bajty PNG przed expiresAt. Ta akcja nie zwraca previewDataUrl ani adresu URL multimediów.

Wykorzystanie

Każde pomyślne wywołanie zużywa jedno wywołanie z miesięcznego limitu API/MCP. Obowiązują również kredyty na multimedia oraz limity generowania danej operacji.

Błędy