---
updatedAt: 2026-04-22T20:51:05.000Z
agentTools:
  projectIndex: https://docs.zype.com/llms.txt
---

# Get AI Metadata

Retrieve a specific AI metadata session for a video

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Platform",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "https://api.zype.com/"
    }
  ],
  "security": [
    {
      "api_key": []
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "api_key",
        "in": "query"
      }
    }
  },
  "paths": {
    "/videos/{id}/ai_metadata/suggestions/{session_id}": {
      "get": {
        "tags": [
          "Videos"
        ],
        "summary": "Get AI Metadata",
        "description": "Retrieve a specific AI metadata session for a video",
        "operationId": "getAIMetadata",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID of video",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "session_id",
            "in": "path",
            "description": "ID of the AI metadata session",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "title": "AIMetadataGetResponse",
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "description": "Video or AI metadata session not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1app/get/responses/404/content/application~1json/schema"
                }
              }
            }
          }
        },
        "deprecated": false
      }
    },
    "/app": {
      "get": {
        "summary": "View App",
        "tags": [
          "Apps"
        ],
        "operationId": "getApp",
        "parameters": [
          {
            "name": "app_key",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "App key provided by Zype"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "title": "AppResponse",
                  "type": "object",
                  "properties": {
                    "response": {
                      "type": "object",
                      "title": "App",
                      "properties": {
                        "_id": {
                          "type": "string"
                        },
                        "active": {
                          "type": "boolean"
                        },
                        "app_type_id": {
                          "type": "string"
                        },
                        "device_ids": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "site_id": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "version": {
                          "type": "string"
                        },
                        "store_icon_url": {
                          "type": "string"
                        }
                      },
                      "example": {
                        "_id": "593b1ac8830ece0024000005",
                        "active": false,
                        "app_type_id": "1593030e94d740d00530000971",
                        "device_ids": [
                          "593030d64d740d0053000007"
                        ],
                        "site_id": "593031674d740d01cd000000",
                        "title": "Apple TV App",
                        "version": "0.1.0",
                        "store_icon_url": "https:/url"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "App not found",
            "content": {
              "application/json": {
                "schema": {
                  "title": "NotFound",
                  "type": "object",
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```