All Products
Search

This Product

    Intelligent Media Services:SubmitVideoCognitionJob

    Document Center

    Intelligent Media Services:SubmitVideoCognitionJob

    Last Updated:Dec 23, 2025

    Submits a video for AI analysis and processing.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • For mandatory resource types, indicate with a prefix of * .
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    ice:SubmitVideoCognitionJobcreate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    TitlestringYes

    The video title. It supports letters, digits, and hyphens (-), and cannot start with a special character. Max length: 256 bytes.

    		example-title-****
    ParamsstringNo

    Additional request parameters, provided as a JSON string. This is used to pass specific settings for various AI analysis modules, such as Natural Language Processing (NLP), shot segmentation, tagging, and action recognition.

    		{ "nlpParams": { "sourceLanguage": "cn", "diarizationEnabled": true, "speakerCount": 2, "summarizationEnabled": true, "summarizationTypes": "Paragraph,Conversational,QuestionsAnswering,MindMap", "translationEnabled": true, "targetLanguages": "en", "autoChaptersEnabled": true, "meetingAssistanceEnabled": true } }
    UserDatastringNo

    The user-defined data that is passed through and returned as-is in the response. Max length: 1,024 bytes.

    		{"test":1}
    InputobjectYes

    The media input object.

    TypestringNo

    The type of media input. Valid values:

    • OSS
    • Media
    • URL
    		Media
    MediastringNo

    If Type is set to OSS, specify an OSS path. Example: OSS://test-bucket/video/202208/test.mp4.

    If Type is set to Media, specify a media asset ID. Example: c5c62d8f0361337cab312dce8e77dc6d.

    If Type is set to URL, specify an HTTP URL. Example: https://zc-test.oss-cn-shanghai.aliyuncs.com/test/unknowFace.mp4.

    		c5c62d8f03613************c6d
    TemplateIdstringNo

    The ID of the template that specifies the analysis algorithms to be used. For details, see CreateCustomTemplate and smart tagging template.

    		39f8e0bc00***************

    nlpParams

    FeatureParameterTypeRequiredDescriptionExample
    nlpParamsobjectYesAn object containing all NLP-related parameters. This field is required if the analysis template includes the NLP type.{"sourceLanguage":"cn"}
    TranscriptionsourceLanguagestringYesThe source language for transcription. Valid values: cn (Mandarin), en (English), yue (Cantonese), fspk (Chinese and English)."cn"
    diarizationEnabledbooleanNoSpecifies whether to enable speaker diarization. Default value: false.true
    speakerCountintegerNoSpecifies the number of speakers for diarization. If this parameter is not specified, the speakers are not recognized. Valid values: 0: an arbitrary number of speakers. 2: two speakers.2
    SummarizationsummarizationEnabledbooleanNoSpecifies whether to enable summarization, which can generate full-text summaries, speaker summaries, and more.true
    summarizationTypesstringNoSpecify the desired summary types. Valid values: Paragraph (full-text summary), Conversational (speaker summary), QuestionsAnswering (Q&A), and MindMap."Paragraph,Conversational,QuestionsAnswering,MindMap"
    TranslationtranslationEnabledbooleanNoSpecifies whether to enable translation.true
    targetLanguagesstringNoThe target languages for translation. Valid values: cn (Mandarin), en (English), yue (Cantonese), fspk (Chinese and English)."en,cn"
    Chapter generationautoChaptersEnabledbooleanNoSpecifies whether to enable chapter generation. The output includes chapter titles and summaries.true
    AI minutesmeetingAssistanceEnabledbooleanNoSpecifies whether to enable AI minutes. The output includes topic classification, keywords, key sentences, and to-do list.true

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		******11-DB8D-4A9A-875B-275798******
    JobIdstring

    The task ID.

    		****20b48fb04483915d4f2cd8ac****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****20b48fb04483915d4f2cd8ac****"
}

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2025-11-17The request parameters of the API has changedView Change Details