These docs are for v2.0. Click to read the latest docs for v3.0.

Check Token-type Status

This guide explains how to check the status of a token-type (NFT template) creation.

This endpoint is used to check the status of a token-type creation. The {creationId} is passed in the path for tracking the status of token-type creation. It can be found in the response body of the create token-type endpoint as result.id.

Request Endpoint: reference

GET /api/v2/token-types/creations/{creationId}

Example Request

GET /api/v2/token-types/creations/20bd87e9-c590-47fb-a3e3-679673556e6b

Response Body

📘

In the response body look for the result.status parameter. It can have three possible values:

  • SUCCEEDED
  • PENDING
  • FAILED
{
  "success": true,
  "result": {
    "id": "20bd87e9-c590-47fb-a3e3-679673556e6b",
    "status": "SUCCEEDED",
    "transactionHash": "0x53a8b49e6f753d0b5abc026a8027677a4612a48fd7f3476f5d09295efe87da97",
    "tokenTypeId": 9,
    "mints": [],
    "metadata": {
      "name": "NFT with a video",
      "description": "This NFT has a video",
      "image": "https://static.scientificamerican.com/sciam/cache/file/C91AC5AA-1F28-41E7-8E40EC59E66937D8_source.jpg?w=590&h=800&2113BA5E-A58F-4A28-ABDD0BE5C759F5B6",
      "imagePreview": "https://static.scientificamerican.com/sciam/cache/file/C91AC5AA-1F28-41E7-8E40EC59E66937D8_source.jpg?w=590&h=800&2113BA5E-A58F-4A28-ABDD0BE5C759F5B6",
      "imageThumbnail": "https://static.scientificamerican.com/sciam/cache/file/C91AC5AA-1F28-41E7-8E40EC59E66937D8_source.jpg?w=590&h=800&2113BA5E-A58F-4A28-ABDD0BE5C759F5B6",
      "animationUrl": "https://player.vimeo.com/external/314181352.sd.mp4?s=d2cd7a37f6250cd543e6d13209730b4bcf242130&profile_id=164&oauth2_token_id=57447761",
      "animation_url": "https://player.vimeo.com/external/314181352.sd.mp4?s=d2cd7a37f6250cd543e6d13209730b4bcf242130&profile_id=164&oauth2_token_id=57447761",
      "externalUrl": "www.venly.io",
      "external_url": "www.venly.io",
      "animationUrls": [
        {
          "type": "video",
          "value": "https://player.vimeo.com/external/314181352.sd.mp4?s=d2cd7a37f6250cd543e6d13209730b4bcf242130&profile_id=164&oauth2_token_id=57447761"
        }
      ],
      "attributes": [
        {
          "type": "system",
          "name": "tokenTypeId",
          "value": "9",
          "traitType": "Token Type ID",
          "trait_type": "Token Type ID"
        }
      ],
      "contract": {
        "address": "0xf5b11b4f458cc12a7989a146c5db2e7d500e2241",
        "name": "Test",
        "symbol": "TE",
        "image": "string",
        "imageUrl": "string",
        "image_url": "string",
        "description": "Testing",
        "externalLink": "www.venly.io",
        "external_link": "www.venly.io",
        "externalUrl": "www.venly.io",
        "external_url": "www.venly.io",
        "media": [],
        "type": "ERC_1155"
      },
      "fungible": false
    }
  }
}