Documentation

Démarrage rapide

De zéro à votre première image, en trois étapes.

Étape 1 — Créer une clé

Ouvrez « Mon compte → Plateforme API » et cliquez sur « Créer une clé » en haut à droite. Donnez-lui un nom que vous reconnaîtrez plus tard. La clé est copiée dans le presse-papiers dès sa création, et vous pourrez la recopier depuis la liste quand vous en aurez besoin.

Une clé vaut votre compte : elle dépense vos crédits. Vous pouvez la recopier depuis la liste à tout moment, donc n’en disséminez pas des copies — chaque copie supplémentaire élargit la surface de fuite.

Étape 2 — Voir les modèles disponibles

Placez la clé dans une variable d’environnement et listez les modèles. L’id renvoyé est ce que vous passerez ensuite dans model.

bash
curl https://open.pikpikgo.com/v1/models \
  -H "Authorization: Bearer $PIKPIK_API_KEY"

Étape 3 — Générer une image

bash
curl https://open.pikpikgo.com/v1/images/generations \
  -H "Authorization: Bearer $PIKPIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "une rue cyberpunk sous la pluie la nuit, reflets de néons",
    "size": "16:9",
    "quality": "2k",
    "n": 1
  }'

C’est synchrone par défaut : l’appel attend que l’image soit prête et data[0].url la contient déjà, sans aucune interrogation de tâche. Comptez plus de 30 secondes par image : portez le délai d’attente du client à 300 secondes.

json
{
  "created": 1786000246,
  "data": [
    { "url": "https://cdn.pikpikgo.com/ai/xxxx.png", "revised_prompt": "une rue cyberpunk sous la pluie la nuit, reflets de néons" }
  ],
  "id": "2608101909450810293847",
  "object": "image.generation",
  "model": "img-std-1",
  "status": "succeeded",
  "n": 1,
  "credits": 10,
  "tasks": [
    {
      "id": "2608101909450810293847",
      "status": "succeeded",
      "data": [{ "url": "https://cdn.pikpikgo.com/ai/xxxx.png", "revised_prompt": "une rue cyberpunk sous la pluie la nuit, reflets de néons" }]
    }
  ]
}

Étape 4 — Vous ne voulez pas attendre ? Passez en asynchrone

Ajoutez async: true et l’appel répond aussitôt : status vaut queued et data est encore vide — rien n’a été rendu. Notez tasks[0].id.

bash
curl https://open.pikpikgo.com/v1/images/generations \
  -H "Authorization: Bearer $PIKPIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "une rue cyberpunk sous la pluie la nuit, reflets de néons",
    "size": "16:9",
    "quality": "2k",
    "n": 1,
    "async": true
  }'
json
{
  "id": "2608101909450810293847",
  "object": "image.generation",
  "created": 1786000185,
  "model": "img-std-1",
  "status": "queued",
  "n": 1,
  "credits": 10,
  "tasks": [
    { "id": "2608101909450810293847", "status": "queued", "data": [] }
  ],
  "data": []
}

Interrogez cet id : dès que status passe à succeeded, data[0].url contient l’image. La vidéo ne fonctionne que de cette façon.

bash
curl https://open.pikpikgo.com/v1/tasks/2608101909450810293847 \
  -H "Authorization: Bearer $PIKPIK_API_KEY"
json
{
  "id": "2608101909450810293847",
  "object": "image.generation",
  "created": 1786000185,
  "model": "img-std-1",
  "status": "succeeded",
  "prompt": "une rue cyberpunk sous la pluie la nuit, reflets de néons",
  "size": "16:9",
  "quality": "2k",
  "credits": 10,
  "error": "",
  "data": [
    { "url": "https://cdn.pikpikgo.com/ai/xxxx.png", "revised_prompt": "une rue cyberpunk sous la pluie la nuit, reflets de néons" }
  ]
}

Exemples complets

La voie synchrone fonctionne avec le SDK officiel OpenAI, seule la baseURL change :

javascript
import OpenAI from 'openai'

const client = new OpenAI({
  apiKey: process.env.PIKPIK_API_KEY,
  baseURL: 'https://open.pikpikgo.com/v1',
  timeout: 300 * 1000,
})

// Synchrone : un aller-retour renvoie l’URL, délai porté à 300 secondes
const res = await client.images.generate({
  model: 'img-std-1',
  prompt: 'une rue cyberpunk sous la pluie la nuit, reflets de néons',
  size: '1792x1024',
  n: 1,
})

console.log(res.data[0].url)

La voie asynchrone demande d’enchaîner soi-même envoi et interrogation, en Node.js :

javascript
const BASE = 'https://open.pikpikgo.com/v1'
const KEY = process.env.PIKPIK_API_KEY

async function call(path, body) {
  const res = await fetch(BASE + path, {
    method: body ? 'POST' : 'GET',
    headers: {
      Authorization: `Bearer ${KEY}`,
      'Content-Type': 'application/json',
    },
    body: body ? JSON.stringify(body) : undefined,
  })
  const json = await res.json()
  if (json.error) throw new Error(json.error.message)
  return json
}

// Envoyer puis attendre la fin : interroger toutes les 3 secondes, abandonner au bout de 10 minutes
async function generateImage(prompt) {
  const job = await call('/images/generations', { prompt, size: '16:9', async: true })
  const id = job.tasks[0].id

  for (let i = 0; i < 200; i++) {
    const task = await call(`/tasks/${id}`)
    if (task.status === 'succeeded') return task.data[0].url
    if (task.status === 'failed') throw new Error(task.error || 'échec de la génération')
    await new Promise((r) => setTimeout(r, 3000))
  }
  throw new Error('délai d’attente dépassé')
}

generateImage('une rue cyberpunk sous la pluie la nuit, reflets de néons').then(console.log)

Python (ici en vidéo, avec un intervalle plus large) :

python
import os, time, requests

BASE = "https://open.pikpikgo.com/v1"
KEY = os.environ["PIKPIK_API_KEY"]
HEAD = {"Authorization": f"Bearer {KEY}", "Content-Type": "application/json"}


def call(path, body=None):
    if body is None:
        r = requests.get(BASE + path, headers=HEAD, timeout=30)
    else:
        r = requests.post(BASE + path, headers=HEAD, json=body, timeout=60)
    data = r.json()
    if "error" in data:
        raise RuntimeError(data["error"]["message"])
    return data


def generate_video(prompt, seconds=5):
    job = call("/video/generations", {"prompt": prompt, "duration": seconds})

    # Une vidéo prend en général 1 à 5 minutes ; interroger toutes les 5 secondes suffit, plus souvent ne fait que consommer la limite
    for _ in range(200):
        task = call(f"/video/generations/{job['task_id']}")
        if task["status"] == "succeeded":
            return task["url"]
        if task["status"] == "failed":
            raise RuntimeError(task["error"] or "échec de la génération")
        time.sleep(5)
    raise TimeoutError("délai d’attente dépassé")


print(generate_video("travelling avant lent, une jeune fille se retourne et sourit"))