Modrinth API Types - v1.1.0
    Preparing search index...

    Type Alias APIProjectCreateBody

    type APIProjectCreateBody = {
        additional_categories?: string[];
        body?: string;
        categories?: string[];
        client_side?: ProjectClientSide;
        description?: string;
        discord_url?: string | null;
        donation_urls?: APIProjectDonationURL[];
        gallery_items: APIProjectAddGalleryImageParameters;
        initial_versions: APIVersion[];
        is_draft: true;
        issues_url?: string | null;
        license_id?: string;
        license_url?: string | null;
        project_type: ProjectType;
        requested_status?: ProjectRequestedStatus | null;
        server_side?: ProjectServerSide;
        slug?: string;
        source_url?: string | null;
        status?: ProjectStatus;
        title?: string;
        wiki_url?: string | null;
    }
    Index

    Properties

    additional_categories? body? categories? client_side? description? discord_url? donation_urls? gallery_items initial_versions is_draft issues_url? license_id? license_url? project_type requested_status? server_side? slug? source_url? status? title? wiki_url?

    Properties

    additional_categories?: string[]

    A list of categories which are searchable but non-primary.

    Optionalbody

    body?: string

    A long form description of the project.

    categories?: string[]

    A list of the categories that the project has.

    client_side?: ProjectClientSide

    The client side support of the project.

    description?: string

    A short description of the project.

    discord_url?: string | null

    An optional invite link to the project’s Discord server.

    donation_urls?: APIProjectDonationURL[]

    A list of donation links for the project.

    gallery_items: APIProjectAddGalleryImageParameters

    Gallery images to be uploaded with the created project.

    Please upload gallery images after initial upload.

    initial_versions: APIVersion[]

    A list of initial versions to upload with the created project.

    Please upload version files after initial upload.

    is_draft: true

    Whether the project should be saved as a draft instead of being sent to moderation for review.

    This is required to always be true.

    issues_url?: string | null

    An optional link to where to submit bugs or issues with the project.

    license_id?: string

    The SPDX license ID for the project.

    license_url?: string | null

    The URL to this license.

    project_type: ProjectType

    The project type of the project.

    requested_status?: ProjectRequestedStatus | null

    The requested status when submitting for review or scheduling the project for release.

    server_side?: ProjectServerSide

    The server side support of the project.

    slug?: string

    The slug of a project, used for vanity URLs.

    Uses Regular Expression:

    /^[\w!@$()`.+,"\-']{3,64}$/
    source_url?: string | null

    An optional link to the source code of the project.

    status?: ProjectStatus

    The status of the project.

    title?: string

    The title or name of the project.

    wiki_url?: string | null

    An optional link to the project’s wiki page or other relevant information.

    Settings

    Member Visibility

    On This Page

    Properties