User-Agent Parser
parse_user_agentRead-only custom user-agent parsing via POST /v3/user-agent. Paid only for POST payload parsing. Cost: 1 credit per successful string. Parses only the explicit uaString value; it cannot read caller headers or transport metadata.
Instructions
Read-only custom user-agent parsing via POST /v3/user-agent. Paid only for POST payload parsing. Cost: 1 credit per successful string. Parses only the explicit uaString value; it cannot read caller headers or transport metadata.
Returns { user_agent_string, name, type, version, version_major, device, engine, operating_system }. Type fields can identify desktop/mobile clients, robots, malformed or scripted strings, anonymized strings, or unknown values. uaString must be the exact non-empty user-agent string; empty/null strings are rejected locally before any API call. force_refresh bypasses cached data, makes a new upstream request, and can consume credits. bulk_parse_user_agent handles multiple strings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uaString | Yes | The user-agent string to parse (e.g. Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36). | |
| force_refresh | No | Default false. When true, bypasses cached user-agent parsing data; a successful refresh makes a new upstream request and can consume credits. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | Present on success: API result after field selection, redaction, and transport limits. | |
| page | No | ||
| error | No | Present on failure, with isError: true. |