Documentation
Client Overview
Learn the shared v1 route surface used by the Python, TypeScript, and curl examples.
Datafuse keeps the public app contract simple: authenticate, list integrations, resolve tools, invoke a tool, and inspect audit logs. The same flow works from Python, TypeScript, or raw HTTP.
!IMPORTANT The integration routes below currently require a JWT bearer token (
DF_TOKEN) obtained from the app's authentication flow. They do not accept anx-api-key/DATAFUSE_API_KEY. API keys (df_live_...) are accepted only by the/api/v1/connected_accountsroutes; all other authenticated routes (including/api/v1/api-keysand/api/v1/audit/logs) require a JWT bearer token.
Shared Route Surface
| Route | Auth | Purpose |
|---|---|---|
GET /api/v1/integrations | JWT bearer | List the current user's integrations. |
POST /api/v1/integrations | JWT bearer | Create an integration (provider_key, credentials, auth_scheme). |
POST /api/v1/integrations/{id}/resolve-tools | JWT bearer | Discover the tool slugs available for an integration. |
POST /api/v1/integrations/{id}/invoke | JWT bearer | Execute a selected tool with a JSON tool_key + arguments payload. |
GET /api/v1/audit/logs | JWT bearer | Read the latest compliance audit events for your organization. |
Common Configuration
Both client examples and the curl guide use the same environment variables:
DATAFUSE_API_URL: The gateway host, defaulting tohttps://api.datafuse.xyz.DF_TOKEN: A user access token from the app's authentication flow.
Next Steps
- Build Python workflows with the Python client guide.
- Create Node or serverless workflows with the TypeScript client guide.
- Use the curl quickstart when you want to test the same flow without installing a client.