Outway documentation

Authentication

Protect Outway API credentials with project restrictions, scopes and usage limits.

API requests

Send Authorization: Bearer YOUR_TOKEN on authenticated API requests. The production API base is https://api.outway.dev.

The app uses a first-party sign-in session. Programmatic integrations use API keys created in the app’s API keys area. Some administrative endpoints, including subscription management, require an administrator’s signed-in session and do not accept API keys.

Limit access

For an AI or a single integration, create a project-bound key with only the scopes and requested-unit cap it needs. Capture submission needs captures:create; reading captures needs the corresponding read permission. Inspect your credential’s effective access with GET /v1/key-access.

A key’s lifetime usage cap is separate from the workspace’s monthly subscription allowance. Both may restrict a request. Project-bound keys cannot create recurring schedules.

Keep secrets private

Store tokens in environment variables or a secret manager. Never include them in public prompts, repositories, browser bundles or screenshots. Give an assistant the variable name and setup instructions, not an administrator login. Revoke keys that are no longer needed.

Handle authorization errors

A 401 requires valid authentication. A 403 can indicate a missing scope, project restriction or administrator requirement. Do not retry either indefinitely. See the API contract for endpoint-specific security.