API Animacji

Endpointy do odkrywania dostępnych animacji i stosowania ich do postaci z riggingiem.

POST/openapi/v1/animations

Utwórz zadanie animacji

Ten punkt końcowy umożliwia utworzenie nowego zadania w celu zastosowania określonej akcji animacji do postaci, dla której wcześniej wykonano rigging. Obejmuje opcje przetwarzania końcowego.

Parametry

  • Name
    rig_task_id
    Type
    string
    Wymagane
    Description

    id pomyślnie ukończonego zadania riggingu (z POST /openapi/v1/rigging). Postać z tego zadania zostanie animowana.

  • Name
    action_id
    Type
    integer
    Wymagane
    Description

    Identyfikator akcji animacji do zastosowania. Pełną listę dostępnych animacji znajdziesz w Informacjach referencyjnych Biblioteki animacji.

  • Name
    post_process
    Type
    object
    Description

    Opcjonalne przetwarzanie końcowe danych wyjściowych animacji. Pomiń je, aby otrzymać standardowe pliki animacji.

Dotyczy tylko gdy post_process is set
  • Name
    operation_type
    Type
    string
    Wymagane
    Description

    Typ operacji do wykonania. Dostępne wartości: change_fps, fbx2usdz, extract_armature.

  • Name
    fps
    Type
    integer
    domyślne 30
    Description

    Docelowa liczba klatek na sekundę. Ma zastosowanie tylko wtedy, gdy operation_type to change_fps. Dozwolone wartości: 24, 25, 30, 60.

Zwraca

Właściwość result odpowiedzi zawiera id zadania nowo utworzonego zadania animacji.

Tryby niepowodzenia

  • Name
    400 - Bad Request
    Description

    Żądanie było niedopuszczalne. Typowe przyczyny:

    • Brakujący parametr: brakuje rig_task_id lub action_id.
    • Nieprawidłowe zadanie riggingu: rig_task_id jest nieprawidłowe albo odnosi się do zadania zakończonego niepowodzeniem/nieistniejącego.
    • Nieprawidłowy identyfikator akcji: action_id nie odpowiada prawidłowej animacji.
  • Name
    401 - Unauthorized
    Description

    Uwierzytelnianie nie powiodło się. Sprawdź swój klucz API.

  • Name
    402 - Payment Required
    Description

    Niewystarczające kredyty do wykonania tego zadania.

  • Name
    404 - Not Found
    Description

    Nie znaleziono zadania riggingu określonego przez rig_task_id.

  • Name
    429 - Too Many Requests
    Description

    Przekroczono limit szybkości.

Request

POST
/openapi/v1/animations
# Animate a rigged model with required params only
curl https://api.meshy.ai/openapi/v1/animations \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "rig_task_id": "018b314a-a1b5-716d-c222-2f1776f7f579",
    "action_id": 92
  }'

# With post-processing to change FPS
curl https://api.meshy.ai/openapi/v1/animations \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "rig_task_id": "018b314a-a1b5-716d-c222-2f1776f7f579",
    "action_id": 92,
    "post_process": {
      "operation_type": "change_fps",
      "fps": 24
    }
  }'

Response

{
  "result": "018c425b-b2c6-727e-d333-3c1887i9h791"
}
GET/openapi/v1/animations/:id

Pobieranie zadania Animacja

Ten punkt końcowy pozwala pobrać zadanie animacji na podstawie prawidłowego id zadania. Zobacz Obiekt zadania Animacja, aby sprawdzić, które właściwości są uwzględnione.

Parametry

  • Name
    id
    Type
    path
    Description

    Unikalny identyfikator zadania animacji do pobrania.

Zwracane dane

Odpowiedź zawiera obiekt zadania Animacja. Szczegóły znajdziesz w sekcji Obiekt zadania Animacja.

Request

GET
/openapi/v1/animations/018c425b-b2c6-727e-d333-3c1887i9h791
curl https://api.meshy.ai/openapi/v1/animations/018c425b-b2c6-727e-d333-3c1887i9h791 
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "type": "animate",
  "status": "SUCCEEDED",
  "created_at": 1747032440896,
  "progress": 100,
  "started_at": 1747032441210,
  "finished_at": 1747032457530,
  "expires_at": 1747291657530,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3,
  "result": {
    "animation_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/Animation_Reaping_Swing_withSkin.glb?Expires=...",
    "animation_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/Animation_Reaping_Swing_withSkin.fbx?Expires=...",
    "processed_usdz_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/processed.usdz?Expires=...",
    "processed_armature_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/processed_armature.fbx?Expires=...",
    "processed_animation_fps_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/processed_60fps.fbx?Expires=..."
  },
  "preceding_tasks": 0
}
DELETE/openapi/v1/animations/:id

Usuń zadanie Animacji

Ten punkt końcowy trwale usuwa zadanie Animacji, w tym wszystkie powiązane modele i dane. Ta czynność jest nieodwracalna.

Parametry ścieżki

  • Name
    id
    Type
    path
    Description

    Identyfikator zadania Animacji do usunięcia.

Zwraca

Zwraca 200 OK w przypadku powodzenia.

Request

DELETE
/openapi/v1/animations/018b314a-a1b5-716d-c222-2f1776f7f579
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/animations/018b314a-a1b5-716d-c222-2f1776f7f579 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.
GET/openapi/v1/animations/:id/stream

Strumieniuj zadanie Animacja

Ten punkt końcowy strumieniuje aktualizacje w czasie rzeczywistym dla zadania Animacja za pomocą Server-Sent Events (SSE).

