> ## Documentation Index
> Fetch the complete documentation index at: https://docs.synapsai.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a model artifact

> Creates an artifact record before file upload on https://api.synapsai.cloud. The API key must allow uploads and must not be an ephemeral upload key.



## OpenAPI

````yaml /api-reference/model-artifacts.json post /v1/model-artifacts
openapi: 3.1.0
info:
  title: SynapsAI Model Artifacts API
  version: 1.0.0
servers:
  - url: https://api.synapsai.cloud
    description: Production server
security: []
paths:
  /v1/model-artifacts:
    post:
      summary: Create a model artifact
      description: >-
        Creates an artifact record before file upload on
        https://api.synapsai.cloud. The API key must allow uploads and must not
        be an ephemeral upload key.
      operationId: createModelArtifact
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateArtifactRequest'
      responses:
        '201':
          description: Artifact created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactEnvelope'
components:
  schemas:
    CreateArtifactRequest:
      type: object
      required:
        - display_name
        - pipeline
      properties:
        display_name:
          type: string
        pipeline:
          type: string
          description: Hugging Face pipeline task for the artifact.
    ArtifactEnvelope:
      type: object
      properties:
        message:
          type: string
        artifact:
          $ref: '#/components/schemas/ModelArtifact'
    ModelArtifact:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
        display_name:
          type: string
        pipeline:
          type: string
        status:
          type: string
        size_gb:
          type: number
        created_at:
          type: string
        updated_at:
          type: string

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.