Base URL
/v1. v1 changes only by addition; see Versioning.
Authentication
Send your key as a Bearer token on every request exceptGET /v1/health and GET /v1/openapi.json:
Endpoints
The operation ids are stable, so they are safe to use as method names in generated clients. The OpenAPI 3.1 document is at
https://api.pinakelai.com/v1/openapi.json.
Requests
- Query parameters are
snake_case. - Several values of one parameter are combined with OR: repeat the parameter (
status=registered&status=pending), or, for codes, enumerations and classes, separate them with commas (status=registered,pending). Different parameters are combined with AND. - Date ranges are
<field>_date_fromand<field>_date_to, inclusive, asYYYY-MM-DD. - Timestamps (the feed’s
since) are RFC 3339 withZor an offset. - Booleans are
trueorfalse; anything else is a 400. - Unknown parameters are rejected with 400, with a did-you-mean hint. They are never ignored.
- Request bodies (batch retrieve only) are
application/json, at most 64 KB.
Responses
Responses are JSON (application/json), UTF-8.
- A single resource is a top-level object with an
objectfield, such as"object": "trademark". - A list is an envelope:
- Every field is always present.
nullmeans the value is not stated; arrays are nevernull. - Dates are
YYYY-MM-DD; timestamps are UTC with microseconds andZ, such as2026-11-10T09:02:13.512000Z. - Errors are
application/problem+jsondocuments; see Errors.
Status codes
The API never returns 504.
Headers
Request headers
Response headers
CORS
Browsers may call the API only fromhttps://docs.pinakelai.com, for this site’s playground. Call the API from your servers. GET /v1/health allows any origin.