synthrank.Docs
WebsiteOpen SynthRank
Agents & API

Use the Agent REST API

Call the workspace workflow over HTTPS from your own scripts and tools.

Make an authenticated request

POST to the Agent API with a workspace-scoped key. Start with a read so you can verify access before requesting changes.

curl -X POST \n  "https://synthrank.com/functions/v1/agent-api" \n  -H "x-api-key: sr_YOUR_KEY" \n  -H "Content-Type: application/json" \n  -d '{"action":"get_workspace","tenant_id":"YOUR_WORKSPACE_UUID"}'

Follow the workflow

The integration exposes actions for crawling, profile confirmation, research, starting runs, inspecting progress and publishing. Poll the existing run to inspect progress rather than repeatedly starting work.

Respect quotas and errors

The workspace response includes quota usage, cap and remaining allowance. Requests beyond the monthly article allowance return HTTP 409. Function-chain rate limits return HTTP 429; wait for the supplied retry delay.

Check response status and error details before deciding whether to retry. A quota limit is not fixed by a short retry loop.

Need a hand with this?Contact support