Build on INC Platform

API reference

Reference and tools for the local platform preview.

Base URL: this installation’s origin, for example http://localhost:3000. Send Authorization: Bearer <key>. Keys can access only their owner’s resources and selected service scopes.

Method	Endpoint	Purpose
`GET`	`/api/platform/resources`	List resources and recent activity
`POST`	`/api/platform/resources`	Create a resource
`GET`	`/api/platform/resources/:id`	Read a resource
`PATCH`	`/api/platform/resources/:id`	Apply an action
`DELETE`	`/api/platform/resources/:id`	Delete a resource
`GET / POST / DELETE`	`/api/platform/storage/:id`	List, upload, or delete objects
`POST`	`/api/platform/ai`	Generate with a saved assistant
`GET`	`/api/platform/status`	Point-in-time local health

Create a collection

curl http://localhost:3000/api/platform/resources \
  -H "Authorization: Bearer $INC_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"service":"data","kind":"Collection","name":"Customers","config":{"description":"Customer directory","region":"Local Docker"}}'

Add a JSON record

curl -X PATCH http://localhost:3000/api/platform/resources/RESOURCE_ID \
  -H "Authorization: Bearer $INC_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"action":"add-record","record":{"name":"Amina","city":"Mbeya"}}'

Actions and errors

Actions: rename (name), archive, restore, validate (Dev), capture (Connect), complete (Work), add-record (record object), delete-record (recordId). Storage uploads use multipart form data with a file field; downloads and deletes use the key query parameter. Errors return a JSON error string with 400, 401, 403, 404, 409, 413, or 503. Collections allow 1,000 records of up to 20 KB each; uploads allow 20 MB per file.