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.md
+27-3Lines changed: 27 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,22 +54,31 @@ Choose a name for your organization (or accept the default). You will automatica
54
54
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.
55
55
56
56
### Add **Providers**
57
+
57
58
There are two ways to use Providers in the Pydantic AI Gateway: you can bring your own key (BYOK) or buy inference through the platform.
58
59
59
60
#### Bringing your own API key (BYOK)
60
61
61
-
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.
62
+
On the [Providers](https://gateway.pydantic.dev/admin/providers) page, fill in the form to add a provider.
63
+
Paste your API key into the form under Credentials, and make sure to **select the Project that will be associated to this provider**.
64
+
It is possible to add multiple keys from the same provider.
62
65
63
66
#### Use Built-in Providers
64
-
Go to the Billing page, add a payment method, and purchase $15 in credits to activate built-in providers. This gives you single-key access to all available models from OpenAI, Anthropic, Google Vertex, AWS Bedrock, and Groq.
67
+
68
+
Go to the [Billing page](https://gateway.pydantic.dev/admin/billing), add a payment method, and purchase $15 in credits to activate built-in providers.
69
+
This gives you single-key access to all available models from OpenAI, Anthropic, Google Vertex, AWS Bedrock, and Groq.
65
70
66
71
### Grant access to your team
72
+
67
73
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.
68
74
69
75
### Create Gateway project keys
70
-
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.
76
+
77
+
On the Keys page, Admins can create project keys which are not affected by spending limits.
78
+
Users can only create personal keys, that will inherit spending caps from both User and Project levels, whichever is more restrictive.
71
79
72
80
## Usage
81
+
73
82
After setting up your account with the instructions above, you will be able to make an AI model request with the Pydantic AI Gateway.
74
83
The code snippets below show how you can use PAIG with different frameworks and SDKs.
75
84
You can add `gateway/` as prefix on every known provider that
@@ -87,6 +96,7 @@ Examples of providers and models that can be used are:
The gateway needs to know the cost of the request in order to provide insights about the spend, and to enforce spending limits.
194
+
If it's unable to calculate the cost, it will return a 400 error with the message "Unable to calculate spend".
195
+
196
+
When [configuring a provider](https://gateway.pydantic.dev/admin/providers/new), you need to decide if you want the gateway to block
197
+
the API key if it's unable to calculate the cost. If you choose to block the API key, any further requests using that API key will fail.
198
+
199
+
We are actively working on supporting more providers, and models.
200
+
If you have a specific provider that you would like to see supported, please let us know on [Slack](https://logfire.pydantic.dev/docs/join-slack/) or [open an issue on `genai-prices`](https://github.com/pydantic/genai-prices/issues/new).
0 commit comments