Base URL
All public API endpoints are served from:Authentication
Create a public API key from your Replo Settings, then send it as a bearer token:API version
Every request must include theReplo-Api-Version header. See API versioning for the current supported version and upgrade guidance.
Error handling
All errors return a consistent JSON envelope with acode, a message, and a doc_url linking to that code’s documentation:
Async operations and polling
Some operations, like agent sessions, run asynchronously. They return immediately with a resource ID, and you poll for status updates. Recommended polling pattern:- Call the create endpoint (e.g.,
POST /agent/sessions) - Receive 202 Accepted with a session ID
- Poll the status endpoint every 5-10 seconds (e.g.,
GET /agent/sessions/{id}) - If the response includes
pendingInteractions, the session is blocked waiting on you: resolve each one withPOST /agent/sessions/{id}/interactions/{interactionId}/resolve, then keep polling - Continue until status is
completedorfailed
apiVersion set to the current version from API versioning:
Idempotency
Some operations are idempotent: calling them multiple times with the same input produces the same result.
When retrying non-idempotent operations after a network failure, check whether the original request succeeded before retrying to avoid duplicates.