PingRepDocs

Getting Started

Quickstart

Make your first PingRep API call in under 60 seconds.

Your first API call in 60 seconds

This guide makes your first request to the PingRep API: asking an AI Representative a question. The ask endpoints are public, so you do not need an account or an API key.

Step 1: Ask an AI Representative

Send a question to a Rep with the synchronous ask endpoint. Set profileId to a profile ID (UUID) or a username slug.

The request takes a profileId and a question of up to 500 characters. The response is JSON:

  • answer is the Rep's reply.
  • suggested_questions are follow-up questions the visitor can ask next.
  • remaining_questions is a number when a per-visitor allowance applies, otherwise null.

Limits come back as a calm answer, not an error

If a per-visitor or per-profile limit is reached, the endpoint still returns 200. The answer explains this calmly, and a limited field says when to retry. Only profiles that are public and open to AI discovery can be asked. Any other profile returns 404.

Step 2: Get an API key for owner access (optional)

To use the owner-scoped endpoints under /api/v1/mcp, such as reading your own contacts or asking your own Rep, create an API key.

  1. Sign up or log in at app.pingrep.com
  2. In Settings, find API Keys and choose Create
  3. Copy the key. It is shown once.

Send it in the X-API-Key header:

Keep your key safe

Treat your API key like a password. Never expose it in client-side code, public repositories, or browser requests. These endpoints require a paid plan and respect the scopes you gave the key.

What to explore next