Skip to main content
A server integration can use permitted public API operations to manage configuration and inspect stored resources. Runtime sessions and provider execution have their own release requirements.

​
Set up the boundary

1

Scope credentials

Create a key for the intended service and workspace. Follow API keys and the authentication reference.
2

Identify resources

Retain agent, branch, version, document, and connection identifiers. Resolve access independently of user-submitted display names.
3

Handle responses

Set timeouts, check status, and retain safe request-ID context. Distinguish rejected requests from uncertain mutation outcomes before retrying.
4

Read results back

Inspect the stored resource and exact version after changes. Do not infer success from a return URL or local editor state.
Use Python and TypeScript resource pages for checked read examples. The private dashboard session is not an alternative public SDK credential.

​
Operational review

Separate development, staging, and production credentials and resource identifiers. Define request limits, access logging, dependency failure behavior, and revocation. Keep secrets and unnecessary customer content out of logs.

​
Frequently asked questions

No. Use the public contract and the operation’s allowed credential type. Internal-web workflows are a separate boundary.