Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zhipu AI Paas API

The Paas API from Zhipu AI — 10 operation(s) for paas.

Zhipu AI Paas API is one of 3 APIs that Zhipu AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Paas. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and pricing.

This API exposes 10 operations across 10 paths, and defines 41 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://api.z.ai/api.

10 operations 10 paths 41 schemas 1 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.z.ai/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Zhipu AI Paas API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Use the following format for authentication: Bearer [ ](https://z.ai/manage-apikey/apikey-list)

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 1 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Paas 10
POST
/paas/v4/chat/completions
Create a chat completion model that generates AI replies for given conversation messages. It supports multimodal inputs (text, images, audio, video, file), offers configurable parameters (like temper…
1 param body → 200default
POST
/paas/v4/videos/generations
CogVideoX is a video generation large model developed by Z.AI, equipped with powerful video generation capabilities. Simply inputting text or images allows for effortless video creation. Vidu: A high…
1 param body → 200default
GET
/paas/v4/async-result/{id}
This endpoint is used to query the result of an asynchronous request.
2 params → 200default
POST
/paas/v4/images/generations
Generate Image
body → 200default
POST
/paas/v4/async/images/generations
Generate Image (Async)
body → 200default
POST
/paas/v4/audio/transcriptions
Speech to Text
body → 200default
POST
/paas/v4/tokenizer
Text Tokenizer
body → 200default
POST
/paas/v4/layout_parsing
Layout Parsing
body → 200default
POST
/paas/v4/web_search
The [Web Search](/guides/tools/web-search) is a specialized search engine for large language models. Building upon traditional search engine capabilities like web crawling and ranking, it enhances in…
1 param body → 200default
POST
/paas/v4/files
This API is designed for uploading auxiliary files (such as glossaries, terminology lists) to support the translation service. It allows users to upload reference materials that can enhance translati…
body → 200default

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are ChatCompletionTextRequest (15 properties), ChatCompletionVisionRequest (13 properties), WebSearchObject (11 properties), LayoutParsingResponse (9 properties). Each schema is shown below with its type and property counts.

ViduText2VideoRequest
WebSearchToolSchema
object
2 properties 2 required
AudioTranscriptionResponse
object
5 properties
RetrievalToolSchema
object
2 properties 2 required
Error
object
The request has failed.
2 properties 2 required
AsyncVideoGenerationResponse
object
4 properties
RetrievalObject
object
2 properties 1 required
LayoutDetail
object
Layout detail element
6 properties 2 required
DataInfo
object
Document basic information
2 properties 1 required
TokenizerRequest
object
5 properties 2 required
ImageGenerationResponse
object
3 properties
CogVideoX3Request
ViduReference2VideoRequest
WebSearchRequest
object
7 properties 2 required
VideoResponse
object
4 properties
AsyncCreateImageRequest
object
5 properties 2 required
LayoutParsingRequest
object
8 properties 2 required
VisionMultimodalContentItem
ChatCompletionResponseMessage
object
4 properties
WebSearchObject
object
11 properties 1 required
AudioTranscriptionRequest
object
8 properties 2 required
LayoutParsingResponse
object
9 properties 3 required
ViduImage2VideoRequest
TokenizerResponse
object
4 properties 2 required
FunctionParameters
object
Parameters defined using JSON Schema. Must pass a JSON Schema object to accurately define accepted parameters. Omit if no parameters are needed when calling th…
WebSearchResponse
object
3 properties
AsyncResponse
object
4 properties
AudioTranscriptionStreamResponse
object
5 properties
FunctionToolSchema
object
2 properties 2 required
CreateImageRequest
object
5 properties 2 required
ChatCompletionVisionRequest
object
13 properties 2 required
ChatCompletionTextRequest
object
15 properties 2 required
ViduFrames2VideoRequest
AsyncImageGenerationResponse
object
4 properties
FunctionObject
object
3 properties 3 required
VideoCommonRequest
object
2 properties
ChatCompletionResponse
object
7 properties
ChatCompletionResponseMessageToolCall
object
3 properties
WebSearchObjectResponse
object
7 properties
ChatThinking
object
Only supported by GLM-4.5 series and higher models. This parameter is used to control whether the model enable the chain of thought.
2 properties
PageInfo
object
Page dimension information
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zhipu-ai-paas-api-openapi.yml Raw ↑

Other APIs Zhipu AI publishes across the network.

Zhipu AI Agents API
Zhipu AI Tools API API