X-API-Key header unless noted otherwise. See
Authentication.
Quick Setup
1
Create a profile
POST /v1/profiles with a name. Start a setup session, sign in through it, then save it — full
request and response schemas: TinyProfiles
API.2
Run with the saved session
Pass
use_profile: true (and optionally profile_id) on an automation request to start the
run already signed in.Endpoints
List Profiles
GET /v1/profiles
List every TinyProfile on the account.
Create a Profile
POST /v1/profiles
Create a named profile.
Response (201):
Get Profile Details
GET /v1/profiles/{profileId}
Same response fields as create, plus:
Update a Profile
PATCH /v1/profiles/{profileId}
Returns the same shape as GET /v1/profiles/{profileId}.
Delete a Profile
DELETE /v1/profiles/{profileId}
Start a Setup Session
POST /v1/profiles/{profileId}/setup-session
Target URL the browser session will navigate to on startup. Bare domains (e.g.
tinyfish.ai) are automatically prefixed with https://.WebSocket URL for browser connection. Pass this to Playwright’s
connect_over_cdp or any CDP client.HTTPS base URL for the session. Use to access session endpoints such as
/pages — don’t pass this to Playwright.Cancel a Setup Session
POST /v1/profiles/{profileId}/setup-session/cancel
Save a Setup Session
POST /v1/profiles/{profileId}/save
Sites this save recorded as signed in. Present only when sign-in tracking is enabled for the account.
Upload Cookies and Storage
POST /v1/profiles/{profileId}/upload
Upload exported browser state directly, without opening a setup browser.
Delete a Domain
DELETE /v1/profiles/{profileId}/domains/{domain}
Delete one stored domain’s saved state from a profile, without deleting the profile itself.