Skip to content

Commit c00d630

Browse files
Add explicit baseURL examples to ai docs
Co-authored-by: Eric Allam <eric@trigger.dev>
1 parent c970ff0 commit c00d630

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

docs/tasks/streams.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -659,6 +659,16 @@ the resulting value must not be empty. The value must also be a valid absolute U
659659
the `http` or `https` protocol, without query parameters, hash fragments, or embedded
660660
username/password credentials.
661661

662+
Examples:
663+
664+
-`https://api.trigger.dev`
665+
-`https://api.trigger.dev/custom-prefix`
666+
-` https://api.trigger.dev/custom-prefix/// ` (trimmed + normalized)
667+
-`https://api.trigger.dev?foo=bar`
668+
-`https://api.trigger.dev#fragment`
669+
-`https://user:pass@api.trigger.dev`
670+
-`ftp://api.trigger.dev`
671+
662672
For richer TypeScript ergonomics in app code, `@trigger.dev/ai` also exports:
663673

664674
- `TriggerChatHeadersInput`

packages/ai/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,16 @@ both cleanup steps (`set` inactive state and `delete`) even if one of them fails
166166
- `baseURL` must not include query parameters or hash fragments.
167167
- `baseURL` must not include username/password URL credentials.
168168

169+
Examples:
170+
171+
-`https://api.trigger.dev`
172+
-`https://api.trigger.dev/custom-prefix`
173+
-` https://api.trigger.dev/custom-prefix/// ` (trimmed + normalized)
174+
-`https://api.trigger.dev?foo=bar` (query string)
175+
-`https://api.trigger.dev#fragment` (hash fragment)
176+
-`https://user:pass@api.trigger.dev` (credentials)
177+
-`ftp://api.trigger.dev` (non-http protocol)
178+
169179
## `ai.tool(...)` example
170180

171181
```ts

0 commit comments

Comments
 (0)