Project Endpoint

Fetches the project associated with the API key and its public collections.


Request

http
GET /dev/project
x-api-key: <your-api-key>

Base URL: https://whitepapper.antk.in/api


Response — 200 OK

typescript
interface ProjectEndpointResponse {
  project: ProjectDoc
  collections: CollectionDoc[]
}

interface ProjectDoc {
  projectId: string
  ownerId: string | null        // masked in Dev API
  name: string
  slug: string
  description: string
  contentGuidelines: string
  logoUrl: string | null
  isPublic: boolean
  pagesNumber: number
  createdAt: string              // ISO 8601
  updatedAt: string              // ISO 8601
}

interface CollectionDoc {
  collectionId: string
  projectId: string
  ownerId: string | null         // masked in Dev API
  name: string
  description: string
  slug: string
  isPublic: boolean
  pagesNumber: number
  createdAt: string              // ISO 8601
  updatedAt: string              // ISO 8601
}

Errors

StatusDetail
401Missing x-api-key header.
403API key is not linked to any project.
429Monthly Dev API limit reached.

Notes

  • ownerId is always null in Dev API responses for privacy.
  • Only papers and collections that pass public visibility checks are returned.
  • Responses are cached at the edge for 5 minutes with Cache-Control: public, max-age=300, s-maxage=300.

Related

Whitepapper logo

Whitepapper

Whitepapper is a API first content platform for developers who want to publish once, distribute everywhere, and manage website content.