Function reference
Every operation function in @deployments-ai/sdk, with its endpoint and CLI command.
@deployments-ai/sdk exports one function per public API operation (470 in total), named after the operation ID. Each function links to its API reference page, which shows the request and response schemas and a complete SDK example.
Besides the operation functions, the package exports client, createClient, validatePlatformBaseUrl, createConfig, Client (type), contractMetadata.
Agent Email
Agents
Alerts
| Function | Endpoint | CLI |
|---|---|---|
archiveMonitor | DELETE /v1/monitors/{id} | deployments monitor archive |
createMonitor | POST /v1/monitors | deployments monitor create |
getAlertIncident | GET /v1/monitors/{id}/incidents/{incidentId} | deployments monitor incident |
getAlertNotificationPreferences | GET /v1/alert-notification-preferences | deployments monitor notification-settings |
getMonitor | GET /v1/monitors/{id} | deployments monitor show |
listAlertIncidents | GET /v1/alert-incidents | deployments monitor incidents |
listMonitors | GET /v1/monitors | deployments monitor list |
putAlertNotificationPreferences | PUT /v1/alert-notification-preferences | deployments monitor set-notification-settings |
testMonitor | POST /v1/monitors/{id}/test | deployments monitor test |
updateMonitor | PATCH /v1/monitors/{id} | deployments monitor update |
Apps
Artifacts
| Function | Endpoint | CLI |
|---|---|---|
completeArtifactUpload | POST /v1/artifacts/{artifactId}/complete | deployments artifact completedeployments chat |
createArtifactAccessUrl | POST /v1/artifacts/{artifactId}/access-urls | deployments artifact download |
createArtifactUpload | POST /v1/artifacts | deployments artifact uploaddeployments chat |
deleteArtifact | DELETE /v1/artifacts/{artifactId} | deployments artifact delete |
getArtifact | GET /v1/artifacts/{artifactId} | deployments artifact show |
listArtifacts | GET /v1/artifacts | deployments artifact list |
updateArtifactRetention | PATCH /v1/artifacts/{artifactId}/retention | deployments artifact retention |
Automations
Brains
Budgets
| Function | Endpoint | CLI |
|---|---|---|
archiveBudget | DELETE /v1/budgets/{id} | deployments budget archive |
createBudget | POST /v1/budgets | deployments budget create |
getBudget | GET /v1/budgets/{id} | deployments budget show |
listBudgetPeriods | GET /v1/budgets/{id}/periods | deployments budget periods |
listBudgets | GET /v1/budgets | deployments budget list |
updateBudget | PATCH /v1/budgets/{id} | deployments budget update |
| Function | Endpoint | CLI |
|---|---|---|
createEmailDomain | POST /v1/email/tenants/{tenantId}/domains | deployments email-domain create |
createEmailTenant | POST /v1/email/tenants | deployments email-tenant create |
getEmailDomain | GET /v1/email/domains/{domainId} | deployments email-domain get |
getEmailTenant | GET /v1/email/tenants/{tenantId} | deployments email-tenant get |
listEmailDomains | GET /v1/email/tenants/{tenantId}/domains | deployments email-domain list |
listEmailTenants | GET /v1/email/tenants | deployments email-tenant list |
refreshEmailDomain | POST /v1/email/domains/{domainId}/refresh | deployments email-domain refresh |
revokeEmailDomain | DELETE /v1/email/domains/{domainId} | deployments email-domain revoke |
sendEmail | POST /v1/email/tenants/{tenantId}/messages | deployments email send |
updateEmailTenant | PATCH /v1/email/tenants/{tenantId} | deployments email-tenant update |
Evaluations
Extensions
Governance
Managed Skills
Memory
Models
| Function | Endpoint | CLI |
|---|---|---|
archiveModelPolicy | DELETE /v1/model-policies/{id} | deployments model-policy archive |
createModelPolicy | POST /v1/model-policies | deployments model-policy create |
deleteModelCredential | DELETE /v1/organizations/{id}/model-credentials/{provider} | deployments model-credential remove |
getModelCredential | GET /v1/organizations/{id}/model-credentials/{provider} | deployments model-credential show |
getModelPolicy | GET /v1/model-policies/{id} | deployments model-policy show |
listModelCredentials | GET /v1/organizations/{id}/model-credentials | deployments model-credential list |
listModelPolicies | GET /v1/model-policies | deployments model-policy list |
listModels | GET /v1/models | deployments model list |
putModelCredential | PUT /v1/organizations/{id}/model-credentials/{provider} | deployments model-credential set |
updateModelPolicy | PATCH /v1/model-policies/{id} | deployments model-policy update |
Observability
| Function | Endpoint | CLI |
|---|---|---|
createObservabilityExport | POST /v1/observability/exports | deployments observability export |
getObservabilityMetrics | GET /v1/observability/metrics | deployments observability metrics |
getObservabilityRunTrace | GET /v1/observability/runs/{runId}/trace | deployments trace for-run |
getObservabilityToolMetrics | GET /v1/observability/tools | deployments observability tools |
getObservabilityTrace | GET /v1/observability/traces/{traceId} | deployments trace show |
listObservabilitySessionTraces | GET /v1/observability/sessions/{sessionId}/traces | deployments trace session |
listObservabilityTraces | GET /v1/observability/traces | deployments trace list |
listObservabilityTraceSpans | GET /v1/observability/traces/{traceId}/spans | deployments trace spans |
Operations
| Function | Endpoint | CLI |
|---|---|---|
getAuditEvent | GET /v1/audit-events/{id} | deployments audit show |
getCostSummary | GET /v1/costs/summary | deployments cost summary |
getUsageSummary | GET /v1/usage/summary | deployments usage summary |
listApiCredentialUsage | GET /v1/api-key-usage | deployments api-key usage |
listAuditEvents | GET /v1/audit-events | deployments audit list |
listCostRecords | GET /v1/costs | deployments cost show |
listOrganizationAuditEvents | GET /v1/organizations/{id}/audit-events | deployments audit organization-list |
listSpendRecords | GET /v1/spend | deployments spend show |
listUsageRecords | GET /v1/usage | deployments usage show |
Providers
Runtime
Security
System
Tenancy
Tools
| Function | Endpoint | CLI |
|---|---|---|
archiveToolPolicy | DELETE /v1/tool-policies/{id} | deployments tool-policy archive |
createToolPolicy | POST /v1/tool-policies | deployments tool-policy create |
evaluateToolPolicy | POST /v1/tool-policies/evaluate | deployments tool-policy evaluate |
getTool | GET /v1/tools/{toolName} | deployments tool get |
getToolPolicy | GET /v1/tool-policies/{id} | deployments tool-policy show |
listToolPolicies | GET /v1/tool-policies | deployments tool-policy list |
listTools | GET /v1/tools | deployments tool list |
updateToolPolicy | PATCH /v1/tool-policies/{id} | deployments tool-policy update |