Skip to main content
Call this API to create a document or folder in a Knowledge Base.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/doc/workspaces/{workspaceId}/docs
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app
Permissionspermission-Document.WorkspaceDocument.Write-Knowledge Base document write permission

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of an enterprise authorized to a third-party app API.

Path parameters

NameTypeRequiredDescription
workspaceIdStringYesThe Knowledge Base ID. Obtain the value of the workspaceId field by calling the Create a Knowledge Base API or the Get the Knowledge Base list API.

Request body

NameTypeRequiredDescription
nameStringYesThe document name.
docTypeStringYesThe document type. Valid values: - DOC: Document - WORKBOOK: Spreadsheet - MIND: Mind Map - FOLDER: Folder
operatorIdStringYesThe unionId of the user. Obtain it by calling the Query user details API.
parentNodeIdStringNoThe parent node ID. Obtain the value of the DentryModel parameter by calling the Get the node list API. If not specified, the document is created in the root directory by default. The parent node can be a folder or a regular document.
templateIdStringNoThe document template ID.
templateTypeStringNoThe document template type. Valid values: - public_template: Recommends - team_template: Team template - user_template: Personal template

Request example

HTTP
POST /v1.0/doc/workspaces/YRBGvyxxx/docs HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:7dc9ecxxx
Content-Type:application/json

{
  "name" : "Document",
  "docType" : "DOC",
  "operatorId" : "Q2xwPOxxx",
  "parentNodeId" : "YRBGv0Ye",
  "templateId" : "123243",
  "templateType" : "team_template"
}
Java
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * Initialize the account client using a token
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkdoc_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkdoc_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_1_0.models.CreateWorkspaceDocHeaders createWorkspaceDocHeaders = new com.aliyun.dingtalkdoc_1_0.models.CreateWorkspaceDocHeaders();
        createWorkspaceDocHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.CreateWorkspaceDocRequest createWorkspaceDocRequest = new com.aliyun.dingtalkdoc_1_0.models.CreateWorkspaceDocRequest()
                .setName("Document")
                .setDocType("DOC")
                .setOperatorId("Q2xwPOxxx")
                .setParentNodeId("YRBGv0Ye")
                .setTemplateId("123243")
                .setTemplateType("team_template");
        try {
            client.createWorkspaceDocWithOptions("YRBGvyxxx", createWorkspaceDocRequest, createWorkspaceDocHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // The err contains the code and message attributes, which help you locate the issue
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // The err contains the code and message attributes, which help you locate the issue
            }

        }        
    }
}
Python
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys

from typing import List

