You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/gateway/overview.md
+123Lines changed: 123 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,3 +36,126 @@ print(result.output)
36
36
The first known use of "hello, world" was in a 1974 textbook about the C programming language.
37
37
"""
38
38
```
39
+
# Quick Start
40
+
This section contains instructions on how to set up your account and run your app with Pydantic AI Gateway credentials.
41
+
42
+
## Create an account
43
+
Using your GitHub or Google account, sign in at https://gateway.pydantic.dev.
44
+
Choose a name for your organization (or accept the default). You will automatically be assigned the Admin role.
45
+
46
+
A default project will be created for you. You can choose to use it, or create a new one on the [Projects](https://gateway.pydantic.dev/admin/projects) page.
47
+
48
+
## Add **Providers** by bringing your own API keys (BYOK)
49
+
Pydantic AI Gateway allows you to bring your API keys from your favourite provider(s).
50
+
51
+
On the [Providers](https://gateway.pydantic.dev/admin/providers) page, fill in the form to add a provider. Paste your API key into the form under Credentials, and make sure to **select the Project that will be associated to this provider**. It is possible to add multiple keys from the same provider.
52
+
53
+
## Grant access to your team
54
+
On the [Users](https://gateway.pydantic.dev/admin/users) page, create an invitation and share the URL with your team to allow them to access the project.
55
+
56
+
## Create gateway project keys
57
+
On the Keys page, Admins can create project keys which are not affected by spending limits. Users can only create personal keys, that will inherit spending caps from both User and Project levels, whichever is more restrictive.
58
+
59
+
# Usage
60
+
After setting up your account with the instructions above, you will be able to make an AI model request with the Pydantic AI Gateway.
61
+
The code snippets below show how you can use PAIG with different frameworks and SDKs.
62
+
63
+
To use different models, change the model string `gateway/<api_type>:<model_name>` to other models offered by the supported providers.
64
+
65
+
Examples of providers and models that can be used are:
0 commit comments