LinkModel

https://docs.linkmodel.ai
Admin
LinkModel provides a unified API and CLI for image, video, and chat-compatible AI model workflows...
Tokens:105,515
Snippets:746
Trust Score:3.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install and authenticate the CLI

Source: https://docs.linkmodel.ai/cli

Install the CLI globally via npm and run the setup command to configure authentication.

```bash
npm install -g linkmodel-cli
lkm setup
```

--------------------------------

### Launch DeepSeek Harness Web UI

Source: https://docs.linkmodel.ai/agent-integrations-deepseek-harness

Starts the DeepSeek Harness Web UI using npx. Requires Node.js to be installed. The UI is served at http://127.0.0.1:3080 by default.

```bash
npx @deepseek-ai/dsh web
```

--------------------------------

### Start OpenCode

Source: https://docs.linkmodel.ai/agent-integrations-opencode

Launches OpenCode. After starting, use the /models command to select a linkmodel/* model.

```bash
opencode
```

--------------------------------

### Verify LinkModel CLI installation with version and help

Source: https://docs.linkmodel.ai/cli-installation

Checks that the CLI is installed and accessible by displaying its version and help information. Run these commands after installation to confirm the CLI is on your PATH.

```bash
lkm --version
lkm --help
```

--------------------------------

### Start Codex

Source: https://docs.linkmodel.ai/agent-integrations-codex

Launch the Codex application after configuration.

```bash
codex
```

--------------------------------

### Run interactive setup flow

Source: https://docs.linkmodel.ai/cli-authentication

Initiates the interactive configuration process for the CLI.

```bash
lkm setup
```

--------------------------------

### Use CLI in scripts with --json

Source: https://docs.linkmodel.ai/faq-cli

Use the --json flag to get JSON output for automation. The example shows image generation and video status commands with --wait.

```bash
lkm image "a product photo" --json
lkm video status <task_id> --wait --json
```

--------------------------------

### Image-to-video with first-frame-image

Source: https://docs.linkmodel.ai/cli-video-generation

Uses model-specific frame fields when supported. The example uses --first-frame-image with kling-v3.

```bash
lkm video gen "animate this product with a slow camera move" \
  -m kling-v3 \
  --first-frame-image https://example.com/first-frame.png
```

--------------------------------

### Install LinkModel CLI globally with npm

Source: https://docs.linkmodel.ai/cli-installation

Installs the LinkModel CLI package globally using npm. Run this command in your terminal to make the CLI available on your PATH.

```bash
npm install -g linkmodel-cli
```

--------------------------------

### Check installed LinkModel CLI version

Source: https://docs.linkmodel.ai/cli-installation

Displays the currently installed version of the LinkModel CLI. Use this after updating to confirm the new version.

```bash
lkm --version
```

--------------------------------

### Check Globally Installed CLI with npm install -g linkmodel-cli and lkm --version

Source: https://docs.linkmodel.ai/cli-troubleshooting

Run when the lkm command is not found. Installs the CLI globally via npm and verifies the installation. If lkm is still unavailable, check that the global npm bin directory is on the PATH.

```bash
npm install -g linkmodel-cli
lkm --version
```

--------------------------------

### List available models with lkm models list

Source: https://docs.linkmodel.ai/cli-model-schemas

Use these commands to list all available models or filter them by modality.

```bash
lkm models list
lkm models list --modality image
lkm models list --modality video
```

--------------------------------

### Configure API key directly

Source: https://docs.linkmodel.ai/cli-authentication

Sets the API key manually and verifies the authentication status.

```bash
lkm auth login --api-key <your-api-key>
lkm auth status
```

--------------------------------

### GET /query/video-generation

Source: https://docs.linkmodel.ai/api-reference/legacy/video-task-query

Retrieves the current status and result of a video generation task using the task_id returned from either video creation endpoint. This is a legacy endpoint; new integrations should use GET /v1/videos/generations/{task_id}.

```APIDOC
## GET /query/video-generation

### Description
Retrieves the current status and result of a video generation task using the task_id returned from either video creation endpoint. This is a legacy endpoint; new integrations should use GET /v1/videos/generations/{task_id}.

### Method
GET

### Endpoint
/query/video-generation

### Parameters
#### Query Parameters
- **task_id** (string) - Required - Task id returned from either video creation endpoint.

### Response
#### Success Response (200)
- **code** (integer) - Example: 0
- **data** (object) - Contains task details.
  - **task_id** (string) - The task identifier.
  - **status** (string) - Status of the task. Possible values: Pending, Processing, Success, Failed, Cancelled.
  - **file_url** (string, uri) - Transient signed URL to the result file. Should not be used as a permanent identifier.
- **message** (string) - Example: success

#### Response Example
{
  "code": 0,
  "data": {
    "task_id": "aurora_abc123",
    "status": "Success",
    "file_url": "https://example.com/video.mp4"
  },
  "message": "success"
}

#### Error Responses
- **401** - Unauthorized — missing or invalid API key.
- **404** - Task not found.

### Authentication
Bearer token (JWT) required.
```

--------------------------------

### Select a model with -m and model-specific options

Source: https://docs.linkmodel.ai/cli-video-generation

Uses -m or --model to select a model. Model-specific options like --duration, --resolution, --size, and --extends-cfg-scale are generated from bundled LinkModel schemas.

```bash
lkm video gen "a cinematic product orbit" \
  -m kling-v3 \
  --duration 5 \
  --resolution 720P \
  --size 16x9 \
  --extends-cfg-scale 0.7
```

--------------------------------

### Verify CLI version and model list

Source: https://docs.linkmodel.ai/cli-model-schemas

Check the current CLI version and list models to verify updates.

```bash
lkm --version
lkm models list
```

--------------------------------

### OpenAPI specification for GET /files/{file_id}

Source: https://docs.linkmodel.ai/api-reference/gemini/get-gemini-file

Defines the GET /files/{file_id} endpoint for retrieving Gemini file status and URI. Requires a bearer token. Returns 200 with file details, 401 for invalid API key, and 404 for missing file.

```yaml
openapi: 3.0.3
info:
  title: Get Gemini file
  version: 1.0.0
  description: >-
    Read Gemini file-processing status and retrieve its native file URI when
    active.
servers:
  - url: https://api.linkmodel.ai/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Gemini
  - name: files
paths:
  /files/{file_id}:
    get:
      tags:
        - Gemini
        - files
      summary: Get Gemini file
      description: >
        Poll this resource after completing an upload. Only an `active` file has
        a usable `uri` for Gemini-native `fileData.fileUri` input.


        The returned `gs://` URI is an account-scoped Gemini reference, not a
        public download URL or a cross-provider asset identifier.
      operationId: get-gemini-file
      parameters:
        - name: file_id
          in: path
          required: true
          description: File identifier returned when the upload session was created.
          schema:
            type: string
          example: file_example123
      responses:
        '200':
          description: Current Gemini file resource.
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                  - data
                properties:
                  code:
                    type: integer
                    enum:
                      - 0
                    example: 0
                  data:
                    type: object
                    required:
                      - file_id
                      - status
                    properties:
                      file_id:
                        type: string
                        example: file_example123
                      status:
                        type: string
                        description: >-
                          Common lifecycle values include `pending_upload`,
                          `transferring`, and `active`.
                        example: active
                      filename:
                        type: string
                        example: sample.mp4
                      mime_type:
                        type: string
                        example: video/mp4
                      bytes:
                        type: integer
                        format: int64
                        example: 35077
                      uri:
                        type: string
                        description: >-
                          Present when active. Pass unchanged as Gemini
                          `fileData.fileUri`.
                        example: >-
                          gs://managed-gemini-files/.../file_example123-sample.mp4
                      created_at:
                        type: integer
                        format: int64
                        example: 1783580035
                      expires_at:
                        type: integer
                        format: int64
                        example: 1783666435
        '401':
          description: Missing or invalid LinkModel API key.
        '404':
          description: File identifier not found or not accessible to this account.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
```

--------------------------------

### Generate a video

Source: https://docs.linkmodel.ai/cli

Use the lkm video command followed by a prompt to generate a video.

```bash
lkm video "a cinematic product orbit"
```

--------------------------------

### POST /files/{file_id}/complete

Source: https://docs.linkmodel.ai/api-reference/gemini/complete-gemini-file-upload

Confirms that a Gemini file upload finished and starts server-side processing. Call this endpoint only after the direct PUT to the pre-signed upload URL succeeds. An accepted response starts file processing; poll the file resource until its status becomes 'active'.

```APIDOC
## POST /files/{file_id}/complete

### Description
Confirms that a Gemini file upload finished and starts server-side processing. Call this endpoint only after the direct PUT to the pre-signed upload URL succeeds. An accepted response starts file processing; poll the file resource until its status becomes `active`. This file lifecycle is only for Gemini-native `fileData` requests.

### Method
POST

### Endpoint
https://api.linkmodel.ai/v1/files/{file_id}/complete

### Parameters
#### Path Parameters
- **file_id** (string) - Required - File identifier returned when the upload session was created.

### Response
#### Success Response (202)
Upload accepted and file processing started.

#### Error Responses
- **400** - The upload is incomplete or its metadata does not match the session.
- **401** - Missing or invalid LinkModel API key.
- **404** - File identifier not found or not accessible to this account.

### Security
Bearer authentication (JWT) required.
```

--------------------------------

### Inspect Model with lkm models show <model>

Source: https://docs.linkmodel.ai/cli-troubleshooting

Run before using provider-specific options to see the bundled schema for the selected model. This helps identify valid flags and parameters.

```bash
lkm models show <model>
```

--------------------------------

### GET /api/v1/tasks/{task_id}

Source: https://docs.linkmodel.ai/api-reference/bytedance/seedream-40

Polls the status of an image generation task using its task_id.

```APIDOC
## GET /api/v1/tasks/{task_id}

### Description
Polls the status of a previously created image generation task.

### Method
GET

### Endpoint
/api/v1/tasks/{task_id}

### Parameters
#### Path Parameters
- **task_id** (string) - Required - The task ID returned from task creation.

### Response
#### Success Response (200)
- **code** (integer) - Status code, 0 for success.
- **data** (object) - Response data.
  - **task_id** (string) - Task ID.
  - **order_id** (string) - Billing order ID.
  - **status** (string) - Task status.
  - **price** (number) - Charged amount.
- **msg** (string) - Response message.
- **request_id** (string, uuid) - Request identifier.

#### Response Example
{
  "code": 0,
  "data": {
    "task_id": "aurora_abc123",
    "order_id": "019da9cf-d1db-78e1-ac23-526774d01193",
    "status": "Processing",
    "price": 0.074
  },
  "msg": "success",
  "request_id": "250b66dd-e1fb-4bb6-b5f6-c668efadc35d"
}

#### Error Response (400)
- **code** (integer) - Error code, 400.
- **msg** (string) - Error message.
- **request_id** (string, uuid) - Request identifier.

#### Error Response Example
{
  "code": 400,
  "msg": "task_id is required",
  "request_id": "96be7a7d-3e81-4916-a6b8-19b32773a693"
}

#### Error Response (401)
- **code** (integer) - Error code, 401.
- **data** (object) - Empty object.
- **msg** (string) - Error message.
- **request_id** (string, uuid) - Request identifier.

#### Error Response Example
{
  "code": 401,
  "data": {},
  "msg": "invalid api key",
  "request_id": "bff4c295-c7da-4507-9708-4627cb6373ba"
}

#### Error Response (500)
- **code** (integer) - Error code, 500.
- **msg** (string) - Error message.
- **request_id** (string, uuid) - Request identifier.

#### Error Response Example
{
  "code": 500,
  "msg": "create task failed: billing: code=100601: insufficient balance",
  "request_id": "3409f6fb-fa9a-4534-b530-195b5f6f4e32"
}
```

--------------------------------

### Configure Codex Desktop API Key

Source: https://docs.linkmodel.ai/agent-integrations-troubleshooting

Set the API key in the .env file for Codex desktop applications and restart the app.

```text
LINKMODEL_API_KEY=<YOUR_API_KEY>
```

--------------------------------

### Gemini API response format

Source: https://docs.linkmodel.ai/gemini-video-understanding

Example of the native JSON response returned by the Gemini model.

```json
{
  \"candidates\": [
    {
      \"content\": {
        \"parts\": [{ \"text\": \"The video shows...\" }],
        \"role\": \"model\"
      },
      \"finishReason\": \"STOP\"
    }
  ],
  \"modelVersion\": \"gemini-3.1-flash-lite\",
  \"usageMetadata\": {
    \"promptTokenCount\": 140,
    \"candidatesTokenCount\": 183,
    \"totalTokenCount\": 323
  }
}
```

--------------------------------

### POST /videos/generations

Source: https://docs.linkmodel.ai/api-reference/minimax/minimax-hailuo-23

Creates an asynchronous video generation task using the MiniMax-Hailuo-2.3 model. Supports text-to-video and image-to-video tasks with configurable duration and resolution.

```APIDOC
## POST /videos/generations

### Description
Creates an asynchronous video generation task using the MiniMax-Hailuo-2.3 model. Supports text-to-video and image-to-video tasks with configurable duration and resolution.

### Method
POST

### Endpoint
https://api.linkmodel.ai/v1/videos/generations

### Parameters
#### Request Body
- **model** (string) - Required - Must be one of: MiniMax-Hailuo-2.3.
- **prompt** (string) - Required - Length must be between 1 and 2000.
- **duration** (integer) - Optional - Must be one of: 6, 10. Defaults to `6`. Value is in s. Conditional limits: 1080P resolution only supports 6 seconds duration.
- **first_frame_image** (string, url) - Optional - URL of the first frame image for image-to-video tasks.
- **resolution** (string) - Optional - Must be one of: 1080P, 768P. Defaults to `768P`.

### Request Example
{
  "model": "MiniMax-Hailuo-2.3",
  "prompt": "A cinematic shot of a robot walking through a futuristic city",
  "duration": 6,
  "first_frame_image": "https://example.com/first-frame.jpg",
  "resolution": "768P"
}

### Response
#### Success Response (200)
- **task_id** (string) - The ID of the created task. Use this to poll the task status.

#### Response Example
{
  "task_id": "your-task-id"
}

### Task Lifecycle
This endpoint creates an asynchronous task. Poll `GET /videos/generations/{task_id}` with the returned `task_id` until the task reaches a terminal state.

If the POST request times out or its result is uncertain, do not blindly retry it. The original request may already have created another task and billing order.

Completed asset URLs are dynamically signed. Download or copy assets that must be retained instead of treating the URLs as permanent identifiers.

### Authentication
Requires bearer token authentication.
```
Tokens:
Raw