API overview

Every APULODI developer API route lives under /v1 and authenticates with a Bearer API key.

Base URL

https://api.apulodi.com/v1

For local development, point the SDK at your running instance:

const apulodi = new Apulodi({
  apiKey: process.env.APULODI_API_KEY!,
  baseUrl: "http://localhost:3000",
});

Conventions

• Content type — request and response bodies are JSON (Content-Type: application/json).

• Success envelope — collection and object endpoints return their payload under a data key:

  json

  { "data": { "id": "file_…", "status": "uploaded" } }
  

• Pagination — list endpoints return data plus pagination:

  json

  {
    "data": [],
    "pagination": { "hasMore": false, "nextCursor": null }
  }
  

• Dates — all timestamps are ISO 8601 UTC strings.

• Status — file status is lowercase (pending, uploaded, failed, deleted).

• Idempotency — POST /v1/files/upload accepts an optional Idempotency-Key header; retrying with the same key returns the same file instead of creating a duplicate.

Error envelope

Errors always use this shape:

{
  "error": {
    "code": "FILE_NOT_FOUND",
    "message": "The file could not be found.",
    "details": { "issues": {} }
  }
}

details is optional and carries structured context (for example Zod field errors). The full code list is in Errors.

Endpoints