Parametry

  • Name
    id
    Type
    path
    Description

    Unikalny identyfikator zadania Animacja do strumieniowania.

Zwraca

Zwraca strumień obiektów zadań Animacja jako Server-Sent Events.

W przypadku zadań PENDING lub IN_PROGRESS strumień odpowiedzi będzie zawierał tylko niezbędne pola progress i status.

Request

GET
/openapi/v1/animations/018c425b-b2c6-727e-d333-3c1887i9h791/stream
curl -N https://api.meshy.ai/openapi/v1/animations/018c425b-b2c6-727e-d333-3c1887i9h791/stream 
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: { // Example of a SUCCEEDED task stream item, mirroring The Animation Task Object structure
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "type": "animate",
  "status": "SUCCEEDED",
  "created_at": 1747032440896,
  "progress": 100,
  "started_at": 1747032441210,
  "finished_at": 1747032457530,
  "expires_at": 1747291657530,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3,
  "result": {
    "animation_glb_url": "https://assets.meshy.ai/.../Animation_Reaping_Swing_withSkin.glb?...",
    "animation_fbx_url": "https://assets.meshy.ai/.../Animation_Reaping_Swing_withSkin.fbx?...",
    "processed_usdz_url": "https://assets.meshy.ai/.../processed.usdz?...",
    "processed_armature_fbx_url": "https://assets.meshy.ai/.../processed_armature.fbx?...",
    "processed_animation_fps_fbx_url": "https://assets.meshy.ai/.../processed_60fps.fbx?..."
  },
  "preceding_tasks": 0
}

Obiekt zadania Animacji

Obiekt zadania Animacji reprezentuje jednostkę pracy służącą do zastosowania animacji do postaci z przypisanym szkieletem.

Właściwości

  • Name
    id
    Type
    string
    Description

    Unikalny identyfikator zadania.

  • Name
    type
    Type
    string
    Description

    Typ zadania Animacja. Wartość to animate.

  • Name
    status
    Type
    string
    Description

    Status zadania. Możliwe wartości: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    progress zadania (0-100).

  • Name
    created_at
    Type
    timestamp
    Description

    Znacznik czasu (w milisekundach od epoki), kiedy zadanie zostało utworzone.

    Znacznik czasu reprezentuje liczbę milisekund, które upłynęły od 1 stycznia 1970 UTC, zgodnie ze standardem RFC 3339. Na przykład piątek, 1 września 2023 12:00:00 PM GMT jest reprezentowany jako 1693569600000. Dotyczy to wszystkich znaczników czasu w Meshy API.

  • Name
    started_at
    Type
    timestamp
    Description

    Znacznik czasu (w milisekundach od epoki), kiedy zadanie rozpoczęło przetwarzanie. 0, jeśli nie rozpoczęto.

  • Name
    finished_at
    Type
    timestamp
    Description

    Znacznik czasu (w milisekundach od epoki), kiedy zadanie zostało zakończone. 0, jeśli nie zakończono.

  • Name
    expires_at
    Type
    timestamp
    Description

    Znacznik czasu (w milisekundach od epoki), kiedy wygasają assety wynikowe zadania.

  • Name
    task_error
    Type
    object
    Description

    Szczegóły błędu dla nieudanych zadań. Zobacz Błędy, aby uzyskać pełną referencję obiektu task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

    Liczba kredytów zużytych przez to zadanie. Obecne, gdy status zadania to PENDING, IN_PROGRESS lub SUCCEEDED. Zwraca 0 dla zadań FAILED (kredyty są zwracane w przypadku niepowodzenia).

  • Name
    result
    Type
    object
    Description

    Zawiera adresy URL animacji wyjściowej, jeśli zadanie SUCCEEDED.

    • Name
      animation_glb_url
      Type
      string
      Description
      Adres URL do pobrania animacji w formacie GLB.
    • Name
      animation_fbx_url
      Type
      string
      Description
      Adres URL do pobrania animacji w formacie FBX.
    • Name
      processed_usdz_url
      Type
      string
      Description
      Adres URL do pobrania przetworzonej animacji w formacie USDZ.
    • Name
      processed_armature_fbx_url
      Type
      string
      Description
      Adres URL do pobrania przetworzonej armatury w formacie FBX.
    • Name
      processed_animation_fps_fbx_url
      Type
      string
      Description
      Adres URL do pobrania animacji ze zmienionym FPS w formacie FBX (np. jeśli użyto operacji change_fps).
  • Name
    preceding_tasks
    Type
    integer
    Description

    Liczba poprzedzających zadań w kolejce. Ma znaczenie tylko, jeśli status to PENDING.

Example Animation Task Object

{
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "type": "animate",
  "status": "SUCCEEDED",
  "created_at": 1747032440896,
  "progress": 100,
  "started_at": 1747032441210,
  "finished_at": 1747032457530,
  "expires_at": 1747291657530,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3,
  "result": {
    "animation_glb_url": "https://assets.meshy.ai/.../Animation_Reaping_Swing_withSkin.glb?...",
    "animation_fbx_url": "https://assets.meshy.ai/.../Animation_Reaping_Swing_withSkin.fbx?...",
    "processed_usdz_url": "https://assets.meshy.ai/.../processed.usdz?...",
    "processed_armature_fbx_url": "https://assets.meshy.ai/.../processed_armature.fbx?...",
    "processed_animation_fps_fbx_url": "https://assets.meshy.ai/.../processed_60fps.fbx?..."
  },
  "preceding_tasks": 0
}