Requirements
- Target platform
- OpenClaw
- Install method
- Manual import
- Extraction
- Extract archive
- Prerequisites
- OpenClaw
- Primary doc
- SKILL.md
Authenticate AI agents with the DeepRead OCR API using OAuth device flow. The agent displays a code, the user approves it in their browser, and the agent rec...
Authenticate AI agents with the DeepRead OCR API using OAuth device flow. The agent displays a code, the user approves it in their browser, and the agent rec...
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete.
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run.
Authenticate AI agents with the DeepRead OCR API using the OAuth 2.0 Device Authorization Flow (RFC 8628). After setup, the agent has a DEEPREAD_API_KEY environment variable and can use the DeepRead OCR skill.
The device flow lets headless agents (no browser) authenticate securely: Agent requests device code β User opens URL in browser β User approves β Agent receives API key Agent calls POST https://api.deepread.tech/v1/agent/device/code to get a device_code and user_code Agent displays the user_code and a verification URL to the user User opens the URL in their browser, logs in, and enters the code Agent polls POST https://api.deepread.tech/v1/agent/device/token until the user approves Agent receives an api_key (prefixed sk_live_) and stores it as the DEEPREAD_API_KEY environment variable Only domain contacted: api.deepread.tech
A DeepRead account (free at https://www.deepread.tech/dashboard/?utm_source=clawdhub) Internet access to reach api.deepread.tech
curl -s -X POST https://api.deepread.tech/v1/agent/device/code \ -H "Content-Type: application/json" \ -d '{"agent_name": "my-ai-agent"}' The agent_name field is optional β it is shown on the approval screen so the user knows which agent is requesting access. Response: { "device_code": "GmRhmhcxhZAzk...EeNu5OfKhL79MQgN", "user_code": "WDJB-MJHT", "verification_uri": "https://www.deepread.tech/activate", "verification_uri_complete": "https://www.deepread.tech/activate?code=WDJB-MJHT", "expires_in": 900, "interval": 5 } Tell the user (using the values from the response β they change every time): Open {verification_uri} and enter code {user_code} Or open this direct link: {verification_uri_complete}
Poll every interval seconds (default: 5) until the user approves: curl -s -X POST https://api.deepread.tech/v1/agent/device/token \ -H "Content-Type: application/json" \ -d '{"device_code": "GmRhmhcxhZAzk...EeNu5OfKhL79MQgN"}' While waiting (user hasn't approved yet): { "error": "authorization_pending", "api_key": null, "key_prefix": null } After user approves: { "error": null, "api_key": "sk_live_abc123def456...", "key_prefix": "sk_live_abc123de" } The api_key is returned exactly once. The next poll after retrieval will return expired_token. Save it immediately. If user denied: { "error": "access_denied", "api_key": null, "key_prefix": null } If code expired (15 minutes): { "error": "expired_token", "api_key": null, "key_prefix": null }
Once you receive the api_key, set it for the current session: export DEEPREAD_API_KEY="<api_key from response>" To persist across sessions, the user should choose one of these options: MethodCommandSecuritySecrets manager (recommended)Use your OS keychain, 1Password CLI, or passEncrypted at restShell profileUser manually adds export DEEPREAD_API_KEY="..." to ~/.zshrcPlaintext file β readable by local processes Important: The agent should set the env var for the current session only (export) Persistence is the user's choice β do not automatically write to shell profiles Never commit the key to source control or write it to project files The key prefix sk_live_ confirms it is a valid DeepRead production key
Submit a test document to confirm the key is valid: curl -s -X POST https://api.deepread.tech/v1/process \ -H "X-API-Key: $DEEPREAD_API_KEY" \ -F "file=@test.pdf" A successful response returns a job ID confirming the key works: { "id": "550e8400-e29b-41d4-a716-446655440000", "status": "queued" } If the key is invalid you will get a 401 Unauthorized response.
#!/bin/bash # DeepRead Device Flow β complete example # 1. Request device code RESPONSE=$(curl -s -X POST https://api.deepread.tech/v1/agent/device/code \ -H "Content-Type: application/json" \ -d '{"agent_name": "my-ai-agent"}') DEVICE_CODE=$(echo "$RESPONSE" | jq -r '.device_code') USER_CODE=$(echo "$RESPONSE" | jq -r '.user_code') VERIFY_URI=$(echo "$RESPONSE" | jq -r '.verification_uri') VERIFY_URI_COMPLETE=$(echo "$RESPONSE" | jq -r '.verification_uri_complete') INTERVAL=$(echo "$RESPONSE" | jq -r '.interval') echo "Open $VERIFY_URI and enter code: $USER_CODE" echo "Or open directly: $VERIFY_URI_COMPLETE" # 2. Poll for token while true; do TOKEN_RESPONSE=$(curl -s -X POST https://api.deepread.tech/v1/agent/device/token \ -H "Content-Type: application/json" \ -d "{\"device_code\": \"$DEVICE_CODE\"}") ERROR=$(echo "$TOKEN_RESPONSE" | jq -r '.error // empty') if [ -z "$ERROR" ]; then export DEEPREAD_API_KEY=$(echo "$TOKEN_RESPONSE" | jq -r '.api_key') echo "Authenticated. DEEPREAD_API_KEY is set for this session." break elif [ "$ERROR" = "authorization_pending" ]; then sleep "$INTERVAL" elif [ "$ERROR" = "slow_down" ]; then INTERVAL=$((INTERVAL + 5)) sleep "$INTERVAL" else echo "Error: $ERROR" exit 1 fi done
EndpointMethodAuthPurposehttps://api.deepread.tech/v1/agent/device/codePOSTNoneRequest device code + user codehttps://api.deepread.tech/v1/agent/device/tokenPOSTNonePoll for API key after user approvalhttps://www.deepread.tech/activateβBrowserUser opens this URL to enter the code and approve No other endpoints are contacted by this skill.
The user hasn't approved yet. Keep polling. The code expires after 15 minutes (expires_in: 900).
The device code expired before the user approved, or the API key was already retrieved (one-time retrieval). Start over from Step 1.
You're polling too fast. Increase the polling interval by 5 seconds.
The user clicked Deny on the approval screen. Start over from Step 1 if the user wants to retry.
Ensure the shell session was not restarted. If persisting to ~/.zshrc, run source ~/.zshrc to reload.
The environment variable was not persisted. Re-run the device flow or manually set: export DEEPREAD_API_KEY="sk_live_your_key_here"
The device flow follows RFC 8628 The user_code is short-lived (15 minutes) and single-use The api_key is returned exactly once β subsequent polls return expired_token All communication is over HTTPS The agent sets DEEPREAD_API_KEY for the current session only β it does not write to disk For long-term storage, prefer a secrets manager (OS keychain, 1Password CLI, pass) over plaintext shell profiles Never commit the key to source control or write it to project files The agent never sees the user's password
Dashboard: https://www.deepread.tech/dashboard Issues: https://github.com/deepread-tech/deep-read-service/issues Email: hello@deepread.tech
Code helpers, APIs, CLIs, browser automation, testing, and developer operations.
Largest current source with strong distribution and engagement signals.