Naar inhoud springen
API-referentie
API-referentie

Grok Imagine afbeelding naar video

Animeer een stilstaand beeld tot een korte clip met de Grok Imagine-videomodellen van xAI.

Markdown bekijken
01

Overzicht

Gebruik het eindpunt voor afbeelding naar video met een ondersteund model. Gebruik de geretourneerde taak-ID om de status op te halen, of geef callback_url op voor de hieronder gedocumenteerde leveringen.

Snelstart

  1. Maak een API-sleutel aan en stel deze in als RUNAPI_API_KEY.
  2. Kies een ondersteund model en stuur een POST-verzoek waarvan de body overeenkomt met het schema van dat model.
  3. Sla de geretourneerde taak-ID op en poll vervolgens totdat een eindstatus is bereikt, of verwerk de hieronder gedocumenteerde callbacks.

Eindpunt

POST /api/v1/grok_imagine/image_to_video
Basis-URL
https://runapi.ai
API-versie
v1
Authenticatie
Authorization: Bearer YOUR_API_TOKEN
02

Ondersteunde modellen

Open een modelpagina voor actuele prijzen, snelheidslimieten en details over commercieel gebruik.

03

Verzoekschema

JSON-body

Velden en toegestane waarden zijn afhankelijk van het geselecteerde model. Indien opgegeven, ontvangt callback_url de hieronder gedocumenteerde taakaflevering.

grok-imagine-image-to-video11 velden
aspect_ratiostring
Optioneel

Uitvoer-beeldverhouding.

Toegestane waarden: 2:3, 3:2, 1:1, 16:9, 9:16
callback_urlstring
Optioneel

Webhook-URL voor definitieve taaklevering.

duration_secondsinteger
Optioneel

Uitvoerduur in seconden.

Bereik: 6 - 30
enable_safety_checkerboolean
Optioneel

Controles op inhoudsbeveiliging inschakelen.

indexinteger
Optioneel

Op nul gebaseerde bronafbeeldingsindex; alleen gebruikt met source_task_id.

Bereik: 0 - 1
modelstring
Verplicht

Model-slug.

motion_stylestring
Optioneel

Videobewegingsstijl; spicy vereist source_task_id.

Toegestane waarden: fun, normal, spicy
output_resolutionstring
Optioneel

Uitvoerresolutie.

Toegestane waarden: 480p, 720p Standaard: 480p
promptstring
Optioneel

Optionele prompt voor het genereren van video.

Grens: 5000
source_image_urlstring
Optioneel

Publieke bronafbeeldings-URL; geef dit of source_task_id op, maar niet beide.

source_task_idstring
Optioneel

Vorige Grok Imagine tekst-naar-afbeelding-taak-ID; geef dit of source_image_url op, maar niet beide.

grok-imagine-video-1.5-fast8 velden
aspect_ratiostring
Optioneel

Uitvoer-beeldverhouding.

Toegestane waarden: 1:1, 16:9, 9:16, 3:2, 2:3
callback_urlstring
Optioneel

Webhook-URL voor definitieve taaklevering.

duration_secondsinteger
Optioneel

Uitvoerduur in seconden.

Standaard: 8 Bereik: 1 - 30
modelstring
Verplicht

Model-slug.

output_resolutionstring
Optioneel

Uitvoerresolutie.

Toegestane waarden: 480p, 720p Standaard: 480p
promptstring
Optioneel

Optionele prompt voor het genereren van video.

Grens: 5000
reference_image_urlsarray
Optioneel

Publieke referentieafbeeldings-URL's.

source_image_urlstring
Verplicht

Publieke bronafbeeldings-URL.

grok-imagine-video-1.5-preview8 velden
aspect_ratiostring
Optioneel

Uitvoer-beeldverhouding.

Toegestane waarden: 1:1, 16:9, 9:16, 3:2, 2:3, auto Standaard: auto
callback_urlstring
Optioneel

Webhook-URL voor definitieve taaklevering.

duration_secondsinteger
Optioneel

Uitvoerduur in seconden.

Standaard: 8 Bereik: 1 - 15
modelstring
Verplicht

Model-slug.

output_resolutionstring
Optioneel

Uitvoerresolutie.

Toegestane waarden: 480p, 720p, 1080p Standaard: 480p
promptstring
Optioneel

Optionele prompt voor het genereren van video.

Bereik: 1 - 4096
reference_image_urlsarray
Optioneel

Aanvullende openbare URL's van referentieafbeeldingen; de bronafbeelding plus referenties mogen in totaal zeven afbeeldingen omvatten.

Itemlimiet: 6
source_image_urlstring
Verplicht

Publieke bronafbeeldings-URL.

Voorwaardelijke regels

Deze vereisten zijn van toepassing wanneer alle vermelde voorwaarden overeenkomen.

  1. Wanneer model = grok-imagine-image-to-video
    Vereist
    Niet geaccepteerd
    reference_image_urls
  2. Wanneer model = grok-imagine-video-1.5-fast
    Vereist
    Niet geaccepteerd
    source_task_id, index, motion_style, enable_safety_checker
  3. Wanneer model = grok-imagine-video-1.5-preview
    Vereist
    Niet geaccepteerd
    source_task_id, index, motion_style, enable_safety_checker
04

Acceptatie aanmaken

