Integration docs
Integration docs
The catalog of services the workspace can use and the reference for every operation: the same docs the agents read before they write a call.
Two routers, one scope. /v1/integrations walks the catalog service by service; /v1/operations searches across every service at once and resolves a bare operation id. Both are read-only and free.
AuthenticationRequires
docs:read on a platform API key. A CLI session always passes.The shape of the catalog
An integration is a service (slack, stripe, search-internet) with a credential type:
credentialType | Meaning |
|---|---|
oauth2 | Connect through OAuth. The vault refreshes the access token. |
apiKey | Connect by pasting a key or token. |
platform | A hosted General Input service. Nothing to connect; call it with platform:use. |
noAuth | A public API that needs no credential. |
An operation is one documented call on a service ("Send a Message" on slack). Its documentation is markdown holding the HTTP method and path, params, response shape, an example, and the env var names a credential of that service injects into geni exec bash and agent runs.
The discovery loop
- Search operations with a capability ("send slack message") to find the service and operation.
- Get the operation to read its reference.
- Find a credential for the service in the vault, then call the third-party API yourself with a token from issue a token.
| Endpoint | What it returns |
|---|---|
GET /v1/integrations | Every integration the workspace can use |
GET /v1/integrations/:service | One integration's setup metadata |
GET /v1/integrations/:service/operations | One service's operations |
GET /v1/integrations/:service/operations/:opId | One operation's full reference |
GET /v1/operations?q= | Cross-service operation search |
GET /v1/operations/:opId | One operation by bare id |