Invoke Large Model Service

POST 
/v1/ai/:model/:path

When invoking large models, if you need to pass an additional path, you can append the path parameter, such as v1/chat/completions. Refer to the documentation of each large model for specific path definitions.

Streaming Output (server-sent events)

When enabling streaming output, explicitly specify text/event-stream in the Accept request header; otherwise, the request will time out after 60 seconds.

Request

Path Parameters

model anyrequired

The model code to be invoked, which can be any one of the model groups provided by the following platforms:
hunyuan-exp: Hunyuan Trial
deepseek: Trial
or enter any other custom model group configured on the console.

path stringrequired

The invocation path for the large model, such as v1/chat/completions

application/json

Body

required

Refer to the documentation of each large model for passing request parameters.

object

Responses

200

When invoking large models is successful, it returns (not necessarily the correct result).

Response Headers

• X-Request-Id string

  Request ID

application/json

Schema

Schema

property name* any

Example (from schema)

{
  "created": 1723618716,
  "id": "xxx",
  "model": "hunyuan",
  "version": "202403121316",
  "choices": [
    {
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": "I am an AI assistant developed by Tencent. How can I help you?"
      }
    }
  ],
  "search_info": {
    "mindmap": {}
  },
  "processes": {},
  "usage": {
    "prompt_tokens": 11,
    "completion_tokens": 14,
    "total_tokens": 25
  }
}

text/event-stream

Schema

Schema

string

400

Request failed.

Response Headers

• X-Request-Id string

  Request ID

application/json

Schema

Schema

code string

Error code

message string

Error message

requestId string

Request ID

Example (from schema)

{
  "code": "string",
  "message": "string",
  "requestId": "string"
}

AIModelConfigMissing

Missing necessary configurations for invoking the model, such as token, clientID, etc. (400)

{
  "code": "AI_MODEL_CONFIG_MISSING",
  "message": "xxx",
  "requestId": "xxx"
}

AIModelParamInvalid

Abnormal parameters for invoking the model (400)

{
  "code": "AI_MODEL_PARAM_INVALID",
  "message": "xxx",
  "requestId": "xxx"
}

AIModelRequestFailed

Request to the model failed (400)

{
  "code": "AI_MODEL_REQUEST_FAILED",
  "message": "xxx",
  "requestId": "xxx"
}

404

Request failed.

Response Headers

• X-Request-Id string

  Request ID

application/json

Schema

Schema

code string

Error code

message string

Error message

requestId string

Request ID

Example (from schema)

{
  "code": "string",
  "message": "string",
  "requestId": "string"
}

FeatureNotConfigured

Large model not enabled (404)

{
  "code": "ENV_FEATURE_NOT_CONFIGURED",
  "message": "xxx",
  "requestId": "xxx"
}

AIModelNotFound

Specified model not found (404)

{
  "code": "AI_MODEL_NOT_FOUND",
  "message": "xxx",
  "requestId": "xxx"
}

default

General error message. See https://docs.cloudbase.net/error-code/service

Response Headers

• X-Request-Id string

  Request ID

application/json

Schema

Schema

code string

Error code

message string

Error message

requestId string

Request ID

Example (from schema)

{
  "code": "string",
  "message": "string",
  "requestId": "string"
}

InvalidHost

Invalid request address

{
  "code": "INVALID_HOST",
  "message": "xxx",
  "requestId": "xxx"
}

Loading...