HTTP 202

POST /api/v1/grok_imagine/image_to_video

Responsschema
JSON 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "processing"
      ],
      "type": "string"
    },
    "task_replayed": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "status"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "id": "tsk_reference_demo",
  "status": "processing"
}
05

Pollen bezig

HTTP 200

GET /api/v1/grok_imagine/image_to_video/:id

Responsschema
JSON 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "processing"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "id": "tsk_reference_demo",
  "status": "processing"
}
06

Pollen voltooid

HTTP 200

GET /api/v1/grok_imagine/image_to_video/:id

Responsschema
JSON 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    },
    "usage": {
      "properties": {
        "cost": {
          "type": "number"
        }
      },
      "required": [
        "cost"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "videos": {
      "items": {
        "properties": {
          "url": {
            "type": "string",
            "x-runapi-generated-media": true
          }
        },
        "required": [
          "url"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    }
  },
  "required": [
    "id",
    "status",
    "videos",
    "usage"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "id": "tsk_reference_demo",
  "status": "completed",
  "usage": {
    "cost": 0.05
  },
  "videos": [
    {
      "url": "https://file.runapi.ai/reference-video.mp4"
    }
  ]
}
07

Pollen mislukt

HTTP 200

GET /api/v1/grok_imagine/image_to_video/:id

Responsschema
JSON 
{
  "properties": {
    "error": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "Task processing failed.",
  "id": "tsk_reference_demo",
  "status": "failed"
}
08

Callback van klant: voltooid

HTTP 200

POST callback_url

Responsschema
JSON 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    },
    "usage": {
      "properties": {
        "cost": {
          "type": "number"
        }
      },
      "required": [
        "cost"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "videos": {
      "items": {
        "properties": {
          "url": {
            "type": "string",
            "x-runapi-generated-media": true
          }
        },
        "required": [
          "url"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    }
  },
  "required": [
    "id",
    "status",
    "videos",
    "usage"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "id": "tsk_reference_demo",
  "status": "completed",
  "usage": {
    "cost": 0.05
  },
  "videos": [
    {
      "url": "https://file.runapi.ai/reference-video.mp4"
    }
  ]
}
09

Callback van klant: mislukt

HTTP 200

POST callback_url

Responsschema
JSON 
{
  "properties": {
    "error": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "properties": {
            "code": {
              "type": "string"
            },
            "limit_cents": {
              "type": "integer"
            },
            "message": {
              "type": "string"
            },
            "reset_at": {
              "format": "date-time",
              "type": [
                "string",
                "null"
              ]
            },
            "used_cents": {
              "type": "integer"
            },
            "window": {
              "enum": [
                "1h",
                "1d",
                "7d",
                "daily",
                "weekly",
                "monthly",
                "lifetime"
              ],
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object",
          "unevaluatedProperties": false
        }
      ]
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": {
    "code": "generation_failed",
    "message": "Task processing failed."
  },
  "id": "tsk_reference_demo",
  "status": "failed"
}
10

Fouten

HTTP 401

POST /api/v1/grok_imagine/image_to_video

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "Authentication required"
}
11

Fouten

HTTP 401

GET /api/v1/grok_imagine/image_to_video/:id

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "Authentication required"
}
12

Fouten

HTTP 400

POST /api/v1/grok_imagine/image_to_video

Responsschema
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Leesbare foutmelding.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Leesbare validatiesamenvatting.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Validatieberichten gekoppeld aan het openbare aanvraagveld, met een reeks leesbare tekenreeksen per veld.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Responsvoorbeeld

JSON 
{
  "error": "model must be one of: grok-imagine-image-to-video, grok-imagine-video-1.5-fast, grok-imagine-video-1.5-preview"
}
13

Fouten

HTTP 402

POST /api/v1/grok_imagine/image_to_video

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "Insufficient balance"
}
14

Fouten

HTTP 429

POST /api/v1/grok_imagine/image_to_video

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "API key credit limit exceeded"
}
15

Fouten

HTTP 409

POST /api/v1/grok_imagine/image_to_video

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "The request uses features that are not supported for the selected model"
}
16

Fouten

HTTP 429

POST /api/v1/grok_imagine/image_to_video

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "Rate limit reached. Please retry later."
}
17

Fouten

HTTP 503

POST /api/v1/grok_imagine/image_to_video

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "Service under maintenance, please try again later"
}
18

Fouten

HTTP 504

POST /api/v1/grok_imagine/image_to_video

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "The request timed out"
}
19

Fouten

HTTP 404

GET /api/v1/grok_imagine/image_to_video/:id

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "Task with id 'tsk_reference_demo' not found"
}
20

Gegenereerde codevoorbeelden

Gebruik cURL rechtstreeks, of installeer een SDK voor uw taal. Elk voorbeeld dient het gevalideerde verzoek in dat in deze referentie wordt getoond.

Installeren

Shell 
pip install runapi-grok-imagine
PYTHON 
import os
from runapi.grok_imagine import GrokImagineClient

client = GrokImagineClient(api_key=os.environ["RUNAPI_API_KEY"])
task = client.image_to_video.create(
  model="grok-imagine-video-1.5-preview",
  source_image_url="https://cdn.runapi.ai/public/samples/first-frame.jpg",
  prompt="The camera slowly moves forward."
)