jointrashposs/content/ja/.docs-legacy/api/endpoints/notes/create.json5

{
	summary: 'ノートを作成します。',
	description: 'ノートを作成します。返信やRenoteもこのAPIで行います。',
	tags: [
		'notes',
	],
	requireCredential: true,
	req: {
		type: 'object',
		properties: {
			visibility: {
				type: 'string',
				enum: [
					'public',
					'home',
					'followers',
					'specified',
				],
				default: 'public',
				description: 'ノートの公開範囲。',
			},
			visibleUserIds: {
				type: 'array',
				uniqueItems: true,
				items: {
					type: 'string',
					format: 'misskey:id',
				},
				description: 'ノートを閲覧可能なユーザーのidのリスト。visibilityがspecifiedの場合のみ適用されます。',
			},
			text: {
				type: 'string',
				maxLength: 3000,
				nullable: true,
				description: 'ノートの本文。',
			},
			cw: {
				type: 'string',
				nullable: true,
				maxLength: 100,
				description: 'ノートのCW。',
			},
			localOnly: {
				type: 'boolean',
				default: false,
				description: 'trueにすると、ローカルのみに投稿されます。',
			},
			noExtractMentions: {
				type: 'boolean',
				default: false,
				description: 'trueにすると、本文からメンションを展開しません。',
			},
			noExtractHashtags: {
				type: 'boolean',
				default: false,
				description: 'trueにすると、本文からハッシュタグを展開しません。',
			},
			noExtractEmojis: {
				type: 'boolean',
				default: false,
				description: 'trueにすると、本文から絵文字を展開しません。',
			},
			fileIds: {
				type: 'array',
				uniqueItems: true,
				minItems: 1,
				maxItems: 16,
				items: {
					type: 'string',
					format: 'misskey:id',
				},
				description: '添付するファイルのid。',
			},
			mediaIds: {
				deprecated: true,
				description: 'fileIds を使用してください。fileIds と mediaIds が指定された場合、 mediaIds は無視されます。',
				type: 'array',
				uniqueItems: true,
				minItems: 1,
				maxItems: 16,
				items: {
					type: 'string',
					format: 'misskey:id',
				},
			},
			replyId: {
				type: 'string',
				format: 'misskey:id',
				nullable: true,
				description: '返信先のノートのid。',
			},
			renoteId: {
				type: 'string',
				format: 'misskey:id',
				nullable: true,
				description: 'Renote対象のノートのid。',
			},
			channelId: {
				type: 'string',
				format: 'misskey:id',
				nullable: true,
				description: '投稿先のチャンネルのid。',
			},
			poll: {
				type: 'object',
				nullable: true,
				properties: {
					choices: {
						type: 'array',
						uniqueItems: true,
						minItems: 2,
						maxItems: 10,
						items: {
							type: 'string',
							minLength: 1,
							maxLength: 50,
						},
						description: '選択肢。',
					},
					multiple: {
						type: 'boolean',
						default: false,
						description: 'trueにすると、複数選択を許容します。',
					},
					expiresAt: {
						type: 'integer',
						nullable: true,
						description: '投票の締め切り。エポック秒で指定します。',
					},
					expiredAfter: {
						type: 'integer',
						nullable: true,
						minimum: 1,
						description: '指定すると、ノート作成からexpiredAfter秒後に投票を締め切ります。expiresAtと併せて指定した場合、expiresAtが優先されます。',
					},
				},
				required: [
					'choices',
				],
				description: '投票に関するパラメータ。',
			},
		},
		anyOf: [
			{
				properties: {
					text: {
						type: 'string',
						minLength: 1,
						maxLength: 3000,
						nullable: false,
					},
				},
				required: [
					'text',
				],
			},
			{
				required: [
					'fileIds',
				],
			},
			{
				required: [
					'mediaIds',
				],
			},
			{
				properties: {
					poll: {
						type: 'object',
						nullable: false,
					},
				},
				required: [
					'poll',
				],
			},
			{
				required: [
					'renoteId',
				],
			},
		],
	},
	res: {
		type: 'object',
		optional: false,
		nullable: false,
		properties: {
			createdNote: {
				type: 'object',
				optional: false,
				nullable: false,
				ref: 'Note',
				$ref: 'misskey://Note',
				description: '作成されたノート',
			},
		},
		required: [
			'createdNote',
		],
	},
	errors: {
		'b5c90186-4ab0-49c8-9bba-a1f76c282ba4': {
			id: 'b5c90186-4ab0-49c8-9bba-a1f76c282ba4',
			code: 'NO_SUCH_RENOTE_TARGET',
			description: 'Renoteに指定されたノートが存在しないか、アクセスが許可されていません。',
		},
		'fd4cc33e-2a37-48dd-99cc-9b806eb2031a': {
			id: 'fd4cc33e-2a37-48dd-99cc-9b806eb2031a',
			code: 'CANNOT_RENOTE_TO_A_PURE_RENOTE',
			description: '単純なRenoteを再度Renoteすることはできません。',
		},
		'749ee0f6-d3da-459a-bf02-282e2da4292c': {
			id: '749ee0f6-d3da-459a-bf02-282e2da4292c',
			code: 'NO_SUCH_REPLY_TARGET',
			description: '返信先に指定されたノートが存在しないか、アクセスが許可されていません。',
		},
		'3ac74a84-8fd5-4bb0-870f-01804f82ce15': {
			id: '3ac74a84-8fd5-4bb0-870f-01804f82ce15',
			code: 'CANNOT_REPLY_TO_A_PURE_RENOTE',
			description: '単純なRenoteに返信することはできません。',
		},
		'04da457d-b083-4055-9082-955525eda5a5': {
			id: '04da457d-b083-4055-9082-955525eda5a5',
			code: 'CANNOT_CREATE_ALREADY_EXPIRED_POLL',
			description: 'アンケートの期限の指定が誤っています。',
		},
		'b1653923-5453-4edc-b786-7c4f39bb0bbb': {
			id: 'b1653923-5453-4edc-b786-7c4f39bb0bbb',
			code: 'NO_SUCH_CHANNEL',
			description: '指定されたチャンネルが存在しないか、アクセスが許可されていません。',
		},
		'b390d7e1-8a5e-46ed-b625-06271cafd3d3': {
			id: 'b390d7e1-8a5e-46ed-b625-06271cafd3d3',
			code: 'YOU_HAVE_BEEN_BLOCKED',
			description: 'ブロックされているユーザーのノートに対して返信やRenoteは行えません。',
		},
	},
}