Skip to content

API Reference

Explore public Agents, Box, Powers and Gateway APIs, scopes, schemas and OpenAPI specifications.

Updated

The four products publish 84 public operations with their native protocols and request and response schemas. Choose a product to search operations, inspect schemas and copy request examples.

Product Path prefix Specification
Agents /api/agents/v1/{instanceId} OpenAPI JSON
Box /api/box/v1/{boxId} OpenAPI JSON
Powers /api/powers/v1 OpenAPI JSON
Gateway /api/gateway/v1 OpenAPI JSON

Before your first request

Select your organization and prepare resources in Console, then create an organization API key with the required product scopes. Use the production API origin https://sinecloud.dev followed by the complete documented path; the documentation origin does not serve product requests.

Authorization: Bearer $SINECLOUD_API_KEY

Each operation lists required permissions in x-sinecloud-scopes. Current membership, project restrictions, resource access, budgets and available funds also apply on every call. Never use platform service credentials.

Read-only browsing and downloads

Reference pages support search, schema browsing and shareable operation links without executing requests or persisting authentication. Run requests in Console or your own client; retain request identities and follow operation recovery instructions after a lost connection.

Download the API index, or download individual specifications from the table above. Guidance and downloads remain available if the interactive reference cannot load.

Console

Type to search…

↑↓ navigate↵ selectEsc Close