diff --git a/docs/tasks/streams.mdx b/docs/tasks/streams.mdx index 375cacd2e..1f5128c04 100644 --- a/docs/tasks/streams.mdx +++ b/docs/tasks/streams.mdx @@ -659,6 +659,16 @@ the resulting value must not be empty. The value must also be a valid absolute U the `http` or `https` protocol, without query parameters, hash fragments, or embedded username/password credentials. +Examples: + +- ✅ `https://api.trigger.dev` +- ✅ `https://api.trigger.dev/custom-prefix` +- ✅ ` https://api.trigger.dev/custom-prefix/// ` (trimmed + normalized) +- ❌ `https://api.trigger.dev?foo=bar` +- ❌ `https://api.trigger.dev#fragment` +- ❌ `https://user:pass@api.trigger.dev` +- ❌ `ftp://api.trigger.dev` + For richer TypeScript ergonomics in app code, `@trigger.dev/ai` also exports: - `TriggerChatHeadersInput` diff --git a/packages/ai/README.md b/packages/ai/README.md index c83a66a0d..1cfe52c61 100644 --- a/packages/ai/README.md +++ b/packages/ai/README.md @@ -166,6 +166,16 @@ both cleanup steps (`set` inactive state and `delete`) even if one of them fails - `baseURL` must not include query parameters or hash fragments. - `baseURL` must not include username/password URL credentials. +Examples: + +- ✅ `https://api.trigger.dev` +- ✅ `https://api.trigger.dev/custom-prefix` +- ✅ ` https://api.trigger.dev/custom-prefix/// ` (trimmed + normalized) +- ❌ `https://api.trigger.dev?foo=bar` (query string) +- ❌ `https://api.trigger.dev#fragment` (hash fragment) +- ❌ `https://user:pass@api.trigger.dev` (credentials) +- ❌ `ftp://api.trigger.dev` (non-http protocol) + ## `ai.tool(...)` example ```ts