For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get API Key
GuidesAPI Reference
GuidesAPI Reference
  • Overview
    • API Reference
  • Endpoint Reference
    • Organizations
    • Projects
    • Documents
    • Agent
    • Check
  • API Explorer
      • GETGet a project by ID
      • DELDelete a project
      • PATCHUpdate a project
      • GETList Connect projects
      • POSTCreate a new Connect project
Get API Key
LogoLogo
API ExplorerProjects

Create a new Connect project

POST
/api/v2/projects
POST
/api/v2/projects
$curl -X POST https://api-staging.pyramid-ai.com/api/v2/projects \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "name": "Marina Bay Tower - Safety Docs",
> "description": "All safety and compliance documents for the Marina Bay Tower construction project"
>}'
1{
2 "request_id": "string",
3 "success": null,
4 "data": {
5 "id": "7f9c8d2a-1b3e-4c5d-8e9f-0a1b2c3d4e5f",
6 "org_id": "org_ais",
7 "name": "Q1 Surveys",
8 "description": "Batch of 2026 Q1 arboricultural assessments",
9 "document_count": 42,
10 "created_at": "2026-04-10T09:00:00Z",
11 "updated_at": "2026-04-14T12:00:00Z"
12 },
13 "pagination": {
14 "total": 127,
15 "offset": 0,
16 "limit": 50
17 }
18}

Creates an empty project ready to receive documents. Projects are the top-level container for organizing knowledge — one project per job site, tender, or topic.

Was this page helpful?
Previous
Built with

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Request

This endpoint expects an object.
namestringRequired1-200 characters
A descriptive name for the project.
descriptionstring or nullOptional<=500 characters
Optional context about what this project contains.

Response

Project created
request_idstringformat: "uuid"

Server-generated per-request UUID. Also sent as X-Request-Id response header. Include in support tickets.

successany
dataobject
paginationobject

Present only on list endpoints. Top-level (not nested inside data).

Errors

400
Bad Request Error
401
Unauthorized Error