Developers / SDKs

Configure authentication

Give your server process access to the workspace and channel where Dex should work. A task token does not grant approval rights, and the workspace policy decides what a task may do.

Install the package

Python uses the public deixic-sdk package; TypeScript uses @evalops/deixic-sdk. Install it from your registry before running the examples, then create the workspace credentials below.

Configure credentials

Create a Deixic tasks token in Settings → API access. Store it in your server-side secret manager. Supply these variables to the worker that runs the SDK:

  • DEIXIC_API_KEY — the task token.
  • DEIXIC_ORGANIZATION_ID — the token's organization.
  • DEIXIC_WORKSPACE_ID — the workspace for the task.
  • DEIXIC_BASE_URL — optional for the installed account-brief example; defaults to https://app.deixic.com. In application code, pass base_url in Python or baseUrl in TypeScript to select a different service URL.

The organization and workspace are fixed when you create the client. Keep API keys out of browser code. Browser applications should submit through an authenticated backend.

Check the workspace

Choose a channel ID from your workspace and configure an allowed model. Python exposes deixic.tasks.check_setup(channel_id="company"); TypeScript exposes await deixic.tasks.checkSetup({ channelId: "company" }).

The check reads channel access, workspace prerequisites, and model availability. An accessible result confirms read access. Write authorization is checked when you submit. Review the reported requirements and model readiness before starting.

For a task that uses a connected system, configure a connection and its permissions separately. The SDK creates no connection, grant, or model configuration.

Resolve setup and execution failures

  • Missing configuration: supply the required environment variables to your server process.
  • Access denied: verify the token, its organization, workspace, and requested channel.
  • Model unavailable: configure an allowed model in the workspace and rerun the setup check.
  • Connected data missing: check the connection and its read permissions.
  • Waiting for approval: review the requested action and record a decision as its assigned owner.
  • SDK error: retain the error's request ID for support. Keep token values out of logs.