# Send DeepRead Agent Self Sign Up to your agent
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
## Fast path
- Download the package from Yavira.
- Extract it into a folder your agent can access.
- Paste one of the prompts below and point your agent at the extracted folder.
## Suggested prompts
### New install

```text
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.
```
### Upgrade existing

```text
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.
```
## Machine-readable fields
```json
{
  "schemaVersion": "1.0",
  "item": {
    "slug": "deepread-agent-setup",
    "name": "DeepRead Agent Self Sign Up",
    "source": "tencent",
    "type": "skill",
    "category": "开发工具",
    "sourceUrl": "https://clawhub.ai/uday390/deepread-agent-setup",
    "canonicalUrl": "https://clawhub.ai/uday390/deepread-agent-setup",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadUrl": "/downloads/deepread-agent-setup",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=deepread-agent-setup",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "packageFormat": "ZIP package",
    "primaryDoc": "SKILL.md",
    "includedAssets": [
      "device_flow.sh",
      "package.json",
      "device_flow.py",
      "SKILL.md"
    ],
    "downloadMode": "redirect",
    "sourceHealth": {
      "source": "tencent",
      "slug": "deepread-agent-setup",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-05-02T10:36:36.140Z",
      "expiresAt": "2026-05-09T10:36:36.140Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=deepread-agent-setup",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=deepread-agent-setup",
        "contentDisposition": "attachment; filename=\"deepread-agent-setup-2.1.0.zip\"",
        "redirectLocation": null,
        "bodySnippet": null,
        "slug": "deepread-agent-setup"
      },
      "scope": "item",
      "summary": "Item download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this item.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/deepread-agent-setup"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    }
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/deepread-agent-setup",
    "downloadUrl": "https://openagent3.xyz/downloads/deepread-agent-setup",
    "agentUrl": "https://openagent3.xyz/skills/deepread-agent-setup/agent",
    "manifestUrl": "https://openagent3.xyz/skills/deepread-agent-setup/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/deepread-agent-setup/agent.md"
  }
}
```
## Documentation

### DeepRead Agent Setup

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.

### How It Works

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

### Prerequisites

A DeepRead account (free at https://www.deepread.tech/dashboard/?utm_source=clawdhub)
Internet access to reach api.deepread.tech

### Step 1: Request a Device Code

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}

### Step 2: Poll for Approval

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
}

### Step 3: Store the API Key

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

### Step 4: Verify the Key Works

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.

### Complete Flow (All Steps)

#!/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

### Endpoints Used

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.

### "authorization_pending" keeps repeating

The user hasn't approved yet. Keep polling. The code expires after 15 minutes (expires_in: 900).

### "expired_token"

The device code expired before the user approved, or the API key was already retrieved (one-time retrieval). Start over from Step 1.

### "slow_down"

You're polling too fast. Increase the polling interval by 5 seconds.

### "access_denied"

The user clicked Deny on the approval screen. Start over from Step 1 if the user wants to retry.

### Key doesn't work after export

Ensure the shell session was not restarted. If persisting to ~/.zshrc, run source ~/.zshrc to reload.

### "DEEPREAD_API_KEY not set"

The environment variable was not persisted. Re-run the device flow or manually set:

export DEEPREAD_API_KEY="sk_live_your_key_here"

### Security Notes

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

### Support

Dashboard: https://www.deepread.tech/dashboard
Issues: https://github.com/deepread-tech/deep-read-service/issues
Email: hello@deepread.tech
## Trust
- Source: tencent
- Verification: Indexed source record
- Publisher: uday390
- Version: 2.0.4
## Source health
- Status: healthy
- Item download looks usable.
- Yavira can redirect you to the upstream package for this item.
- Health scope: item
- Reason: direct_download_ok
- Checked at: 2026-05-02T10:36:36.140Z
- Expires at: 2026-05-09T10:36:36.140Z
- Recommended action: Download for OpenClaw
## Links
- [Detail page](https://openagent3.xyz/skills/deepread-agent-setup)
- [Send to Agent page](https://openagent3.xyz/skills/deepread-agent-setup/agent)
- [JSON manifest](https://openagent3.xyz/skills/deepread-agent-setup/agent.json)
- [Markdown brief](https://openagent3.xyz/skills/deepread-agent-setup/agent.md)
- [Download page](https://openagent3.xyz/downloads/deepread-agent-setup)