ShareAI Platform Docs

Create a model package

Create ShareAI Creator model metadata, a collection and model tags together, with explicit access policy and scoped API credentials.

View as Markdown
On this page
POST https://api.shareai.now/api/v1/console/creator/model-package

Create model metadata, collection policy and tags.

Base URL
https://api.shareai.now
Authentication
HTTP Basic: creator UUID and creator access token
Required scope
creator_collections:write creator_models:write
The model workflow separates model information, collection policy and tags.The model workflow separates model information, collection policy and tags.
The model workflow separates model information, collection policy and tags.

Use a model package to submit a coherent model definition. Describe what the model does, its limitations and each exact tag. This request creates catalog data; it is not an upload of model weights and does not automatically put a device into sharing mode.

JSON

{
  "model": {
    "name": "Example Research Model",
    "slug": "example-research-model",
    "description_html": "<p>A text model for document classification. Include evaluation notes and limitations.</p>"
  },
  "collection": {
    "share_types": [
      "private"
    ]
  },
  "tags": [
    {
      "tag": "3b",
      "description_html": "<p>Compact model variant.</p>"
    },
    {
      "tag": "7b",
      "description_html": "<p>Larger model variant.</p>"
    }
  ],
  "media": []
}

cURL

curl --fail-with-body --request POST https://api.shareai.now/api/v1/console/creator/model-package \
  -u "$CREATOR_UUID:$CREATOR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data @model-package.json

Check the slug first#

GET https://api.shareai.now/api/v1/console/creator/model-slug-availability

Check an intended model_slug.

Base URL
https://api.shareai.now
Authentication
HTTP Basic: creator UUID and creator access token
Required scope
creator_collections:read

cURL

curl --get --fail-with-body https://api.shareai.now/api/v1/console/creator/model-slug-availability \
  -u "$CREATOR_UUID:$CREATOR_ACCESS_TOKEN" \
  --data-urlencode "model_slug=example-research-model"

A successful availability check is a preflight hint, not a reservation. Handle a conflict on creation and keep the server-returned model/collection identifiers.

Policy and tag overrides#

The collection supplies its default share types. A tag can supply supported share_types_override values and associated provider audience or commercial fields. Verify the effective policy for each tag after creation.

After saving#

Open the collection in Console, check the descriptions and exact tags, complete any missing media or commercial information and use the review workflow. Confirm the approved state before telling providers that the model can be served.

Last updated September 15, 2026

ShareAI Platform Docs
All documentation

Search by title or content.

Ask about this page

Choose an assistant to explore this page. You can also copy the page and paste it into your conversation.

Ask ChatGPTAsk ClaudeAsk GrokAsk ShareAI