AKStream.Next · 文档中心

API and Request-Response Model Index

API and Request-Response Model Index

AKStream.Next v2 business APIs are located at /api/v2. The complete contract is delivered with the product version; do not use the "latest interface on the current website" to call older deployments.

The bundled integration Skill contains the 1.0.0.169 public contract with 626 public operations covering business and management APIs. Use the matching assets and check the deployment version for fields and permissions. RTC SDK signatures come from the matching delivered types and sources.

flowchart LR
    A[Deployed version] --> B[Matching openapi-v2.json]
    B --> C[Paths and permissions]
    B --> D[Request/response schemas]
    C --> E[Client and contract tests]
    D --> E

Contract Assets

  • Documentation/SKILL/akstream-next-integration/references/openapi.json: Machine-readable OpenAPI.
  • Documentation/SKILL/akstream-next-integration/references/postman-collection.json: Request collections grouped by domain.
  • Documentation/SKILL/akstream-next-integration/references/postman-environment.json: Environment templates without real tokens.
  • Complete API Index: operations, permissions, and summaries.
  • API Request and Response Model Index: schema field reference.

These assets are generated from the same OpenAPI single source of truth, and release gates verify the number of operations and models.

Online Swagger

Swagger/Knife4j pages, static resources, and OpenAPI JSON are only accessible via interactive backend sessions of logged-in WebUI users. Standard API tokens cannot enumerate the interface directory. Unattended builds and SDK generation should use the assets included in the package.

Request Conventions

  • JSON uses UTF-8; time uses ISO 8601 and preserves timezone semantics.
  • Pagination typically starts from page=1, and pageSize has a server-side limit.
  • Nullable fields have different semantics than empty strings.
  • Clients should ignore unknown response fields and tolerate new status values.
  • Non-2xx responses preserve the HTTP status, Content-Type, raw response, and TraceId.
  • Files, Range, SDP, and WebSocket are handled by their respective protocols.

Permissions

When using a Bearer API token, grant only the minimum domain permissions. Internal nodes, Agents, media-service WebHooks, and setup-wizard endpoints are not third-party APIs. System file trees, secrets, and high-risk lifecycle actions also require an interactive session.

Finding Interfaces

First, select the domain based on the task:

  • Device and Channel: devices, channels, GB28181, ONVIF.
  • Real-time Stream and Playback: streams, media servers, tickets.
  • Recording: recording, files, record plans, cut/merge.
  • Recording content search: Recording semantic search API.
  • RTC: rooms, participants, media sessions, events.
  • Operations: system, nodes, configuration, tasks, logs.
  • Security: users, roles, API tokens, audit.

After finding the operation, check the corresponding request/response Schema and permissions. For code examples, go to OpenAPI, Postman, and Client Assets.