Skip to main content

​
Overview

Ping is the safest first call when wiring up an integration. It validates your API key, host allowlist, organisation ownership, and event ownership in one request, and returns a stable success body without touching any photo or search data. Use it from a smoke test, a deploy health check, or a “Test Connection” button in your integration UI.

​
Endpoint

GET /api/v1/ext/{org_id}/event/{event_id}/ping

​
Path Parameters

ParameterTypeRequiredDescription
org_idnumberYesYour organisation ID.
event_idnumberYesThe event you want to verify access to.

​
Example Request

curl -i \
  -H "X-API-Key: <your_9pic_api_key>" \
  "https://api.9pic.ai/api/v1/ext/903/event/456/ping"

​
Example Response

{
  "responseType": "success",
  "message": "pong",
  "data": {
    "status": "ok",
    "org_id": 903,
    "event_id": 456
  }
}

​
Response Models

Ping uses the standard envelope from Conventions. The endpoint payload inside data is:
FieldTypeDescription
data.statusstringAlways "ok" on a 200 response.
data.org_idnumberThe org_id from the URL, echoed back.
data.event_idnumberThe event_id from the URL, echoed back.

​
Error Responses

StatusMeaning
401API key is missing.
403API key is invalid/inactive, token/org/event ownership mismatch, or host not approved.
404Event configuration not found.
429Rate limit exceeded. Back off and retry.
500Internal failure.
See Errors for canonical descriptions and retry guidance.