Connect to the Revdoku API

Connect your own app, script, or agent to Revdoku over the REST API: get an API key, authenticate with a bearer token, and confirm the connection before you publish. For the complete endpoint reference, buckets, uploads, publishing, custom domains, and analytics, see the full Revdoku API documentation.

1. Create an account and get an API key

Revdoku connections start in the app. Create an account at app.revdoku.com/users/sign_up, then open the connection wizard:

https://app.revdoku.com/connect/agent

Clients can discover the supported auth methods at GET /api/v1/agent_auth/capabilities. Two common paths:

  • Local apps and agents: use OAuth device authorization. The token response includes a durable revdoku_... API key you can use for REST calls.
  • One-time prompt: in the Revdoku app, click New, then Copy Instructions for AI. The copied message includes a one-time grant token; exchange it for an API key:
curl -fsS "https://app.revdoku.com/api/v1/agent_auth/exchange_grant" \
  -H "Content-Type: application/json" \
  -d '{ "grant_token": "GRANT_TOKEN_FROM_REVDOKU", "label": "My integration" }'

Store the returned data.api_key (it starts with revdoku_) securely. Never print, log, or commit it.

2. Authenticate your requests

Point requests at the Revdoku base URL and send the API key as a bearer token:

export REVDOKU_URL=https://app.revdoku.com
export REVDOKU_API_KEY=revdoku_...
Authorization: Bearer $REVDOKU_API_KEY
Content-Type: application/json
Accept: application/json

3. Check the connection status

Confirm the key works and the connection is live with the status endpoint:

curl -fsS "$REVDOKU_URL/api/v1/status" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

A healthy connection returns your connection payload plus server_version and client_version; compare client_version against your installed connector to detect updates. Agents can call GET /api/v1/agent_auth/status, which returns the same connection payload. A missing or invalid key returns an authentication error with an error.code instead; re-run the connection wizard to issue a new key.

Verify the connection from ChatGPT

If you are connecting an AI agent, use ChatGPT with Revdoku as a quick live check: ask it to create files, publish a bucket, and summarize the resulting workflow before you build deeper API automation.

ChatGPT outlines a Revdoku publishing workflow for an AI-generated site

More details

This page covers connecting and verifying the connection. For every endpoint, creating buckets, uploading files, publish sessions, custom domains, analytics, error codes, and the hosted MCP for Claude and ChatGPT Cloud, see the complete Revdoku API reference.

Markdown version
↧
Loading PDF…