Início rápido

Do zero à primeira imagem em três passos.

Passo 1: criar uma chave

Abre «A minha conta → Plataforma API» e carrega em «Criar chave», no canto superior direito. Dá-lhe um nome que reconheças mais tarde. A chave é copiada para a área de transferência assim que é criada e podes voltar a copiá-la da lista sempre que precisares.

Uma chave equivale à tua conta e gasta os teus créditos. Podes voltar a copiá-la da lista quando quiseres, por isso não espalhes cópias: cada cópia extra alarga a superfície de fuga.

Passo 2: ver que modelos existem

Coloca a chave numa variável de ambiente e lista os modelos. O id devolvido é o que passarás depois em model.

bash

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

Passo 3: gerar uma imagem

bash

curl https://open.pikpikgo.com/v1/images/generations \
  -H "Authorization: Bearer $PIKPIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "uma rua cyberpunk à chuva de noite, reflexos de néon",
    "size": "16:9",
    "quality": "2k",
    "n": 1
  }'

Por predefinição é síncrono: a chamada espera até a imagem estar pronta e data[0].url já a contém, sem consultar tarefa nenhuma. Cada imagem costuma demorar mais de 30 segundos, por isso alarga o tempo limite do cliente para 300 segundos.

json

{
  "created": 1786000246,
  "data": [
    { "url": "https://cdn.pikpikgo.com/ai/xxxx.png", "revised_prompt": "uma rua cyberpunk à chuva de noite, reflexos de néon" }
  ],
  "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": "uma rua cyberpunk à chuva de noite, reflexos de néon" }]
    }
  ]
}

Passo 4: não queres esperar? Usa assíncrono

Acrescenta async: true e a chamada responde logo: status é queued e data ainda está vazio — nada foi renderizado. Guarda 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": "uma rua cyberpunk à chuva de noite, reflexos de néon",
    "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": []
}

Sonda esse id: quando status passa a succeeded, data[0].url contém a imagem. O vídeo só funciona assim.

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": "uma rua cyberpunk à chuva de noite, reflexos de néon",
  "size": "16:9",
  "quality": "2k",
  "credits": 10,
  "error": "",
  "data": [
    { "url": "https://cdn.pikpikgo.com/ai/xxxx.png", "revised_prompt": "uma rua cyberpunk à chuva de noite, reflexos de néon" }
  ]
}

Exemplos completos

A via síncrona funciona com o SDK oficial da OpenAI; só muda a baseURL:

javascript

import OpenAI from 'openai'

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

// Síncrono: uma ida e volta devolve o URL, com o tempo limite alargado para 300 segundos
const res = await client.images.generate({
  model: 'img-std-1',
  prompt: 'uma rua cyberpunk à chuva de noite, reflexos de néon',
  size: '1792x1024',
  n: 1,
})

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

A via assíncrona obriga a encadear envio e sondagem, em 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
}

// Submeter e aguardar a conclusão: sondar de 3 em 3 segundos e desistir ao fim de 10 minutos
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 || 'falha na geração')
    await new Promise((r) => setTimeout(r, 3000))
  }
  throw new Error('tempo de espera esgotado')
}

generateImage('uma rua cyberpunk à chuva de noite, reflexos de néon').then(console.log)

Python (aqui com vídeo e um intervalo de sondagem maior):

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})

    # O vídeo costuma demorar 1 a 5 minutos; sondar de 5 em 5 segundos chega, e mais depressa só consome 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 "falha na geração")
        time.sleep(5)
    raise TimeoutError("tempo de espera esgotado")


print(generate_video("travelling lento para a frente, uma rapariga volta-se e sorri"))