Browser

Create a browser profile

Create a reusable browser profile (context) that saves logins, cookies and site storage between remote browser sessions. Pass the returned id as contextId when connecting to GET /wss; closing that session saves the profile.

post/contexts

Request

  • Base URL: https://request.usestring.ai/v1
  • URL: https://request.usestring.ai/v1/contexts
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Retry a create without making a second profile. Scoped to your organization for 24 hours. A retry while creation is in progress returns 409; a malformed or repeated header returns 400.

Request body

namestring

Optional label, 1-200 characters after trimming, unique among your live profiles. A duplicate returns 409.

Response

Profile created, or an idempotent create replayed.

idstring uuid required

Opaque UUID used to reconnect (/wss?contextId=), inspect, or delete.

namestring nullable required

Optional label.

status'EMPTY' | 'IN_USE' | 'UPLOADING' | 'READY' | 'FAILED' | 'DELETING' required

EMPTY: no saved data. IN_USE: a saving session is using the profile. UPLOADING: a save is finishing. READY: saved data is available. FAILED: a save failed; earlier saved data remains. DELETING: returned only by DELETE.

sizeBytesinteger nullable required

Compressed size of the saved profile. Null before the first successful save.

failureReasonstring nullable required

Most recent save failure, cleared by a successful save.

lastSavedAtstring date-time nullable required

Time of the last successful save.

lastUsedAtstring date-time nullable required

Last connection, saving or read-only. Reading status does not update it.

createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.