Sinapsis Cloud API
Sinapsis private cloud orchestration and management API
Template Registry
GET/api/v1/management/profiles/meGet my registry profile
Return organization, role and tier for the current user.
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Profile"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}PATCH/api/v1/management/profiles/meUpdate my profile
Update display information; roles and tiers cannot be self-edited.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileEdit"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Profile"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/teamsCreate an organization team
Requires OWNER or ADMIN organization role.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamCreateRequest"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Team"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}PUT/api/v1/management/teams/{team_id}/membersGrant team membership
Requires team ADMIN or organization ADMIN/OWNER.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
team_id | path | string | Yes |
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddTeamMemberRequest"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/packagesDiscover packages
Return packages accessible under independent package visibility rules.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
limit | query | integer | No |
offset | query | integer | No |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackagePage"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/packagesRegister a package
Transactionally register a package and its selected team grants.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackageCreate"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Package"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/packages/{package_id}Get an accessible package
Get package without disclosing inaccessible resources.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
package_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Package"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}PATCH/api/v1/management/packages/{package_id}Update package metadata
Update the package name without changing its ownership or visibility.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
package_id | path | string | Yes |
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackagePatch"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Package"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}DELETE/api/v1/management/packages/{package_id}Archive package
Soft-delete a package and remove its templates from discovery.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
package_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}PATCH/api/v1/management/packages/{package_id}/visibilityChange package sharing
Change package scope and selected teams atomically.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
package_id | path | string | Yes |
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/VisibilityChange"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Package"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/packages/{package_id}/versionsPublish a package release
Preserve exact template version mapping; unchanged templates need no re-publication.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
package_id | path | string | Yes |
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackageReleaseCreate"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackageVersion"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/packages/{package_id}/versionsList accessible package versions
Return release metadata only after package visibility check.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
package_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackageVersionPage"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/templatesDiscover accessible templates
Use view=ui for compact editor schemas; view=full for documentation metadata.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
limit | query | integer | No |
offset | query | integer | No |
view | query | string | No |
Responses
{
"application/json": {
"schema": {}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/templatesPublish a template version
Atomically persist implementation, JSONB schema, capabilities, and active version.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplatePublish"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Template"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/templates/searchSearch accessible templates
Combine subscription, visibility, capability flags and JSONB attribute filters.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
limit | query | integer | No |
offset | query | integer | No |
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateSearch"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplatePage"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/templates/{template_id}Get an accessible template
Fetch only user-accessible templates.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
template_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Template"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}PATCH/api/v1/management/templates/{template_id}Update template metadata
Update discovery metadata and tier without changing historical versions.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
template_id | path | string | Yes |
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplatePatch"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Template"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}DELETE/api/v1/management/templates/{template_id}Archive template
Soft-delete a logical registry entry while preserving version history.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
template_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/templates/{template_id}/detailsGet active template implementation and schema
Version-consistent, authorized join of active schema and capabilities.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
template_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateDetail"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/templates/{template_id}/versionsList historical template versions
Return immutable registry versions in descending publication order.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
template_id | path | string | Yes |
limit | query | integer | No |
offset | query | integer | No |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/VersionPage"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}PATCH/api/v1/management/templates/{template_id}/visibilityChange template sharing
Change selected-team grants independently of the package.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
template_id | path | string | Yes |
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/VisibilityChange"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Template"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/workersRegister Dockerfile worker
Create worker identity with owner/organization/team-scoped visibility.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerCreate"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Worker"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/workersDiscover accessible workers
Return workers visible to the authenticated caller.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
limit | query | integer | No |
offset | query | integer | No |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerPage"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/workers/{worker_id}Get accessible worker
Hide inaccessible worker identities.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
worker_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Worker"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}DELETE/api/v1/management/workers/{worker_id}Archive a worker
Soft-delete worker identity without deleting immutable Dockerfile history.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
worker_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}PATCH/api/v1/management/workers/{worker_id}/visibilityChange worker visibility
Atomically change worker visibility and selected team grants.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
worker_id | path | string | Yes |
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/VisibilityChange"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Worker"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/workers/{worker_id}/versionsPublish worker version
Register immutable Dockerfile URL, checksum and supported releases/versions.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
worker_id | path | string | Yes |
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerPublish"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerVersion"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/workers/{worker_id}/versionsGet worker version history
List immutable Dockerfile artifacts accessible to the user.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
worker_id | path | string | Yes |
limit | query | integer | No |
offset | query | integer | No |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerVersionPage"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/agentsCreate an owned logical Sinapsis agent
Actor comes from sinapsis-auth; never trust a client-supplied user_id.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentCreate"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Agent"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/agentsList saved agents owned by the authenticated user
Discover saved agents without requiring an agent ID.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
limit | query | integer | No |
offset | query | integer | No |
include_execution | query | boolean | No |
Responses
{
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Agent"
},
"title": "Response List Owned Agents Api V1 Management Agents Get"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/agents/{agent_id}Read agent as its authorized owner or team administrator
Sharing grants execution, not arbitrary access to stored private definitions.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
agent_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Agent"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/agents/{agent_id}/versionsPublish immutable Sinapsis graph version
Preserve template_name, class_name, template_input and default attributes.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
agent_id | path | string | Yes |
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentVersionPublish"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentVersion"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/agents/{agent_id}/versionsList immutable versions of an owned agent
Parameters
| Name | In | Type | Required |
|---|---|---|---|
agent_id | path | string | Yes |
limit | query | integer | No |
offset | query | integer | No |
Responses
{
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentVersion"
},
"title": "Response List Agent Versions Api V1 Management Agents Agent Id Versions Get"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/agent-presetsPublish immutable version-specific template attribute overrides
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentPresetCreate"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentPreset"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/agents/registerRegister a reusable agent with its first immutable version
Save/version is separate from immediate inline execution. Schedules subsequently reference the returned agent_version_id. A failed version publication compensates with a soft delete of the newly created logical agent, rather than leaving an active empty registration.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentRegister"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentRegistration"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/agents/{agent_id}/versions/{version_id}Read an owned immutable agent version
Parameters
| Name | In | Type | Required |
|---|---|---|---|
agent_id | path | string | Yes |
version_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentVersion"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/agent-sharesGrant limited execution access to a version/preset
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShareCreate"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentShareResult"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/agent-shares/{share_id}/revokeIrrevocably revoke an agent share
Current share owner/administrator only; blocked before new job admission.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
share_id | path | string | Yes |
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/RevokeShareRequest"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/governance/budgetsCreate or lower versioned resource budget
Only authorized budget owners/administrators; no self-escalation.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/BudgetPolicyChange"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/BudgetIdResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}PUT/api/v1/management/governance/team-member-capsSet team-member or default resource cap
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamMemberLimitChange"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/BudgetIdResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/governance/billing-customers/{customer_id}/admins/{profile_id}Billing owner delegates billing management
Parameters
| Name | In | Type | Required |
|---|---|---|---|
customer_id | path | string | Yes |
profile_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/governance/usage/historyAudited historical daily resource cost
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageHistoryQuery"
}
}
}Responses
{
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/DailyCost"
},
"type": "array",
"title": "Response Usage Daily History Api V1 Management Governance Usage History Post"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}PUT/api/v1/management/governance/billing-policiesSet hard per-run billing cap; overages disabled
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillingSpendingLimitChange"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/BudgetIdResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}POST/api/v1/management/agent-schedulesSchedule an immutable saved agent version
Create a one-time, daily, weekly or interval schedule for an owned agent.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleCreate"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentSchedule"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/agent-schedulesList my saved-agent schedules
Return bounded schedules belonging to the authenticated user.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
limit | query | integer | No |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/SchedulePage"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/agent-schedules/{schedule_id}Get a saved-agent schedule
Return one authorized schedule or 404 without exposing its owner.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
schedule_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentSchedule"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}PATCH/api/v1/management/agent-schedules/{schedule_id}Rename, pause, or resume a schedule
Apply a validated partial update; job outcomes cannot be self-edited.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
schedule_id | path | string | Yes |
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/SchedulePatch"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentSchedule"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}DELETE/api/v1/management/agent-schedules/{schedule_id}Disable a schedule
Disable further dispatch while preserving past occurrence history.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
schedule_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/agent-schedules/{schedule_id}/runsList scheduled dispatch occurrences
List job identifiers and dispatch outcomes for an owned schedule.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
schedule_id | path | string | Yes |
limit | query | integer | No |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleRunPage"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/agent-results/{job_id}/archiveRetrieve archived MessagePack result frames
Results are base64 encoded for JSON; decode to obtain the original opaque MessagePack bytes.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
job_id | path | string | Yes |
limit | query | integer | No |
recent | query | boolean | No |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArchivedResultPage"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/jobs/{job_id}/metricsGet reconciled metrics for one authorized job
Return aggregated agent, template and GPU observations. GPU sampling estimates are not billed usage.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
job_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobMetricsResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/metrics/meList metrics for my requested or personally owned jobs
List requested and user-owned scheduled jobs using the restricted RPC.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
limit | query | integer | No |
offset | query | integer | No |
Responses
{
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobMetricsResponse"
},
"title": "Response My Metrics Api V1 Management Metrics Me Get"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/management/agents/{agent_id}/metricsList distributed metrics for an agent I administer
Include scheduled/system jobs subject to existing agent-owner authorization.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
agent_id | path | string | Yes |
limit | query | integer | No |
offset | query | integer | No |
Responses
{
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobMetricsResponse"
},
"title": "Response Agent Metrics Api V1 Management Agents Agent Id Metrics Get"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}Webhook Integrations
POST/api/v1/webhook_integrations/registerRegister Webhook
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookRegistration"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookIntegration"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/webhook_integrations/listList Webhooks
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookPage"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}GET/api/v1/webhook_integrations/{webhook_id}Get Webhook
Parameters
| Name | In | Type | Required |
|---|---|---|---|
webhook_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookIntegration"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}PATCH/api/v1/webhook_integrations/{webhook_id}Activate Webhook
Parameters
| Name | In | Type | Required |
|---|---|---|---|
webhook_id | path | string | Yes |
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookActivation"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookIntegration"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}DELETE/api/v1/webhook_integrations/{webhook_id}Delete Webhook
Parameters
| Name | In | Type | Required |
|---|---|---|---|
webhook_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_management__api__errors__ErrorResponse"
}
}
}Agents
GET/api/v1/agentsList User Active Jobs
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentListResponse"
}
}
}POST/api/v1/agentsCreate Agent
Execute an inline YAML graph now. This never registers an agent version.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineAgentExecutionRequest"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentCreateResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}POST/api/v1/agents/{job_id}/cancelCancel Agent Execution
Parameters
| Name | In | Type | Required |
|---|---|---|---|
job_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentCancelResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}GET/api/v1/agents/{job_id}Get Job Status
Parameters
| Name | In | Type | Required |
|---|---|---|---|
job_id | path | string | Yes |
verbose | query | boolean | No |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentStatusResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}DELETE/api/v1/agents/{job_id}Delete Job Entry
Parameters
| Name | In | Type | Required |
|---|---|---|---|
job_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}GET/api/v1/agents/{job_id}/resultsGet Agent Results
Parameters
| Name | In | Type | Required |
|---|---|---|---|
job_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}GET/api/v1/agents/{job_id}/streamStream Output
Parameters
| Name | In | Type | Required |
|---|---|---|---|
job_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}Files
POST/api/v1/files/upload/{path}Upload File
Uploads a file to the user's private storage area. The path provided is relative to the user's root. The file content is read into memory and passed to the manager, which validates the quota before persisting it to the 'local' storage backend. Args: path: Destination path including filename. file: The uploaded file object. manager: The injected file manager instance. mime_type: the mime-type of the object being uploaded.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
path | path | string | Yes |
Request body
{
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_upload_file_api_v1_files_upload__path__post"
}
}
}Responses
{
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true,
"title": "Response Upload File Api V1 Files Upload Path Post"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}GET/api/v1/files/ls/{prefix}List Files
Lists files and directories for a given path prefix. Supports pagination via an opaque 'offset' cursor and a result 'limit'. It returns a page of file metadata along with the user's current storage usage and quota status. Args: prefix: The directory or path prefix to explore. offset: The pagination cursor from a previous request. limit: Maximum number of items to return (max 1000). manager: The injected file manager instance.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
prefix | path | string | Yes |
offset | query | schema | No |
limit | query | integer | No |
Responses
{
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true,
"title": "Response List Files Api V1 Files Ls Prefix Get"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}DELETE/api/v1/files/{path}Delete File
Deletes a specific file from the user's storage. Args: path: The relative path of the file to be removed. manager: The injected file manager instance. Returns: A dictionary indicating the amount of space freed, or a 404 if the file does not exist.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
path | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}POST/api/v1/files/create/{path}Create File
Creates a new directory (folder) at the specified path. Args: path: The relative directory path to create. manager: The injected file manager instance.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
path | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true,
"title": "Response Create File Api V1 Files Create Path Post"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}POST/api/v1/files/searchSearch File
Parameters
| Name | In | Type | Required |
|---|---|---|---|
file_name | query | string | Yes |
exact | query | boolean | Yes |
Responses
{
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true,
"title": "Response Search File Api V1 Files Search Post"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}GET/api/v1/files/get/{path}Fetch File From Disk
Securely resolves the physical disk path and serves it via FileResponse for immediate UI viewing/rendering.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
path | path | string | Yes |
Responses
{
"application/json": {
"schema": {}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}GET/api/v1/files/fetch/{agent_id}/{file_id}Get File From Results
This endpoint is meant to be used to fetch staging files produced by an agent.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
agent_id | path | string | Yes |
file_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}API Keys
POST/api/v1/api-keys/createGenerate Api Key
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiKeyCreate"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiKeyIssued"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}GET/api/v1/api-keys/listFetch Masked Keys
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiKeyPage"
}
}
}POST/api/v1/api-keys/deleteDelete Api Key
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/KeyRevokeRequest"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}GET/api/v1/api-keys/validateValidate Api Key
Validate current browser/JWT identity, not disclose key scopes.
Responses
{
"application/json": {
"schema": {
"additionalProperties": {
"type": "boolean"
},
"type": "object",
"title": "Response Validate Api Key Api V1 Api Keys Validate Get"
}
}
}User
GET/api/v1/user/tierGet User Tier
Responses
{
"application/json": {
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Response Get User Tier Api V1 User Tier Get"
}
}
}GET/api/v1/user/tabsGet Number Of Tabs
Responses
{
"application/json": {
"schema": {
"additionalProperties": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"type": "object",
"title": "Response Get Number Of Tabs Api V1 User Tabs Get"
}
}
}Dashboard
GET/api/v1/dashboard/get_metricsGet Metrics
Responses
{
"application/json": {
"schema": {
"additionalProperties": true,
"type": "object",
"title": "Response Get Metrics Api V1 Dashboard Get Metrics Get"
}
}
}User Secrets
POST/api/v1/user-secrets/createCreate a user secret.
Store a secret in Supabase Vault. The secret itself cannot be retrieved again through this API. Only its metadata is stored in the database.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSecretRequest"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSecretResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}DELETE/api/v1/user-secrets/{metadata_id}Delete a user secret.
Delete a stored secret and its associated metadata.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
metadata_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}GET/api/v1/user-secrets/{metadata_id}Get a user secret.
Return metadata for a single stored secret. The secret value itself is never returned.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
metadata_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSecretResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}GET/api/v1/user-secrets/listList user secrets.
List all secret metadata belonging to the authenticated user. The secret values themselves are never returned.
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSecretListResponse"
}
}
}Public Webhooks
POST/api/v1/public/webhooks/{webhook_id}Handle External Webhook
Parameters
| Name | In | Type | Required |
|---|---|---|---|
webhook_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}GET/api/v1/public/webhooks/{webhook_id}Handle External Webhook
Parameters
| Name | In | Type | Required |
|---|---|---|---|
webhook_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}CLI telemetry
POST/api/v1/telemetry/eventsIngest Events
Accept validated events, idempotently persisted via Management RPC. Production requires edge WAF limits and explicitly enabling the endpoint. Without a connected registry repository no events are acknowledged.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/TelemetryBatch"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/TelemetryAcknowledgement"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}Private package index
POST/api/v1/packages/index/listList Index Files
Return only authorized, committed project names or file metadata.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexFilesQuery"
}
}
}Responses
{
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexProjectListResponse"
},
{
"$ref": "#/components/schemas/IndexFilesResponse"
}
],
"title": "Response List Index Files Api V1 Packages Index List Post"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}POST/api/v1/packages/index/artifactAuthorize Artifact
Authorize a specific filename against one actor and registered release.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexArtifactQuery"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexArtifactDecision"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}Public package index
POST/api/v1/packages/index/public/listList Public Index
Return solely the anonymously downloadable committed artifacts.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicIndexFilesQuery"
}
}
}Responses
{
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexProjectListResponse"
},
{
"$ref": "#/components/schemas/IndexFilesResponse"
}
],
"title": "Response List Public Index Api V1 Packages Index Public List Post"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}POST/api/v1/packages/index/public/artifactPublic Artifact
Allow anonymous access only to approved PUBLIC catalog/artifact pairs.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicIndexArtifactQuery"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexArtifactDecision"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}Package publishing
POST/api/v1/packages/releases/preflightPreflight Release
Check publisher ownership and immutable release policy before uploading.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishRequest"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicationPlanResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}POST/api/v1/packages/releases/publishPublish Release
Register package/template/version metadata, never unaudited S3 objects.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishRequest"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicationResultResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}POST/api/v1/packages/releases/artifacts/commitCommit Release Artifacts
Commit only a fresh AWS-verified exact artifact set through Management.
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommitRequest"
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtifactCommitResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}Package analytics
GET/api/v1/packages/{distribution}/analyticsUser Package Analytics
Return permitted aggregate metrics and the caller's own observations.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
distribution | path | string | Yes |
days | query | integer | No |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackageDownloadSummary"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}Public package analytics
GET/api/v1/packages/public/{distribution}/analyticsPublic Package Analytics
Return only public-discoverable aggregate distribution statistics.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
distribution | path | string | Yes |
days | query | integer | No |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackageDownloadSummary"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}Internal package analytics
POST/api/v1/internal/package-analytics/deliveriesIngest Deliveries
Accept solely signed AWS observations; acknowledge the committed IDs.
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeliveryAcknowledgement"
}
}
}Documentation
GET/api/v1/documentation/releases/{release}/articlesList accessible documentation articles
Return only published articles permitted for the current verified principal.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
release | path | string | Yes |
limit | query | integer | No |
offset | query | integer | No |
section | query | schema | No |
q | query | schema | No |
lang | query | string | No |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedResponse_ArticleSummary_"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}GET/api/v1/documentation/releases/{release}/navigationGet permitted documentation navigation
Build section navigation from visible published articles only.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
release | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/NavigationResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}GET/api/v1/documentation/releases/{release}/articles/{slug}Get an authorized documentation article
Return canonical or translated Markdown after evaluating its access policy.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
release | path | string | Yes |
slug | path | string | Yes |
lang | query | string | No |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/Article"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}GET/api/v1/documentation/releases/{release}/templatesList accessible template references
Return permission-filtered templates from get_public_docs(user_id).
Parameters
| Name | In | Type | Required |
|---|---|---|---|
release | path | string | Yes |
limit | query | integer | No |
offset | query | integer | No |
q | query | schema | No |
category | query | schema | No |
package | query | schema | No |
tag | query | schema | No |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedResponse_TemplateSummary_"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}GET/api/v1/documentation/releases/{release}/templates/{template_id}Get an accessible template schema
Return detailed template attributes only when permitted by the template provider.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
release | path | string | Yes |
template_id | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateDocument"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}GET/api/v1/documentation/releases/{release}/packagesList packages with accessible templates
Aggregate visible templates by package without leaking private package inventory.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
release | path | string | Yes |
limit | query | integer | No |
offset | query | integer | No |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedResponse_PackageSummary_"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}GET/api/v1/documentation/releases/{release}/searchSearch accessible articles and templates
Search only content visible to the verified principal; private bodies are excluded.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
release | path | string | Yes |
limit | query | integer | No |
offset | query | integer | No |
q | query | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedResponse_SearchResult_"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}GET/api/v1/documentation/releases/{release}/rest-api/openapiGet the current REST API reference
Expose the live application's OpenAPI document for the latest docs release.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
release | path | string | Yes |
Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpenAPIResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}GET/api/v1/documentation/releases/{release}/media/{digest}Serve an authorized publication asset
Authorize asset owners before redirecting to a signed S3 URL or streaming local media.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
release | path | string | Yes |
digest | path | string | Yes |
Responses
{
"application/json": {
"schema": {}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}POST/api/v1/documentation/publications/syncPublish latest editorial documentation from the trusted Git branch
Authenticate a signed CI publication event and fetch the configured Git branch. The call completes after validating and atomically publishing the snapshot.
Parameters
| Name | In | Type | Required |
|---|---|---|---|
X-Sinapsis-Timestamp | header | schema | No |
X-Sinapsis-Event-Id | header | schema | No |
X-Sinapsis-Signature | header | schema | No |
Request body
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocsPublishRequest",
"description": "Optional Git commit for push events."
}
}
}Responses
{
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocsPublishResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}{
"application/json": {
"schema": {
"$ref": "#/components/schemas/sinapsis_docs_api__models__docs__ErrorResponse"
}
}
}