from alibabacloud_dingtalk.doc_1_0.client import Client as dingtalkdoc_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_1_0 import models as dingtalkdoc__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkdoc_1_0Client:
        """
        Initialize the account client using a token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkdoc_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_workspace_doc_headers = dingtalkdoc__1__0_models.CreateWorkspaceDocHeaders()
        create_workspace_doc_headers.x_acs_dingtalk_access_token = '<your access token>'
        create_workspace_doc_request = dingtalkdoc__1__0_models.CreateWorkspaceDocRequest(
            name='Document',
            doc_type='DOC',
            operator_id='Q2xwPOxxx',
            parent_node_id='YRBGv0Ye',
            template_id='123243',
            template_type='team_template'
        )
        try:
            client.create_workspace_doc_with_options('YRBGvyxxx', create_workspace_doc_request, create_workspace_doc_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err contains the code and message attributes, which help you locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_workspace_doc_headers = dingtalkdoc__1__0_models.CreateWorkspaceDocHeaders()
        create_workspace_doc_headers.x_acs_dingtalk_access_token = '<your access token>'
        create_workspace_doc_request = dingtalkdoc__1__0_models.CreateWorkspaceDocRequest(
            name='Document',
            doc_type='DOC',
            operator_id='Q2xwPOxxx',
            parent_node_id='YRBGv0Ye',
            template_id='123243',
            template_type='team_template'
        )
        try:
            await client.create_workspace_doc_with_options_async('YRBGvyxxx', create_workspace_doc_request, create_workspace_doc_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err contains the code and message attributes, which help you locate the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
PHP
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateWorkspaceDocHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateWorkspaceDocRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account client using a token
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $createWorkspaceDocHeaders = new CreateWorkspaceDocHeaders([]);
        $createWorkspaceDocHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $createWorkspaceDocRequest = new CreateWorkspaceDocRequest([
            "name" => "Document",
            "docType" => "DOC",
            "operatorId" => "Q2xwPOxxx",
            "parentNodeId" => "YRBGv0Ye",
            "templateId" => "123243",
            "templateType" => "team_template"
        ]);
        try {
            $client->createWorkspaceDocWithOptions("YRBGvyxxx", $createWorkspaceDocRequest, $createWorkspaceDocHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // The err contains the code and message attributes, which help you locate the issue
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
Go
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkdoc_1_0  "github.com/alibabacloud-go/dingtalk/doc_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

/**
 * Initialize the account client using a token
 * @return Client
 * @throws Exception
 */
func CreateClient () (_result *dingtalkdoc_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkdoc_1_0.Client{}
  _result, _err = dingtalkdoc_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  createWorkspaceDocHeaders := &dingtalkdoc_1_0.CreateWorkspaceDocHeaders{}
  createWorkspaceDocHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  createWorkspaceDocRequest := &dingtalkdoc_1_0.CreateWorkspaceDocRequest{
    Name: tea.String("Document"),
    DocType: tea.String("DOC"),
    OperatorId: tea.String("Q2xwPOxxx"),
    ParentNodeId: tea.String("YRBGv0Ye"),
    TemplateId: tea.String("123243"),
    TemplateType: tea.String("team_template"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CreateWorkspaceDocWithOptions(tea.String("YRBGvyxxx"), createWorkspaceDocRequest, createWorkspaceDocHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // The err contains the code and message attributes, which help you locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkdoc_1_0, * as $dingtalkdoc_1_0 from '@alicloud/dingtalk/doc_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

  /**
   * Initialize the account client using a token
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkdoc_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkdoc_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let createWorkspaceDocHeaders = new $dingtalkdoc_1_0.CreateWorkspaceDocHeaders({ });
    createWorkspaceDocHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let createWorkspaceDocRequest = new $dingtalkdoc_1_0.CreateWorkspaceDocRequest({
      name: "Document",
      docType: "DOC",
      operatorId: "Q2xwPOxxx",
      parentNodeId: "YRBGv0Ye",
      templateId: "123243",
      templateType: "team_template",
    });
    try {
      await client.createWorkspaceDocWithOptions("YRBGvyxxx", createWorkspaceDocRequest, createWorkspaceDocHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // The err contains the code and message attributes, which help you locate the issue
      }

    }    
  }

}

Client.main(process.argv.slice(2));
C#
// This file is auto-generated, don't edit it. Thanks.

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /**
         * Initialize the account client using a token
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkdoc_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdoc_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateWorkspaceDocHeaders createWorkspaceDocHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateWorkspaceDocHeaders();
            createWorkspaceDocHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateWorkspaceDocRequest createWorkspaceDocRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateWorkspaceDocRequest
            {
                Name = "Document",
                DocType = "DOC",
                OperatorId = "Q2xwPOxxx",
                ParentNodeId = "YRBGv0Ye",
                TemplateId = "123243",
                TemplateType = "team_template",
            };
            try
            {
                client.CreateWorkspaceDocWithOptions("YRBGvyxxx", createWorkspaceDocRequest, createWorkspaceDocHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err contains the code and message attributes, which help you locate the issue
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err contains the code and message attributes, which help you locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
workspaceIdStringThe Knowledge Base ID.
nodeIdStringThe Knowledge Base document ID.
docKeyStringThe document docKey.
urlStringThe document URL.
dentryUuidStringThe UUID of the returned file.

Response example

HTTP/1.1 200 OK
Content-Type:application/json

{
  "workspaceId" : "YRBGvy",
  "nodeId" : "YRBGv0Ye",
  "docKey" : "QoJGq7xxx",
  "url" : "https://xxx/workspaceId/docs/nodeId",
  "dentryUuid" : "ydxXB52LJqqK7xxNTX*****697"
}

Error codes

If an error is returned when you call this API, refer to the Global error codes document for solutions based on the error message.
HttpCodeError codeError messageDescription
400invalidRequest.workspaceNode.nameConflictKnowledge Base document name conflictKnowledge Base document name conflict.
400invalidRequest.inputArgs.invalidMethod parameter validation failedMethod parameter validation failed. Check whether any required parameters are missing or whether the unionId is valid.
400invalidRequest.workspaceNode.parentNotFoundParent node does not existParent node does not exist.
400invalidRequest.template.notFoundDocument template does not existDocument template does not exist.
403forbidden.user.notInOrgThe operator is not in the organizationThe operator is not in the organization.
403forbidden.accessDeniedThe user does not have operation permissionsThe user does not have operation permissions.
404invalidRequest.resource.notFoundResource not foundResource not found.
404invalidRequest.workspace.deletedThe Knowledge Base has been deletedThe Knowledge Base has been deleted.
500internalErrorInternal system errorInternal system error.