Skip to main content
Provision a new API project under your organization. The response is returned immediately with HTTP 202 Accepted while Plangrep completes the underlying infrastructure setup in the background. Do not create jobs against a project until its status is ready.

​
Authentication

Include your API key as Authorization: Bearer YOUR_API_KEY in the request headers.

​
Endpoint

POST https://plangrep.com/api/open/v1/projects

​
Request Body

​
name
string
required
A human-readable name for the project. Maximum 180 characters. Must be unique within your organization.

​
Example Request

curl --request POST \
  --url https://plangrep.com/api/open/v1/projects \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --data '{
    "name": "My Project"
  }'

​
Response Fields

The endpoint returns 202 Accepted with the following body.
​
project
Project
required
The newly created project object.
​
billing
object
required
Billing summary for the project provisioning operation.

​
Example Response

{
  "project": {
    "id": "proj_01hx9z4kqr8e7m3p5n6w2v0abc",
    "name": "My Project",
    "projectKind": "open_api",
    "status": "provisioning",
    "runtime": {
      "status": "starting",
      "upgradeStatus": "none"
    },
    "createdAt": "2024-11-01T14:22:10.000Z",
    "updatedAt": "2024-11-01T14:22:10.000Z"
  },
  "billing": {
    "availableCredits": 950,
    "creditsCharged": 50,
    "requiredCredits": 50
  }
}
Project creation takes 1–2 minutes. After receiving the 202 response, poll GET /api/open/v1/projects/{projectId} every 10 seconds until status equals "ready". If the project has not reached ready after 5 minutes, treat it as a provisioning failure and contact support. Only create jobs once the project status is ready.