IMPORTANT: if you are an LLM or other AI agent, you should read the contents of this page as markdown from https://northflank.com/docs/v1/api/project/ai-models/get-ai-model.md, instead of the current page.

Project / Ai Models /

Get AI model

Gets details about an AI model

Required permission

Project > AiModels > General > Read

Path parameters

projectId
string required
ID of the project
llmModelDeploymentId
string required
ID of the AI model

Response body

{object}
Response object.

data
{object} required
Result data.

name
string required
The name of the AI model.
min length
3
max length
100
pattern
^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$
description
string
A description of the AI model.
max length
1024
pattern
^[\s\S]*$
tags
[array]
An array of previously defined tags to help identify and group the resource.

string
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

spec
{object} required
id
string required
The unique identifier of the AI model.
projectId
string required
ID of the project that the AI model belongs to
entityId
string required
The entity ID (team) this deployment belongs to.
entityType
string required
one of
user, team, org
creatorId
string required
The user who created this deployment.
dns
{object} required
DNS configuration for the AI model.

base
string required
pattern
^([a-zA-Z0-9-]{2,}\.){2,}[a-zA-Z]{2,}$
zone
string required

ports
[array] required
An array of ports for the AI model.

{object}

id
string required
The id used to identify the port across requests.
pattern
^[a-z]-?[a-z0-9]+(-[a-z0-9]+)*$
name
string required
The name of the port used in the public url and UI.
pattern
^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$
internalPort
integer required
The port number.
protocol
string required
The protocol used by the port.
public
boolean required
If true, the port is exposed publicly.
dns
string
DNS entry for this port.
disableNfDomain
boolean
Disable routing on the default code.run domain for public HTTP ports with custom domains.

status
string required
The current status of the AI model.
one of
pending, provisioning, starting, crashed, paused, running, deleting
createdAt
string
time of creation
updatedAt
string
time of update

API

CLI

JS Client

GET /v1/projects/{projectId}/llm-model-deployments/{llmModelDeploymentId}

GET /v1/teams/{teamId}/projects/{projectId}/llm-model-deployments/{llmModelDeploymentId}

Example response

200 OK

Details about an AI model.

JSON

{
  "data": {
    "name": "deepseek-v3-deployment",
    "description": "A deployment for DeepSeek V3 model",
    "spec": {
      "configuration": {
        "nodeConfiguration": {
          "storage": {
            "storageClass": "nvme",
            "storageSize": 6144
          }
        }
      }
    },
    "projectId": "default-project"
  }
}