cloud ui docs + cookbooks (#4759)
Co-authored-by: Ritik Sahni <ritiksahni0203@gmail.com> Co-authored-by: Kunal Mishra <kunalm2345@gmail.com>
This commit is contained in:
Naman
57
docs/cloud/account-settings/api-keys.mdx
Normal file
57
docs/cloud/account-settings/api-keys.mdx
Normal file
@@ -0,0 +1,57 @@
|
||||
---
|
||||
title: API Key
|
||||
subtitle: Authenticate programmatic access to Skyvern
|
||||
slug: cloud/account-settings/api-keys
|
||||
---
|
||||
|
||||
Every API call to Skyvern requires an API key. The key identifies your organization and determines billing.
|
||||
|
||||
## Finding your API key
|
||||
|
||||
Open **Settings** in the sidebar. Your API key is shown in a masked field. Click the **eye icon** to reveal the full value, or the **copy icon** to copy it to your clipboard.
|
||||
|
||||
<img src="/images/cloud/settings-api-key.png" alt="API key display with reveal and copy buttons" />
|
||||
|
||||
<Warning>
|
||||
Treat your API key like a password. Anyone with this key can create runs, read results, and manage workflows on behalf of your organization.
|
||||
</Warning>
|
||||
|
||||
## Using your key
|
||||
|
||||
Every Skyvern API request requires the `x-api-key` header:
|
||||
|
||||
```bash
|
||||
curl -X POST "https://api.skyvern.com/v1/runs" \
|
||||
-H "x-api-key: YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{ "url": "https://example.com", "goal": "Extract the pricing table" }'
|
||||
```
|
||||
|
||||
With the Python SDK:
|
||||
|
||||
```python
|
||||
from skyvern import Skyvern
|
||||
|
||||
client = Skyvern(api_key="YOUR_API_KEY")
|
||||
```
|
||||
|
||||
<Tip>
|
||||
Store the key in an environment variable (`SKYVERN_API_KEY`) rather than hardcoding it. In production, use your platform's secrets management (AWS Secrets Manager, Vault, etc.).
|
||||
</Tip>
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="API Reference"
|
||||
icon="code"
|
||||
href="/api-reference"
|
||||
>
|
||||
Full endpoint documentation with interactive playground
|
||||
</Card>
|
||||
<Card
|
||||
title="Billing & Usage"
|
||||
icon="receipt"
|
||||
href="/cloud/account-settings/billing-usage"
|
||||
>
|
||||
Understand how runs are metered and billed
|
||||
</Card>
|
||||
</CardGroup>
|
||||
75
docs/cloud/account-settings/billing-usage.mdx
Normal file
75
docs/cloud/account-settings/billing-usage.mdx
Normal file
@@ -0,0 +1,75 @@
|
||||
---
|
||||
title: Billing & Usage
|
||||
subtitle: Understand what you're paying for and manage your plan
|
||||
slug: cloud/account-settings/billing-usage
|
||||
---
|
||||
|
||||
Skyvern bills per **credit** — each browser action the AI takes during a run consumes credits. You pay for real work, not for workflows created or credentials stored.
|
||||
|
||||
## Plans
|
||||
|
||||
Open **Billing** in the sidebar to see available plans and your current balance.
|
||||
|
||||
<img src="/images/cloud/settings-billing-overview.png" alt="Billing page showing plan options and current balance" />
|
||||
|
||||
| Plan | Price | Credits | Includes |
|
||||
|------|-------|---------|----------|
|
||||
| **Hobby** | $29/month | 30,000 credits/month | Email support, priority queue |
|
||||
| **Pro** | $149/month | 150,000 credits/month | Priority support, higher rate limits |
|
||||
|
||||
Click **Switch to Hobby** or **Switch to Pro** to change plans. Your remaining dollar balance is applied as a credit toward your first subscription payment.
|
||||
|
||||
<Note>
|
||||
Need custom volumes or a dedicated plan? Use the **Book a call** link at the bottom of the Billing page, or visit [View full pricing details](https://skyvern.com) for a complete comparison.
|
||||
</Note>
|
||||
|
||||
## How credits are consumed
|
||||
|
||||
A credit maps to one discrete browser action: clicking a button, typing into a field, selecting a dropdown, or extracting data from a page. Navigation counts too.
|
||||
|
||||
| Example | Approximate credits |
|
||||
|---------|---------------------|
|
||||
| Login flow (email, password, submit) | ~3 |
|
||||
| Form fill (10 fields + submit) | ~11 |
|
||||
| Multi-page extraction (5 pages) | ~15–25 |
|
||||
|
||||
Credits consumed by a run are visible on the [Run Details](/cloud/viewing-results/run-details) page — the **Actions** counter at the top of the Overview timeline shows exactly how many actions the AI took.
|
||||
|
||||
<Tip>
|
||||
Reduce credit usage by being specific in your prompts. "Find information about pricing" causes the AI to explore multiple pages. "Extract the monthly price from the pricing table on /pricing" gets there directly.
|
||||
</Tip>
|
||||
|
||||
## Your current balance
|
||||
|
||||
The **Your Current Balance** section shows your remaining dollar balance. Credits are deducted as runs execute in real time. If your balance reaches zero, new runs won't start until you add credits or switch to a subscription plan.
|
||||
|
||||
## FAQ
|
||||
|
||||
<Accordion title="How do credits work?">
|
||||
Each browser action the AI takes — clicking, typing, navigating, extracting — costs one credit. Credits are deducted in real time as runs execute. Your plan includes a monthly credit allowance that resets each billing cycle. Unused credits don't roll over.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Can I buy more credits?">
|
||||
Yes. If you exhaust your monthly allowance, you can purchase additional credits from the Billing page. You can also upgrade to a higher plan for a larger monthly allowance.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Can I cancel anytime?">
|
||||
Yes. Downgrade or cancel your subscription from the Billing page. The change takes effect at the end of your current billing cycle, and you keep access to your credits until then.
|
||||
</Accordion>
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="API Keys"
|
||||
icon="key"
|
||||
href="/cloud/account-settings/api-keys"
|
||||
>
|
||||
Manage API keys for programmatic access
|
||||
</Card>
|
||||
<Card
|
||||
title="Organization Settings"
|
||||
icon="building"
|
||||
href="/cloud/account-settings/organization-settings"
|
||||
>
|
||||
Manage your team and organization details
|
||||
</Card>
|
||||
</CardGroup>
|
||||
50
docs/cloud/account-settings/organization-settings.mdx
Normal file
50
docs/cloud/account-settings/organization-settings.mdx
Normal file
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Organization Settings
|
||||
subtitle: Manage your organization name and team access
|
||||
slug: cloud/account-settings/organization-settings
|
||||
---
|
||||
|
||||
Everything in Skyvern — workflows, credentials, runs, API keys — belongs to an **organization**. One is created automatically when you sign up.
|
||||
|
||||
## Organization details
|
||||
|
||||
Open **Settings** in the sidebar. The Settings page shows your organization name and current plan. The organization name appears throughout the UI and in API responses.
|
||||
|
||||
To rename your organization, update the **Organization Name** field and click **Save**.
|
||||
|
||||
## Team members
|
||||
|
||||
Plans that support multiple users (Pro and Enterprise) show a **Members** section below the organization details.
|
||||
|
||||
### Inviting members
|
||||
|
||||
Click **Invite Member**, enter their email address, and send the invitation. They'll receive an email with a link to join your organization. Once they accept, they appear in the members list with full access to workflows, runs, credentials, and API keys.
|
||||
|
||||
### Removing members
|
||||
|
||||
Click the **remove icon** next to a member's name to revoke their access. They lose access to all organization resources immediately.
|
||||
|
||||
<Warning>
|
||||
When removing a team member, also review your [API keys](/cloud/account-settings/api-keys) — they may have copied keys that remain active.
|
||||
</Warning>
|
||||
|
||||
<Note>
|
||||
Role-based access control (restricting what individual members can do) is available on **Enterprise** plans. On other plans, all members have full access to the organization's resources.
|
||||
</Note>
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Profile Settings"
|
||||
icon="user"
|
||||
href="/cloud/account-settings/profile-settings"
|
||||
>
|
||||
Manage your personal account settings
|
||||
</Card>
|
||||
<Card
|
||||
title="API Keys"
|
||||
icon="key"
|
||||
href="/cloud/account-settings/api-keys"
|
||||
>
|
||||
View and manage API keys for your organization
|
||||
</Card>
|
||||
</CardGroup>
|
||||
44
docs/cloud/account-settings/profile-settings.mdx
Normal file
44
docs/cloud/account-settings/profile-settings.mdx
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: Profile Settings
|
||||
subtitle: Manage your personal account and security
|
||||
slug: cloud/account-settings/profile-settings
|
||||
---
|
||||
|
||||
Click your avatar at the bottom of the sidebar to open the **Account** page. It has two tabs: **Profile** and **Security**.
|
||||
|
||||
## Profile
|
||||
|
||||
The **Profile** tab shows your display name and email address. Update your display name and click **Save** to apply.
|
||||
|
||||
## Security
|
||||
|
||||
The **Security** tab is where you manage your password and review active sessions.
|
||||
|
||||
<img src="/images/cloud/change-password.png" alt="Account Security tab showing password fields and active devices" />
|
||||
|
||||
Under **Set password**, enter your new password and confirm it. A green checkmark appears when the password meets requirements and both fields match. Check **Sign out of all other devices** if you want to invalidate existing sessions — recommended if you suspect unauthorized access.
|
||||
|
||||
Click **Save** to apply.
|
||||
|
||||
**Active devices** lists every device currently signed into your account, showing the browser, IP address, and last access time. Use this to verify that all sessions are yours.
|
||||
|
||||
<Note>
|
||||
If you signed up with Google or another SSO provider, password management is handled by the external provider and this section may not appear.
|
||||
</Note>
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Organization Settings"
|
||||
icon="building"
|
||||
href="/cloud/account-settings/organization-settings"
|
||||
>
|
||||
Manage your team and organization details
|
||||
</Card>
|
||||
<Card
|
||||
title="API Keys"
|
||||
icon="key"
|
||||
href="/cloud/account-settings/api-keys"
|
||||
>
|
||||
View and manage API keys
|
||||
</Card>
|
||||
</CardGroup>
|
||||
Reference in New Issue
Block a user