Creare e recuperare
Tutti e tre i prodotti utilizzano un unico Creations API, quindi video, immagini e risultati app condividono la stessa lista, dettagli e flusso di lavoro di uscita.
Scarica i file sorgente
Tutti i prodotti accettano input_file_ids. Scarica un file prima:
curl -s "https://api.kpainter.ai/openapi/v1/files" \ -H "Authorization: Bearer $KPAINTER_API_KEY" \ -F "file=@./handbook.pdf"Esempio di risposta:
{ "file_id": "file_xxx", "name": "handbook.pdf", "mime_type": "application/pdf", "size_bytes": 248391}Utilizzare il file_id restituito solo all'interno delle creazioni di proprietà dello stesso account.
Crea
POST /creationsI campi comuni:
| campo | richiesto | Significato |
|---|---|---|
| Tipo | Sì | Video, Immagini o App |
| Presto | Sì | Cosa creare |
| istruzioni | Non | Requisiti aggiuntivi |
| Sito ufficiale - file_ids | Non | ID di fonte precedentemente caricati |
| max - crediti | Non | Crediti massimi autorizzati per questo compito |
| Video / Immagine / App | Sì | Esattamente una configurazione di un oggetto corrisponde al tipo |
Esempio di:
{ "type": "app", "prompt": "Build a safety quiz with immediate feedback from the handbook", "input_file_ids": ["file_xxx"], "app": { "language": "en" }}Elenco e ottenere
GET /creations?page=1&page_size=20GET /creations?type=video&page=1&page_size=20GET /creations/{id}Campi utili per i dettagli:
| campo | Significato |
|---|---|
| Statuto | Pianificazione, produzione, pausa, pronta o fallita |
| Il progresso - PCT | Progresso monotono da 0 a 100 |
| Previsioni_Remaining_Secondes | presente solo quando affidabile |
| Crediti - Crediti | Valutazione attuale per questa attività |
| Crediti effettivi | Crediti netti per un compito di successo |
| ha_usable_divertimento | Se un risultato usabile esiste già |
| Disponibile - azioni | Le azioni che sono attualmente sicure da chiamare |
| Recensione | Un video sicuro quando disponibile |
| Il codice / Code | Un codice di risultato sicuro per l'utente |
I fallimenti ordinari omitano i crediti effettivi. Un’ETA non affidabile è dimenticato piuttosto che sospettato.
Leggi le uscite
GET /creations/{id}/outputsIl display restituisce solo le uscite. Non indicare un URL o utilizzare un'arte intermedia non finita.
Un flusso client stabile
- Leggi le capacità.
- Inviare una richiesta di creazione valida.
- Fare la stessa creazione ogni pochi secondi.
- Leggi le uscite dopo la preparazione.
- In caso di pausa, visualizzare le azioni disponibili e aspettare l'azione richiesta dell'utente.
- In caso di fallimento, mostrare la ragione sicura e lasciare che l'utente riveda la richiesta.
- Se lo stato di rete è incerto, ottenere la creazione esistente prima di creare un altro.