Register a customer fine-tune

POST

api

models

curl --request POST \
  --url https://dev.simforge.ai/api/v1/models \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "family": "<string>",
  "name": "<string>",
  "format": "safetensors",
  "files": [
    {
      "path": "<string>",
      "sha256": "<string>",
      "bytes": 123
    }
  ],
  "params": {}
}
'

import requests

url = "https://dev.simforge.ai/api/v1/models"

payload = {
    "family": "<string>",
    "name": "<string>",
    "format": "safetensors",
    "files": [
        {
            "path": "<string>",
            "sha256": "<string>",
            "bytes": 123
        }
    ],
    "params": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    family: '<string>',
    name: '<string>',
    format: 'safetensors',
    files: [{path: '<string>', sha256: '<string>', bytes: 123}],
    params: {}
  })
};

fetch('https://dev.simforge.ai/api/v1/models', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "model": {
    "id": "<string>",
    "name": "<string>",
    "family": "<string>",
    "revision": "<string>",
    "quant": "<string>",
    "checkpointDigest": "<string>",
    "owner": "workspace",
    "state": "awaiting_upload",
    "params": {},
    "bytes": 1,
    "rejection": {
      "code": "<string>",
      "message": "<string>",
      "fields": [
        "<string>"
      ]
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "uploads": [
    {
      "path": "<string>",
      "uploadId": "<string>",
      "uploadUrl": "<string>",
      "uploadHeaders": {},
      "expiresAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Body

application/json

family

string

required

Minimum string length: 1

name

string

required

Required string length: 1 - 200

format

enum<string>

required

Available options:

safetensors

files

object[]

required

Required array length: 1 - 32 elements

Show child attributes

params

object

Show child attributes

Response

Registered fine-tune and its upload grants.

model

object

required

Show child attributes

uploads

object[]

required

Show child attributes

⌘I

curl --request POST \
  --url https://dev.simforge.ai/api/v1/models \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "family": "<string>",
  "name": "<string>",
  "format": "safetensors",
  "files": [
    {
      "path": "<string>",
      "sha256": "<string>",
      "bytes": 123
    }
  ],
  "params": {}
}
'

import requests

url = "https://dev.simforge.ai/api/v1/models"

payload = {
    "family": "<string>",
    "name": "<string>",
    "format": "safetensors",
    "files": [
        {
            "path": "<string>",
            "sha256": "<string>",
            "bytes": 123
        }
    ],
    "params": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    family: '<string>',
    name: '<string>',
    format: 'safetensors',
    files: [{path: '<string>', sha256: '<string>', bytes: 123}],
    params: {}
  })
};

fetch('https://dev.simforge.ai/api/v1/models', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "model": {
    "id": "<string>",
    "name": "<string>",
    "family": "<string>",
    "revision": "<string>",
    "quant": "<string>",
    "checkpointDigest": "<string>",
    "owner": "workspace",
    "state": "awaiting_upload",
    "params": {},
    "bytes": 1,
    "rejection": {
      "code": "<string>",
      "message": "<string>",
      "fields": [
        "<string>"
      ]
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "uploads": [
    {
      "path": "<string>",
      "uploadId": "<string>",
      "uploadUrl": "<string>",
      "uploadHeaders": {},
      "expiresAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

Cloud API

Endpoints

Register a customer fine-tune

Authorizations

Body

Response